zydronium/internetee-registry
1
0
Fork 0
mirror of https://github.com/internetee/registry.git synced 2025-05-17 09:57:23 +02:00
Code Issues Projects Releases Packages Wiki Activity

Split up documentation

Browse source
This commit is contained in:
Martin Lensment 2015-01-14 18:05:31 +02:00
parent b65c55b0b8
commit c744537f9a
2 changed files with 49 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

51
doc/epp/README.md
View file

@ -2,52 +2,5 @@
## Introduction ## Introduction
Introduction text here Introduction text here
[domain.md](domain.md) [Session related functions](session.md)
[Domain related functions](domain.md)
## Basics
### Login request
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [login](#login) | true | | |
| clTRID | false | | Client transaction id |
##### login
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| clID | true | Username |
| pw | true | Password |
| [options](#options) | false | |
| [svcs](#svcs) | false | |
##### options
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| version | false | 1.0 |
| lang | false | en |
##### svcs
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| objURI | false | Object URI that is going to be used in current connection. (0-n) |
| [svcExtension](#svcextension) | false | |
##### svcExtension
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| extURI | false | Extension URI that is going to be used in current connection. (0-n) |
[EXAMPLE REQUEST AND RESPONSE](https://github.com/domify/registry/blob/master/doc/epp-doc.md#epp-session-when-connected-with-valid-user-logs-in-epp-user)
### Logout request
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| logout | true | | |
| clTRID | false | | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](https://github.com/domify/registry/blob/master/doc/epp-doc.md#epp-session-when-connected-with-valid-user-logs-out-epp-user)

47
doc/epp/session.md Normal file
View file

@ -0,0 +1,47 @@
## Session related functions
Here are functions like login, logout, hello, poll
### Login request
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| [login](#login) | true | | |
| clTRID | false | | Client transaction id |
##### login
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| clID | true | Username |
| pw | true | Password |
| [options](#options) | false | |
| [svcs](#svcs) | false | |
##### options
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| version | false | 1.0 |
| lang | false | en |
##### svcs
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| objURI | false | Object URI that is going to be used in current connection. (0-n) |
| [svcExtension](#svcextension) | false | |
##### svcExtension
| Field name | Required | Field description |
| ----------------- |----------|----------------- |
| extURI | false | Extension URI that is going to be used in current connection. (0-n) |
[EXAMPLE REQUEST AND RESPONSE](https://github.com/domify/registry/blob/master/doc/epp-doc.md#epp-session-when-connected-with-valid-user-logs-in-epp-user)
### Logout request
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| logout | true | | |
| clTRID | false | | Client transaction id |
[EXAMPLE REQUEST AND RESPONSE](https://github.com/domify/registry/blob/master/doc/epp-doc.md#epp-session-when-connected-with-valid-user-logs-out-epp-user)