zydronium/internetee-registry
1
0
Fork 0
mirror of https://github.com/internetee/registry.git synced 2025-06-06 20:55:44 +02:00
Code Issues Projects Releases Packages Wiki Activity

It seems like I made a mistake with the API URL prefix in docs

Browse source 
This should be fixed now. I decided on fixing the documentation
instead of the actual implementation, as it has no testing footprint
This commit is contained in:
Maciej Szlosarczyk 2018-08-14 09:02:25 +03:00
parent 43a70863cf
commit 2f776f51ac
No known key found for this signature in database
GPG key ID: 41D62D42D3B0D765
4 changed files with 20 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/registrant-api/v1/authentication.md
View file

@ -7,7 +7,7 @@ authentication. API client should perform authentication with eID according to
the approriate documentation, and then pass on values from the webserver's the approriate documentation, and then pass on values from the webserver's
certificate to the API server. certificate to the API server.
## POST /repp/v1/registrant/auth/eid ## POST /api/v1/registrant/auth/eid
Returns a bearer token to be used for further API requests. Tokens are valid for 2 hours since their creation. Returns a bearer token to be used for further API requests. Tokens are valid for 2 hours since their creation.
@ -24,7 +24,7 @@ Values in brackets represent values that come from the id card certificate.
#### Request #### Request
``` ```
POST /repp/v1/auth/token HTTP/1.1 POST /api/v1/auth/token HTTP/1.1
Accept: application/json Accept: application/json
Content-type: application/json Content-type: application/json
@ -48,7 +48,7 @@ Content-Type: application.json
} }
``` ```
## POST /repp/v1/auth/username -- NOT IMPLEMENTED ## POST /api/v1/auth/username -- NOT IMPLEMENTED
#### Paramaters #### Paramaters
@ -62,7 +62,7 @@ Values in brackets represent values that come from the id card certificate
#### Request #### Request
``` ```
POST /repp/v1/auth/token HTTP/1.1 POST /api/v1/auth/token HTTP/1.1
Accept: application/json Accept: application/json
Content-type: application/json Content-type: application/json
``` ```

12
doc/registrant-api/v1/contact.md
View file

@ -1,4 +1,4 @@
## GET /repp/v1/registrant/contacts ## GET /api/v1/registrant/contacts
Returns contacts of the current registrar. Returns contacts of the current registrar.
@ -11,7 +11,7 @@ Returns contacts of the current registrar.
#### Request #### Request
``` ```
GET /repp/v1/registrant/contacts?limit=1 HTTP/1.1 GET /api/v1/registrant/contacts?limit=1 HTTP/1.1
Accept: application/json Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json Content-Type: application/json
@ -59,13 +59,13 @@ Content-Type: application/json
} }
``` ```
## GET /repp/v1/registrant/contacts/$UUID ## GET /api/v1/registrant/contacts/$UUID
Returns contacts of the current registrar. Returns contacts of the current registrar.
#### Request #### Request
``` ```
GET /repp/v1/registrant/contacts/84c62f3d-e56f-40fa-9ca4-dc0137778949 HTTP/1.1 GET /api/v1/registrant/contacts/84c62f3d-e56f-40fa-9ca4-dc0137778949 HTTP/1.1
Accept: application/json Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json Content-Type: application/json
@ -107,7 +107,7 @@ Content-Type: application/json
} }
``` ```
## PUT/PATCH /repp/v1/registrant/contacts/$UUID ## PATCH /api/v1/registrant/contacts/$UUID
Update contact details for a contact. Update contact details for a contact.
@ -127,7 +127,7 @@ Update contact details for a contact.
#### Request #### Request
``` ```
PUT /repp/v1/registrant/contacts/84c62f3d-e56f-40fa-9ca4-dc0137778949 HTTP/1.1 PATCH /api/v1/registrant/contacts/84c62f3d-e56f-40fa-9ca4-dc0137778949 HTTP/1.1
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Accept: application/json Accept: application/json
Content-type: application/json Content-type: application/json

12
doc/registrant-api/v1/domain.md
View file

@ -1,6 +1,6 @@
# Domain related actions # Domain related actions
## GET /repp/v1/registrant/domains ## GET /api/v1/registrant/domains
Returns domains of the current registrant. Returns domains of the current registrant.
@ -15,7 +15,7 @@ Returns domains of the current registrant.
#### Request #### Request
``` ```
GET repp/v1/registrant/domains?limit=1&details=true HTTP/1.1 GET api/v1/registrant/domains?limit=1&details=true HTTP/1.1
Accept: application/json Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json Content-Type: application/json
@ -70,14 +70,14 @@ Content-Type: application/json
} }
``` ```
## GET repp/v1/registrant/domains ## GET api/v1/registrant/domains
Returns domain names with offset. Returns domain names with offset.
#### Request #### Request
``` ```
GET repp/v1/registrant/domains?offset=1 HTTP/1.1 GET api/v1/registrant/domains?offset=1 HTTP/1.1
Accept: application/json Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json Content-Type: application/json
@ -96,14 +96,14 @@ Content-Type: application/json
} }
``` ```
## GET repp/v1/registrant/domains/$UUID ## GET api/v1/registrant/domains/$UUID
Returns a single domain object. Returns a single domain object.
#### Request #### Request
``` ```
GET repp/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535 HTTP/1.1 GET api/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535 HTTP/1.1
Accept: application/json Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json Content-Type: application/json

8
doc/registrant-api/v1/domain_lock.md
View file

@ -1,12 +1,12 @@
# Domain locks # Domain locks
## POST repp/v1/registrant/domains/$UUID/registry_lock ## POST api/v1/registrant/domains/$UUID/registry_lock
Set a registry lock on a domain. Set a registry lock on a domain.
#### Request #### Request
``` ```
POST repp/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535/registry_lock HTTP/1.1 POST api/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535/registry_lock HTTP/1.1
Accept: application/json Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json Content-Type: application/json
@ -82,13 +82,13 @@ Content-Type: application/json
``` ```
## DELETE repp/v1/registrant/domains/$UUID/registry_lock ## DELETE api/v1/registrant/domains/$UUID/registry_lock
Remove a registry lock. Remove a registry lock.
#### Request #### Request
``` ```
DELETE repp/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535/registry_lock HTTP/1.1 DELETE api/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535/registry_lock HTTP/1.1
Accept: application/json Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ== Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json Content-Type: application/json