From c744537f9a7e97c11efcfbcd43f43e5672b32574 Mon Sep 17 00:00:00 2001 From: Martin Lensment Date: Wed, 14 Jan 2015 18:05:31 +0200 Subject: [PATCH] Split up documentation --- doc/epp/README.md | 51 ++-------------------------------------------- doc/epp/session.md | 47 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 49 deletions(-) create mode 100644 doc/epp/session.md diff --git a/doc/epp/README.md b/doc/epp/README.md index f54e19990..2c7375d83 100644 --- a/doc/epp/README.md +++ b/doc/epp/README.md @@ -2,52 +2,5 @@ ## Introduction Introduction text here -[domain.md](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) - +[Session related functions](session.md) +[Domain related functions](domain.md) diff --git a/doc/epp/session.md b/doc/epp/session.md new file mode 100644 index 000000000..0c9ac8bb3 --- /dev/null +++ b/doc/epp/session.md @@ -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) +