diff --git a/api-doc/reference/Admin-API.v1.yaml b/api-doc/reference/Admin-API.v1.yaml
index 5d4df4d67522a23fd146f9075c1e0593a9f0899e..1466df615b709a78beb34ea0ac3b58be704b8352 100644
--- a/api-doc/reference/Admin-API.v1.yaml
+++ b/api-doc/reference/Admin-API.v1.yaml
@@ -8,7 +8,7 @@ servers:
paths:
/api/admin/device:
get:
- summary: User device
+ summary: Get User device information
tags: []
responses:
'200':
@@ -32,7 +32,7 @@ paths:
name: deviceId
description: Returns the device detailed information.
put:
- summary: ''
+ summary: Update device data
operationId: put-api-admin-device
responses:
'200':
@@ -54,7 +54,7 @@ paths:
in: query
name: deviceName
delete:
- summary: ''
+ summary: Delete a device
operationId: delete-api-admin-device
responses:
'200':
@@ -74,10 +74,10 @@ paths:
type: string
in: query
name: deviceId
- description: Revokes a device.
+ description: Revoke/Delete a device.
/api/admin/devices:
get:
- summary: User devices
+ summary: "Get User's list of devices"
tags: []
responses:
'200':
@@ -97,14 +97,14 @@ paths:
description: Get a list of devices for a user.
/api/admin/directory/entry:
put:
- summary: ''
+ summary: Update user profile
operationId: put-api-admin-directory-entry
responses:
'200':
description: OK
description: "Update a user's profile."
post:
- summary: User profile
+ summary: Create User profile
operationId: post-api-admin-directory-entry
responses:
'200':
@@ -118,7 +118,7 @@ paths:
in: query
name: directory
delete:
- summary: ''
+ summary: Delete user profile
operationId: delete-api-admin-directory-entry
responses:
'200':
@@ -126,7 +126,7 @@ paths:
description: Method might probably never be implemented.
/api/admin/user:
get:
- summary: User profile - User
+ summary: Get User profile
tags: []
responses:
'200':
@@ -143,7 +143,7 @@ paths:
in: query
name: username
post:
- summary: ''
+ summary: Create internal user
operationId: post-api-admin-user
responses:
'200':
@@ -154,7 +154,7 @@ paths:
$ref: '#/components/schemas/User'
description: Create an internal user.
delete:
- summary: ''
+ summary: Delete a user
operationId: delete-api-admin-user
responses:
'200':
@@ -172,7 +172,7 @@ paths:
in: query
name: username
put:
- summary: ''
+ summary: Update user data
operationId: put-api-admin-user
responses:
'200':
@@ -191,7 +191,7 @@ paths:
name: password
/api/admin/users:
get:
- summary: Users Profile
+ summary: Get Users Profile list
tags: []
responses:
'200':
@@ -206,7 +206,7 @@ paths:
description: Return a list of users.
/api/subscription:
get:
- summary: Subscription status - License
+ summary: Get Subscription status
tags: []
responses:
'200':
@@ -223,7 +223,7 @@ paths:
operationId: get-api-subscription
description: Get the subscription status.
post:
- summary: ''
+ summary: Upload License
operationId: post-api-subscription
responses:
'200':
@@ -231,7 +231,7 @@ paths:
description: 'Upload the license here, which is basically just uploading a base64 representation of the keypair - and store on disk.'
/api/update:
get:
- summary: System Status
+ summary: Get System Status (current and available versions)
tags: []
responses:
'200':
@@ -243,7 +243,7 @@ paths:
operationId: get-api-update
description: Return the current version number and the available version number of Jams(for update).
post:
- summary: ''
+ summary: Update version
operationId: post-api-update
responses:
'200':
diff --git a/api-doc/reference/Install-API.v1.yaml b/api-doc/reference/Install-API.v1.yaml
index 0e3c6958d078a65c7456f63f8589cb2c69531580..4dffe75631638b5aa616e40b251255b867ad650a 100644
--- a/api-doc/reference/Install-API.v1.yaml
+++ b/api-doc/reference/Install-API.v1.yaml
@@ -8,7 +8,7 @@ servers:
paths:
/api/install/auth:
post:
- summary: ''
+ summary: Configure Authentication Source for Server
operationId: post-api-install-auth
responses:
'200':
@@ -21,7 +21,7 @@ paths:
description: Internal Server Error
description: 'Configure Server to use selected Authentication Source as authentication backend, save settings in config.json file.'
get:
- summary: Authentication Source
+ summary: Get Authentication Source for server
operationId: get-api-install-auth
responses:
'200':
@@ -29,7 +29,7 @@ paths:
description: "Get server's Authentication Source."
/api/install/ca:
post:
- summary: ''
+ summary: Save Certificate Authority
operationId: post-api-install-ca
responses:
'200':
@@ -38,7 +38,7 @@ paths:
description: Internal Server Error
description: Save Certificate Authority.
get:
- summary: Certificate Request
+ summary: Get Certificate Authority
operationId: get-api-install-ca
responses:
'200':
@@ -46,7 +46,7 @@ paths:
description: Get Certificate Authority.
/api/install/settings:
post:
- summary: ''
+ summary: Finish Server installation
operationId: post-api-install-settings
responses:
'200':
@@ -55,7 +55,7 @@ paths:
description: Internal Server Error
description: Finish Server installation.
get:
- summary: ''
+ summary: Get Server Settings
operationId: get-api-install-settings
responses:
'200':
@@ -63,7 +63,7 @@ paths:
description: Get Server Settings.
/api/install/start:
post:
- summary: ''
+ summary: Authenticate user
operationId: post-api-install-start
responses:
'200':
@@ -76,7 +76,7 @@ paths:
description: Forbidden
description: Authenticate user.
get:
- summary: ''
+ summary: Check if user should login or sign-up
operationId: get-api-install-start
responses:
'200':
@@ -88,7 +88,7 @@ paths:
description: 'true'
description: Check if user should login or sign-up.
put:
- summary: ''
+ summary: Create administrative user account
operationId: put-api-install-start
responses:
'200':
diff --git a/api-doc/reference/Nameserver-API.v1.yaml b/api-doc/reference/Nameserver-API.v1.yaml
index ae9de47f4fb8fb0b9f784282974d308c669fc393..e2ff8733f3479c03d763150759a7b4cf6dd6389a 100644
--- a/api-doc/reference/Nameserver-API.v1.yaml
+++ b/api-doc/reference/Nameserver-API.v1.yaml
@@ -14,7 +14,7 @@ paths:
in: path
required: true
get:
- summary: Address lookup
+ summary: Get Username from Adress
tags: []
responses:
'200':
@@ -35,7 +35,7 @@ paths:
in: path
required: true
get:
- summary: Name lookup
+ summary: Get Address from username
tags: []
responses:
'200':
diff --git a/api-doc/reference/Security-API.v1.yaml b/api-doc/reference/Security-API.v1.yaml
index 0b8d608963b591e75322988f87a5afa3d105081b..b037d04546373eacffdc91026e3276cb95163fd8 100644
--- a/api-doc/reference/Security-API.v1.yaml
+++ b/api-doc/reference/Security-API.v1.yaml
@@ -32,37 +32,16 @@ paths:
type: string
in: header
name: authorization
- /api/auth/contacts:
- get:
- summary: User contacts
- tags: []
- responses: {}
- operationId: get-api-auth-contacts
- description: "Get User's contacts"
- put:
- summary: ''
- operationId: put-api-auth-contacts
- responses:
- '200':
- description: OK
- description: "Update User's contact."
- delete:
- summary: ''
- operationId: delete-api-auth-contacts
- responses:
- '200':
- description: OK
- description: "Delete user's contact."
/api/auth/ocsp:
get:
- summary: OCSP
+ summary: Get OCSP
tags: []
responses: {}
operationId: get-api-auth-ocsp
description: Get OCSP.
/api/auth/crl:
get:
- summary: CRL
+ summary: Get CRL
tags: []
responses:
'200':
diff --git a/api-doc/reference/User-API.v1.yaml b/api-doc/reference/User-API.v1.yaml
index fa5e3f9e44a2b2786629907657ce9c2036052190..69b7aea135bcea02ed78dcc2f5bd4727d4fe0277 100644
--- a/api-doc/reference/User-API.v1.yaml
+++ b/api-doc/reference/User-API.v1.yaml
@@ -7,20 +7,20 @@ servers:
paths:
/api/auth/contacts:
get:
- summary: Contacts endpoint
+ summary: "Get User's list of contacts"
tags: []
responses: {}
operationId: get-api-auth-contacts
description: "Get User's contacts."
put:
- summary: ''
+ summary: "Update a User's contact"
operationId: put-api-auth-contacts
responses:
'200':
description: OK
description: "Update User's contact."
delete:
- summary: ''
+ summary: "Delete a user's contact"
operationId: delete-api-auth-contacts
responses:
'200':
@@ -34,7 +34,7 @@ paths:
in: path
required: true
get:
- summary: Device operations
+ summary: Get user specified device
tags: []
responses:
'200':
@@ -46,7 +46,7 @@ paths:
operationId: get-api-auth-device-deviceId
description: "Get a user's specified device."
put:
- summary: ''
+ summary: "Update user's device informations"
operationId: put-api-auth-device-deviceId
responses:
'200':
@@ -60,7 +60,7 @@ paths:
in: query
name: deviceName
post:
- summary: ''
+ summary: "Create/Store a user's device"
operationId: post-api-auth-device-deviceId
responses:
'200':
@@ -73,7 +73,7 @@ paths:
description: Internal Server Error
description: Create/Store a device for a user.
delete:
- summary: ''
+ summary: "Delete user's device"
operationId: delete-api-auth-device-deviceId
responses:
'200':
@@ -159,7 +159,7 @@ paths:
description: Search user profiles in directory.
/api/auth/user:
get:
- summary: User endpoint
+ summary: Read user profile
tags: []
responses:
'200':
@@ -167,7 +167,7 @@ paths:
operationId: get-api-auth-user
description: "Read user's profile (User can \"read\" his own profile)."
put:
- summary: ''
+ summary: Update some user profiles fields if LOCAL authentication source
operationId: put-api-auth-user
responses:
'200':