diff --git a/api/openapi/auth.yml b/api/openapi/auth.yml index 5d798276fd..fd5ff9a12a 100644 --- a/api/openapi/auth.yml +++ b/api/openapi/auth.yml @@ -432,7 +432,7 @@ paths: dataset is consumed either by making subsequent requests, or by increasing the subset size of the initial request. parameters: - - $ref: "users.yml#/components/parameters/MemberID" + - $ref: "#/components/parameters/MemberID" - $ref: "#/components/parameters/Limit" - $ref: "#/components/parameters/Offset" - $ref: "#/components/parameters/Metadata" @@ -767,6 +767,15 @@ components: schema: type: string required: false + MemberID: + name: memberID + description: Unique member identifier. + in: path + schema: + type: string + format: uuid + required: true + example: bb7edb32-2eac-4aad-aebe-ed96fe073879 requestBodies: DomainCreateReq: diff --git a/api/openapi/things.yml b/api/openapi/things.yml index 4ed91b8cdf..12b1650325 100644 --- a/api/openapi/things.yml +++ b/api/openapi/things.yml @@ -661,68 +661,44 @@ paths: "500": $ref: "#/components/responses/ServiceError" - /things/{thingID}/channels: - get: - summary: List of channels connected to specified thing - description: | - Retrieves list of channels connected to specified thing with pagination - metadata. - tags: - - Channels - parameters: - - $ref: "#/components/parameters/ThingID" - - $ref: "#/components/parameters/Offset" - - $ref: "#/components/parameters/Limit" - responses: - "200": - $ref: "#/components/responses/ChannelPageRes" - "400": - description: Failed due to malformed query parameters. - "401": - description: Missing or invalid access token provided. - "404": - description: Thing does not exist. - "422": - description: Database can't process request. - "500": - $ref: "#/components/responses/ServiceError" - - /users/{memberID}/channels: + /channels/{memberID}/groups: get: - summary: List of channels connected to specified user + summary: Get group associated with the member description: | - Retrieves list of channels connected to specified user with pagination - metadata. + Gets groups associated with the channel member specified by id. tags: - - Channels + - Groups parameters: - $ref: "#/components/parameters/MemberID" - - $ref: "#/components/parameters/Offset" - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Metadata" + - $ref: "#/components/parameters/Status" + - $ref: "#/components/parameters/Tags" + security: + - bearerAuth: [] responses: "200": - $ref: "#/components/responses/ChannelPageRes" + $ref: "#/components/responses/GroupPageRes" "400": description: Failed due to malformed query parameters. "401": description: Missing or invalid access token provided. "404": - description: Thing does not exist. - "422": - description: Database can't process request. + description: Group does not exist. "500": $ref: "#/components/responses/ServiceError" - /groups/{memberID}/channels: + /things/{thingID}/channels: get: - summary: List of channels connected to specified group + summary: List of channels connected to specified thing description: | - Retrieves list of channels connected to specified group with pagination + Retrieves list of channels connected to specified thing with pagination metadata. tags: - Channels parameters: - - $ref: "#/components/parameters/MemberID" + - $ref: "#/components/parameters/ThingID" - $ref: "#/components/parameters/Offset" - $ref: "#/components/parameters/Limit" responses: diff --git a/api/openapi/users.yml b/api/openapi/users.yml index 3c2bfb5dcb..2e3a37fccf 100644 --- a/api/openapi/users.yml +++ b/api/openapi/users.yml @@ -973,7 +973,7 @@ paths: tags: - Domains parameters: - - $ref: "auth.yml#/components/parameters/DomainID" + - $ref: "#/components/parameters/DomainID" - $ref: "#/components/parameters/Limit" - $ref: "#/components/parameters/Offset" - $ref: "#/components/parameters/Metadata" @@ -1606,6 +1606,16 @@ components: required: true example: bb7edb32-2eac-4aad-aebe-ed96fe073879 + DomainID: + name: domainID + description: Unique domain identifier. + in: path + schema: + type: string + format: uuid + required: true + example: bb7edb32-2eac-4aad-aebe-ed96fe073879 + MemberID: name: memberID description: Unique member identifier.