diff --git a/api-doc/reference/Admin-API.v1.yaml b/api-doc/reference/Admin-API.v1.yaml index 2065345f5b46c6b7de2d57a20c74c7fba81bda20..5515fd1600b89c8b2f70a7a17c3221d64d144cb9 100644 --- a/api-doc/reference/Admin-API.v1.yaml +++ b/api-doc/reference/Admin-API.v1.yaml @@ -1,7 +1,8 @@ openapi: 3.0.0 info: - title: Admin API + title: Administration API version: '1.0' + description: "This API is used to provide admin functions which are broader than the user's API and allow modifying users which are not oneself." servers: - url: 'http://localhost:8080' paths: diff --git a/api-doc/reference/Install-API.v1.yaml b/api-doc/reference/Install-API.v1.yaml index 6427c94b8bfe999db84a8eb63bd80b06f7c47a4e..7c100691f49635615a0efd62a0d1e2d0e7d2589a 100644 --- a/api-doc/reference/Install-API.v1.yaml +++ b/api-doc/reference/Install-API.v1.yaml @@ -2,6 +2,7 @@ openapi: 3.0.0 info: title: Install API version: '1.0' + description: This API is used by the Web-UI installer in order to get JAMS up and running. servers: - url: 'http://localhost:3000' paths: diff --git a/api-doc/reference/Nameserver-API.v1.yaml b/api-doc/reference/Nameserver-API.v1.yaml index 1b754e9c81733283d84f3e540207c9f6c567c42c..7bb2e7bebf94ce491bf9aeb86f1e5cd1bce5b491 100644 --- a/api-doc/reference/Nameserver-API.v1.yaml +++ b/api-doc/reference/Nameserver-API.v1.yaml @@ -2,6 +2,7 @@ openapi: 3.0.0 info: title: Nameserver API version: '1.0' + description: This is the Jami-compatible implementation of the nameserver. servers: - url: 'http://localhost:8080' paths: @@ -13,7 +14,7 @@ paths: in: path required: true get: - summary: Your GET endpoint + summary: Address lookup tags: [] responses: {} operationId: get-api-nameserver-addr-addr @@ -25,7 +26,7 @@ paths: in: path required: true get: - summary: Your GET endpoint + summary: Name lookup tags: [] responses: {} operationId: get-api-nameserver-name-name diff --git a/api-doc/reference/Security-API.v1.yaml b/api-doc/reference/Security-API.v1.yaml index 9c0239ade852b977835c69d2ecf6c7c61951154c..05e04371a9b6cb270e7d0e9da2c43d8a9f947117 100644 --- a/api-doc/reference/Security-API.v1.yaml +++ b/api-doc/reference/Security-API.v1.yaml @@ -7,7 +7,7 @@ servers: paths: /api/auth/login: post: - summary: '' + summary: Login and Receive Auth Token operationId: post-api-auth-login responses: '200':