From 541c360d7b0db16b9581b9dc8568e8bed46246c2 Mon Sep 17 00:00:00 2001 From: Stephen Price Date: Wed, 8 Jul 2020 18:24:41 -0500 Subject: [PATCH] api created --- components/components.yaml | 120 ++++++++++++++++++------------------- reference/devices.v1.yaml | 61 +++++++++++++++++++ 2 files changed, 121 insertions(+), 60 deletions(-) diff --git a/components/components.yaml b/components/components.yaml index b9115f7..e6aece5 100644 --- a/components/components.yaml +++ b/components/components.yaml @@ -1,61 +1,61 @@ parameters: - accountid: - schema: - type: string - example: jetsonsFutureHome - name: accountid - in: path - required: true - description: unique per account (see `'My Account'` for more information) - spaceid: - schema: - type: string - example: seattle-office - default: all - in: query - name: spaceid - description: location associated with the devices (see `'My Spaces'` for more information) - allowEmptyValue: true - deviceName: - schema: - type: string - default: newDevice - example: garageCamera - in: header - name: deviceName - description: devices in the same space require unique names or will be assigned the default name `'newDevice'` - allowEmptyValue: true - deviceid: - schema: - type: string - default: all - example: 123abc - in: header - name: deviceid - description: 'unique identifiers for devices registered on the service cloud, when empty it defaults to `''all''`' - allowEmptyValue: true - required: true - sort: - schema: - type: string - enum: - - asc - - desc - default: desc - example: asc - in: query - name: sort - allowEmptyValue: true - description: will sort objects returned from the request - limit: - schema: - type: integer - default: 10 - format: int32 - example: 15 - maximum: 25 - minimum: 1 - in: query - name: limit - allowEmptyValue: true - description: specify the number of results returned from the request \ No newline at end of file + accountid: + schema: + type: string + example: jetsonsFutureHome + name: accountid + in: path + required: true + description: unique per account (see `'My Account'` for more information) + spaceid: + schema: + type: string + example: seattle-office + default: all + in: query + name: spaceid + description: location associated with the devices (see `'My Spaces'` for more information) + allowEmptyValue: true + deviceName: + schema: + type: string + default: newDevice + example: garageCamera + in: header + name: deviceName + description: devices in the same space require unique names or will be assigned the default name `'newDevice'` + allowEmptyValue: true + deviceid: + schema: + type: string + default: all + example: 123abc + in: header + name: deviceid + description: 'unique identifiers for devices registered on the service cloud, when empty it defaults to `''all''`' + allowEmptyValue: true + required: true + sort: + schema: + type: string + enum: + - asc + - desc + default: desc + example: asc + in: query + name: sort + allowEmptyValue: true + description: will sort objects returned from the request + limit: + schema: + type: integer + default: 10 + format: int32 + example: 15 + maximum: 25 + minimum: 1 + in: query + name: limit + allowEmptyValue: true + description: specify the number of results returned from the request \ No newline at end of file diff --git a/reference/devices.v1.yaml b/reference/devices.v1.yaml index 573b989..8e3ee0f 100644 --- a/reference/devices.v1.yaml +++ b/reference/devices.v1.yaml @@ -16,6 +16,67 @@ servers: paths: {} components: schemas: {} + parameters: + accountid: + schema: + type: string + example: jetsonsFutureHome + name: accountid + in: path + required: true + description: unique per account (see `'My Account'` for more information) + spaceid: + schema: + type: string + example: seattle-office + default: all + in: query + name: spaceid + description: location associated with the devices (see `'My Spaces'` for more information) + allowEmptyValue: true + deviceName: + schema: + type: string + default: newDevice + example: garageCamera + in: header + name: deviceName + description: devices in the same space require unique names or will be assigned the default name `'newDevice'` + allowEmptyValue: true + deviceid: + schema: + type: string + default: all + example: 123abc + in: header + name: deviceid + description: 'unique identifiers for devices registered on the service cloud, when empty it defaults to `''all''`' + allowEmptyValue: true + required: true + sort: + schema: + type: string + enum: + - asc + - desc + default: desc + example: asc + in: query + name: sort + allowEmptyValue: true + description: will sort objects returned from the request + limit: + schema: + type: integer + default: 10 + format: int32 + example: 15 + maximum: 25 + minimum: 1 + in: query + name: limit + allowEmptyValue: true + description: specify the number of results returned from the request securitySchemes: API Key: name: API Key