Documentation test

This commit is contained in:
Martin Lensment 2015-01-14 11:22:41 +02:00
parent e2f96ef94f
commit 1be835cfd2
2 changed files with 50 additions and 14 deletions

View file

@ -43,7 +43,6 @@
= preserve do
%pre
= JSON.pretty_generate(JSON.parse(@repp_log.request_params))
/ = @repp_log.request_params
.col-md-6
.panel.panel-default
.panel-heading

View file

@ -1,19 +1,56 @@
# EPP integration specification for Estonian Internet Foundation
## Introduction
Introduction text here
## Domain related functions
| Field name | Required | Type | Field description |
| ----------------- |----------| -----|----------------- |
| domain:name | true | String | Domain name. Can contain unicode characters. |
| domain:period | false | Integer | Registration period for domain. Must add up to 1 / 2 / 3 years. |
### create command ###
| Field name | Required | Attributes | Attr. values |
| ----------------- |----------|------------|--------------|
| domain:name | true | | |
| domain:period | false | unit | "y", "m" |
| domain:ns | true | | |
|   domain:hostAttr | true | | |
|     domain:hostAddr | false | ip | "v4", "v6" |
|     domain:hostName | true | | |
### Domain create
##### domain:create
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| domain:name | true | | Domain name. Can contain unicode characters. |
| domain:period | false | unit (y, m, d) | Registration period for domain. Must add up to 1 / 2 / 3 years. |
| domain:ns | true | | Nameserver listing |
| domain:registrant | true | | Contact reference to the registrant |
| domain:contact | false | type (tech, admin) | Contact reference |
| domain:contact | false | type (tech, admin) | Contact reference |
##### domain:ns
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| domain:hostAttr | true | | | |
##### domain:hostAttr
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| domain:hostName | true | | Hostname of the nameserver |
| domain:hostAddr | true if nameserver is under domain zone | ip (v4, v6) | |
#### Extension
##### secDNS:create (not required)
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| secDNS:keyData | true | | DNSSEC key data |
##### secDNS:keyData (required)
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| secDNS:flags | true | | Allowed values: 0, 256, 257 |
| secDNS:protocol | true | | Allowed values: 3 |
| secDNS:alg | true | | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 |
| secDNS:pubKey | true | | Public key |
##### eis:extdata (required)
| Field name | Required | Attributes | Field description |
| ----------------- |----------| -----|----------------- |
| eis:legalDocument | true | type (pdf) | Base64 encoded document |