opensource/supermq
1
0
Fork 0
mirror of https://github.com/absmach/supermq.git synced 2026-06-23 07:30:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

MG-104: Rename/Replace filed owner with domain (#268)

Browse Source 
Signed-off-by: Arvindh <arvindh91@gmail.com>
This commit is contained in:
Arvindh
2024-01-28 03:17:00 +05:30
committed by GitHub
parent e2616ecc4f
commit 2c4880485d
51 changed files with 302 additions and 993 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/openapi/things.yml
+11 -73
View File
@@ -79,7 +79,6 @@ paths:
- $ref: "#/components/parameters/Status"
- $ref: "#/components/parameters/ThingName"
- $ref: "#/components/parameters/Tags"
- $ref: "#/components/parameters/Owner"
security:
- bearerAuth: []
responses:
@@ -382,8 +381,7 @@ paths:
- Channels
summary: Creates new channel
description: |
Creates new channel. User identified by the provided access token will
be the channel's owner.
Creates new channel in domain.
requestBody:
$ref: "#/components/requestBodies/ChannelCreateReq"
security:
@@ -418,7 +416,6 @@ paths:
- $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/ChannelName"
- $ref: "#/components/parameters/OwnerId"
responses:
"200":
$ref: "#/components/responses/ChannelPageRes"
@@ -880,14 +877,9 @@ components:
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
minimum: 8
description: Free-form account secret used for acquiring auth token(s).
owner:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Thing owner must be exsiting in the databse.
metadata:
type: object
example: { "domain": "example.com" }
example: { "model": "example" }
description: Arbitrary, object-encoded thing's data.
status:
type: string
@@ -914,18 +906,13 @@ components:
description: Id of parent channel, it must be existing channel.
metadata:
type: object
example: { "domain": "example.com" }
example: { "location": "example" }
description: Arbitrary, object-encoded channels's data.
status:
type: string
description: Channel Status
format: string
example: enabled
owner_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Channel owner ID must be exsiting in the databse.
required:
- name
@@ -1039,11 +1026,11 @@ components:
type: string
example: ["tag1", "tag2"]
description: Thing tags.
owner:
domain_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Thing owner identifier.
description: ID of the domain to which thing belongs.
credentials:
type: object
properties:
@@ -1057,7 +1044,7 @@ components:
description: Thing secret password.
metadata:
type: object
example: { "domain": "example.com" }
example: { "model": "example" }
description: Arbitrary, object-encoded thing's data.
status:
type: string
@@ -1096,11 +1083,11 @@ components:
type: string
example: ["tag1", "tag2"]
description: Thing tags.
owner:
domain_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Thing owner identifier.
description: ID of the domain to which thing belongs.
credentials:
type: object
properties:
@@ -1114,7 +1101,7 @@ components:
description: Thing secret password.
metadata:
type: object
example: { "domain": "example.com" }
example: { "model": "example" }
description: Arbitrary, object-encoded thing's data.
status:
type: string
@@ -1146,11 +1133,11 @@ components:
type: string
example: channelName
description: Free-form channel name. Channel name is unique on the given hierarchy level.
owner_id:
domain_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Channel owner identifier of thing that created the channel..
description: ID of the domain to which the group belongs.
parent_id:
type: string
format: uuid
@@ -1342,16 +1329,6 @@ components:
required:
- secret
ThingOwner:
type: object
properties:
owner:
type: string
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Thing owner for example email address.
required:
- owner
ChannelUpdate:
type: object
properties:
@@ -1468,35 +1445,6 @@ components:
required: false
example: "thingName"
ThingIdentity:
name: identity
description: Thing's identity.
in: query
schema:
type: string
required: false
example: "admin@example.com"
Owner:
name: owner_id
description: Thing's owner.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
ThingOwner:
name: owner
description: Unique owner identifier for a thing.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
Status:
name: status
description: Thing account status.
@@ -1577,16 +1525,6 @@ components:
type: boolean
default: false
OwnerId:
name: ownerId
description: Unique owner identifier for a channel.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
Metadata:
name: metadata
description: Metadata filter. Filtering is performed matching the parameter with metadata on top level. Parameter is json.
api/openapi/users.yml
+4 -145
View File
@@ -73,8 +73,6 @@ paths:
- $ref: "#/components/parameters/UserName"
- $ref: "#/components/parameters/UserIdentity"
- $ref: "#/components/parameters/Tags"
- $ref: "#/components/parameters/Owner"
- $ref: "#/components/parameters/UserVisibility"
security:
- bearerAuth: []
responses:
@@ -376,7 +374,6 @@ paths:
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/GroupName"
- $ref: "#/components/parameters/ParentID"
- $ref: "#/components/parameters/OwnerID"
responses:
"200":
$ref: "#/components/responses/MembersPageRes"
@@ -412,7 +409,6 @@ paths:
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/ChannelName"
- $ref: "#/components/parameters/ParentID"
- $ref: "#/components/parameters/OwnerID"
responses:
"200":
$ref: "#/components/responses/MembersPageRes"
@@ -512,7 +508,6 @@ paths:
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/GroupName"
- $ref: "#/components/parameters/ParentID"
- $ref: "#/components/parameters/OwnerID"
responses:
"200":
$ref: "#/components/responses/GroupPageRes"
@@ -613,7 +608,6 @@ paths:
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/GroupName"
- $ref: "#/components/parameters/ParentID"
- $ref: "#/components/parameters/OwnerID"
responses:
"200":
$ref: "#/components/responses/GroupPageRes"
@@ -647,7 +641,6 @@ paths:
- $ref: "#/components/parameters/Metadata"
- $ref: "#/components/parameters/GroupName"
- $ref: "#/components/parameters/ParentID"
- $ref: "#/components/parameters/OwnerID"
responses:
"200":
$ref: "#/components/responses/GroupPageRes"
@@ -890,11 +883,6 @@ components:
example: password
minimum: 8
description: Free-form account secret used for acquiring auth token(s).
owner:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: User owner must be exsiting in the databse.
metadata:
type: object
example: { "domain": "example.com" }
@@ -931,11 +919,6 @@ components:
description: Group Status
format: string
example: enabled
owner_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Group owner ID must be exsiting in the databse.
required:
- name
@@ -958,11 +941,6 @@ components:
type: string
example: ["tag1", "tag2"]
description: User tags.
owner:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: User owner identifier.
credentials:
type: object
properties:
@@ -972,7 +950,7 @@ components:
description: User Identity for example email address.
metadata:
type: object
example: { "domain": "example.com" }
example: { "address": "example" }
description: Arbitrary, object-encoded user's data.
status:
type: string
@@ -1004,11 +982,11 @@ components:
type: string
example: groupName
description: Free-form group name. Group name is unique on the given hierarchy level.
owner_id:
domain_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Group owner identifier of user that created the group..
description: ID of the domain to which the group belongs..
parent_id:
type: string
format: uuid
@@ -1050,58 +1028,6 @@ components:
xml:
name: group
Memberships:
type: object
properties:
id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Unique group identifier generated by the service.
name:
type: string
example: groupName
description: Free-form group name. Group name is unique on the given hierarchy level.
owner_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Group owner identifier of user that created the group..
parent_id:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Group parent identifier.
description:
type: string
example: long group description
description: Group description, free form text.
metadata:
type: object
example: { "role": "general" }
description: Arbitrary, object-encoded groups's data.
path:
type: string
example: bb7edb32-2eac-4aad-aebe-ed96fe073879.bb7edb32-2eac-4aad-aebe-ed96fe073879
description: Hierarchy path, concatenated ids of group ancestors.
level:
type: integer
description: Level in hierarchy, distance from the root group.
format: int32
example: 2
created_at:
type: string
format: date-time
example: "2019-11-26 13:31:52"
description: Datetime when the group was created.
updated_at:
type: string
format: date-time
example: "2019-11-26 13:31:52"
description: Datetime when the group was created.
xml:
name: memberships
Members:
type: object
properties:
@@ -1121,11 +1047,6 @@ components:
type: string
example: ["computations", "datasets"]
description: User tags.
owner:
type: string
format: uuid
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
description: User owner identifier.
credentials:
type: object
properties:
@@ -1209,31 +1130,6 @@ components:
- total
- level
MembershipsPage:
type: object
properties:
memberships:
type: array
minItems: 0
uniqueItems: true
items:
$ref: "#/components/schemas/Memberships"
total:
type: integer
example: 1
description: Total number of items.
offset:
type: integer
description: Number of items to skip during retrieval.
limit:
type: integer
example: 10
description: Maximum number of items to return in one page.
required:
- memberships
- total
- level
MembersPage:
type: object
properties:
@@ -1320,7 +1216,7 @@ components:
example: user
description: User role example.
required:
- owner
- role
GroupUpdate:
type: object
@@ -1476,26 +1372,6 @@ components:
required: false
example: "admin@example.com"
Owner:
name: owner_id
description: User's owner.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
UserOwner:
name: owner
description: Unique owner identifier for a user.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
Status:
name: status
description: User account status.
@@ -1605,16 +1481,6 @@ components:
type: boolean
default: false
OwnerID:
name: ownerID
description: Unique owner identifier for a group.
in: query
schema:
type: string
format: uuid
required: false
example: bb7edb32-2eac-4aad-aebe-ed96fe073879
Metadata:
name: metadata
description: Metadata filter. Filtering is performed matching the parameter with metadata on top level. Parameter is json.
@@ -1816,13 +1682,6 @@ components:
schema:
$ref: "#/components/schemas/UsersPage"
MembershipsPageRes:
description: Memberships associated with the user.
content:
application/json:
schema:
$ref: "#/components/schemas/MembershipsPage"
GroupCreateRes:
description: Registered new group.
headers: