Update API documentation for registry locks

This commit is contained in:
Maciej Szlosarczyk 2018-08-24 13:48:20 +03:00
parent 58fec27f72
commit fc2a4eaa9b
No known key found for this signature in database
GPG key ID: 41D62D42D3B0D765
2 changed files with 30 additions and 6 deletions

View file

@ -7,5 +7,5 @@ Main communication specification through Registrant API:
[Authentication](registrant-api/v1/authentication.md)
[Domains](registrant-api/v1/domain.md)
[Domain Lock](registrant-api/v1/domain_lock.md)
[Registry Lock](registrant-api/v1/registry_lock.md)
[Contacts](registrant-api/v1/contact.md)

View file

@ -1,4 +1,4 @@
# Domain locks
# Registry lock
## POST api/v1/registrant/domains/$UUID/registry_lock
@ -59,12 +59,12 @@ Content-Type: application/json
#### Response for failure
```
HTTP/1.1 400
HTTP/1.1 422
Content-Type: application/json
{
"errors": [
{ "base": "domain cannot be locked" }
{ "base": "Domain cannot be locked" }
]
}
@ -76,11 +76,23 @@ Content-Type: application/json
{
"errors": [
{ "base": "domain does not exist" }
{ "base": "Domain not found" }
]
}
```
```
HTTP/1.1 401
Content-Type: application/json
{
"errors": [
{ "base": ["Only administrative contacts can manage registry locks"] }
]
}
```
## DELETE api/v1/registrant/domains/$UUID/registry_lock
@ -156,7 +168,19 @@ Content-Type: application/json
{
"errors": [
{ "base": "domain does not exist" }
{ "base": "Domain not found" }
]
}
```
```
HTTP/1.1 401
Content-Type: application/json
{
"errors": [
{ "base": ["Only administrative contacts can manage registry locks"] }
]
}