Clean up example values for swagger

master
esensar 2018-09-23 18:56:29 +02:00
parent 8d05ed2a41
commit dfd84644fb
3 changed files with 23 additions and 19 deletions

View File

@ -27,7 +27,7 @@ responses:
properties: properties:
status: status:
type: string type: string
default: success example: success
token: token:
type: string type: string
description: JWT token description: JWT token

View File

@ -12,10 +12,10 @@ responses:
properties: properties:
status: status:
type: string type: string
default: success example: success
message: message:
type: string type: string
default: Valid token example: Valid token
401: 401:
description: Bad credentials description: Bad credentials
schema: schema:

View File

@ -10,71 +10,75 @@ definitions:
genericname: genericname:
type: string type: string
description: name description: name
default: name example: name
username: username:
type: string type: string
description: User's name in the system description: User's name in the system
default: testusername example: user_name
id: id:
type: integer type: integer
description: ID description: ID
default: 1 example: 1
datetime: datetime:
type: string type: string
description: Time description: Time
example: 2018-09-19T17:50:24+00:00
timestamp: timestamp:
type: integer type: integer
description: Time description: Time
default: 1537720769 example: 1537379424
devicetypename: devicetypename:
type: string type: string
description: Name of device type description: Name of device type
default: STANDARD default: STANDARD
example: STANDARD
devicename: devicename:
type: string type: string
description: Name of device description: Name of device
default: My device example: Temperature device
devicetype: devicetype:
type: integer type: integer
description: Type of device description: Type of device
default: 1 example: 1
email: email:
type: string type: string
format: email format: email
description: User's registered email description: User's registered email
default: user@test.com example: user@mail.com
password: password:
type: string type: string
format: password format: password
description: User's password description: User's password
default: TestPassword1234 example: TestPassword1234
status: status:
type: string type: string
description: Status of request description: Status of request
example: error
message: message:
type: string type: string
description: Descriptive message description: Descriptive message
example: Long message
configuration: configuration:
type: string type: string
description: Configuration description: Configuration
default: {} example: {}
dashboarddata: dashboarddata:
type: object type: object
description: Dashboard data description: Dashboard data
default: {} example: {}
Credentials: Credentials:
type: object type: object
@ -131,7 +135,7 @@ definitions:
record_value: record_value:
type: string type: string
description: Value of the recording description: Value of the recording
default: '25 degrees' example: '25 degrees'
RecordingCreation: RecordingCreation:
type: object type: object
@ -147,7 +151,7 @@ definitions:
record_value: record_value:
type: string type: string
description: Value of the recording description: Value of the recording
default: '25 degrees' example: '25 degrees'
DeviceType: DeviceType:
type: object type: object
@ -229,10 +233,10 @@ definitions:
properties: properties:
status: status:
$ref: '#/definitions/status' $ref: '#/definitions/status'
default: error example: error
message: message:
$ref: '#/definitions/message' $ref: '#/definitions/message'
default: Unauthorized example: Unauthorized
Error: Error:
type: object type: object
@ -242,10 +246,10 @@ definitions:
properties: properties:
status: status:
$ref: '#/definitions/status' $ref: '#/definitions/status'
default: error example: error
message: message:
$ref: '#/definitions/message' $ref: '#/definitions/message'
default: Error message example: Error message
securityDefinitions: securityDefinitions:
Bearer: Bearer: