diff --git a/api-doc/reference/Admin-API.v1.yaml b/api-doc/reference/Admin-API.v1.yaml
index 1466df615b709a78beb34ea0ac3b58be704b8352..f57e9c247f68889e983ba4364dd4d1b11110c65a 100644
--- a/api-doc/reference/Admin-API.v1.yaml
+++ b/api-doc/reference/Admin-API.v1.yaml
@@ -17,10 +17,13 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Device'
- examples: {}
+ examples:
+ example-1:
+ value:
+ deviceId: sfl123
+ displayName: ThinkpadL30
+ certificate: sjhgfdszwythudsiuyfdvsxkiwjhyed
operationId: get-api-admin-device
- requestBody:
- description: ''
parameters:
- schema:
type: string
@@ -88,6 +91,15 @@ paths:
type: array
items:
$ref: '#/components/schemas/Device'
+ examples:
+ example-1:
+ value:
+ - deviceId: sfl123
+ displayName: ThinkpadL30
+ certificate: sjhgfdszwythudsiuyfdvsxkiwjhyed
+ - deviceId: sfl1234
+ displayName: ThinkpadL304
+ certificate: sjhgfdszwyth4udsiuyfdvsxkiwjhyed
operationId: get-api-admin-devices
parameters:
- schema:
@@ -135,6 +147,19 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
+ examples:
+ example-1:
+ value:
+ username: lily
+ firstName: Lilye
+ lastName: Aldrin
+ phoneNumber: '5149876554'
+ phoneNumberExtension: '123'
+ mobileNumber: '4381230987'
+ faxNumber: '1239876543'
+ profilePicture: eowiiewjdkfjrekjdvreqljdlfrlqdmf
+ email: askiur@sfl.com
+ organization: SFL
operationId: get-api-admin-user
description: "Get the user's profile."
parameters:
@@ -152,6 +177,18 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/User'
+ examples:
+ example-1:
+ value:
+ username: lily
+ password: abcs123
+ userType: LOCAL
+ realm: ''
+ accessLevel: USER
+ needsPasswordReset: 'false'
+ ethAddress: ''
+ ethKey: ''
+ jamiId: ''
description: Create an internal user.
delete:
summary: Delete a user
@@ -163,6 +200,12 @@ paths:
application/json:
schema:
$ref: './User-API.v1.yaml#/components/schemas/DeviceRevocationResponse'
+ examples:
+ example-1:
+ value:
+ success: 'true'
+ errorDetails: ''
+ timestamp: '2020-06-01T12:30:01'
'500':
description: Internal Server Error
description: Revoke a user.
@@ -202,6 +245,29 @@ paths:
type: array
items:
$ref: '#/components/schemas/UserProfile'
+ examples:
+ example-1:
+ value:
+ - username: lily
+ firstName: Lilye
+ lastName: Aldrin
+ phoneNumber: '5149876554'
+ phoneNumberExtension: '123'
+ mobileNumber: '4381230987'
+ faxNumber: '1239876543'
+ profilePicture: eowiiewjdkfjrekjdvreqljdlfrlqdmf
+ email: askiur@sfl.com
+ organization: SFL
+ - username: ErikMar
+ firstName: Marshall
+ lastName: Eriksen
+ phoneNumber: '5149876554'
+ phoneNumberExtension: '123'
+ mobileNumber: '4381230987'
+ faxNumber: '1239876543'
+ profilePicture: eowiiewjdkfjrekjdvreqljdlfrlqdmf
+ email: askiur@sfl.com
+ organization: SFL
operationId: get-api-admin-users
description: Return a list of users.
/api/subscription:
@@ -215,6 +281,16 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionStatusResponse'
+ examples:
+ example-1:
+ value:
+ licenseInformation:
+ type: COMMUNITY
+ products: []
+ activated: true
+ versions:
+ Key: ''
+ FIleDescription: {}
headers:
Access-Control-Allow-Origin:
schema:
@@ -240,6 +316,16 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/FullSystemStatusResponse'
+ examples:
+ example-1:
+ value:
+ localVersions:
+ Key: ''
+ FIleDescription: []
+ remoteVersions:
+ Key: ''
+ FIleDescription: {}
+ updateAvailable: false
operationId: get-api-update
description: Return the current version number and the available version number of Jams(for update).
post:
@@ -262,6 +348,11 @@ components:
certificate:
type: string
description: "The user's Jami device."
+ x-examples:
+ example-1:
+ deviceId: sfl123
+ displayName: ThinkpadL30
+ certificate: sjhgfdszwythudsiuyfdvsxkiwjhyed
UserProfile:
title: UserProfile
type: object
@@ -287,6 +378,18 @@ components:
organization:
type: string
description: "The user's extended information which is not critical to Jami operations, usually provided by LDAP, Active Directory or other backend."
+ x-examples:
+ example-1:
+ username: lily
+ firstName: Lilye
+ lastName: Aldrin
+ phoneNumber: '5149876554'
+ phoneNumberExtension: '123'
+ mobileNumber: '4381230987'
+ faxNumber: '1239876543'
+ profilePicture: eowiiewjdkfjrekjdvreqljdlfrlqdmf
+ email: askiur@sfl.com
+ organization: SFL
User:
title: User
type: object
@@ -316,9 +419,29 @@ components:
type: string
jamiId:
type: string
+ x-examples:
+ example-1:
+ username: lily
+ password: abcs123
+ userType: LOCAL
+ realm: ''
+ accessLevel: USER
+ needsPasswordReset: 'false'
+ ethAddress: ''
+ ethKey: ''
+ jamiId: ''
SubscriptionStatusResponse:
title: SubscriptionStatusResponse
type: object
+ x-examples:
+ example-1:
+ licenseInformation:
+ type: COMMUNITY
+ products: []
+ activated: true
+ versions:
+ Key: ''
+ FIleDescription: {}
properties:
licenseInformation:
$ref: '#/components/schemas/LicenseInformation'
@@ -339,6 +462,7 @@ components:
type: array
items:
type: string
+ x-examples: {}
FullSystemStatusResponse:
title: FullSystemStatusResponse
type: object
@@ -349,3 +473,12 @@ components:
type: object
updateAvailable:
type: boolean
+ x-examples:
+ example-1:
+ localVersions:
+ Key: ''
+ FIleDescription: []
+ remoteVersions:
+ Key: ''
+ FIleDescription: {}
+ updateAvailable: false
diff --git a/api-doc/reference/Install-API.v1.yaml b/api-doc/reference/Install-API.v1.yaml
index 4dffe75631638b5aa616e40b251255b867ad650a..33464392fd1f1635b75d556ea9e26919c3a409d7 100644
--- a/api-doc/reference/Install-API.v1.yaml
+++ b/api-doc/reference/Install-API.v1.yaml
@@ -97,6 +97,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/AuthTokenResponse'
+ examples:
+ example-1: {}
'500':
description: Internal Server Error
description: Create administrative user account.
diff --git a/api-doc/reference/User-API.v1.yaml b/api-doc/reference/User-API.v1.yaml
index 69b7aea135bcea02ed78dcc2f5bd4727d4fe0277..3e974734ec0015e87365cd47a75bdf6b3e4be9e7 100644
--- a/api-doc/reference/User-API.v1.yaml
+++ b/api-doc/reference/User-API.v1.yaml
@@ -9,7 +9,15 @@ paths:
get:
summary: "Get User's list of contacts"
tags: []
- responses: {}
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Contact'
operationId: get-api-auth-contacts
description: "Get User's contacts."
put:
@@ -18,6 +26,8 @@ paths:
responses:
'200':
description: OK
+ '500':
+ description: Internal Server Error
description: "Update User's contact."
delete:
summary: "Delete a user's contact"
@@ -25,6 +35,8 @@ paths:
responses:
'200':
description: OK
+ '500':
+ description: Internal Server Error
description: "Delete user's contact."
'/api/auth/device/{deviceId}':
parameters:
@@ -203,6 +215,11 @@ components:
type: string
timestamp:
type: string
+ x-examples:
+ example-1:
+ success: 'true'
+ errorDetails: ''
+ timestamp: '2020-06-01T12:30:01'
AuthModuleKey:
title: AuthModuleKey
type: object
@@ -215,6 +232,17 @@ components:
- AD
- LDAP
- LOCAL
+ Contact:
+ title: Contact
+ type: object
+ description: Contact database object
+ properties:
+ owner:
+ type: string
+ uri:
+ type: string
+ displayName:
+ type: string
securitySchemes:
API Key - 1:
name: API Key