Browse Source

chore(swagger): add org users apis in swagger docs

Signed-off-by: Pranav C <pranavxc@gmail.com>
pull/4134/head
Pranav C 2 years ago
parent
commit
705f8ead4c
  1. 40
      packages/nocodb-sdk/src/lib/Api.ts
  2. 122
      scripts/sdk/swagger.json

40
packages/nocodb-sdk/src/lib/Api.ts

@ -832,8 +832,8 @@ export class Api<
> extends HttpClient<SecurityDataType> {
auth = {
/**
* @description Create a new user with provided email and password and first user is marked as super admin.
*
* @description Create a new user with provided email and password and first user is marked as super admin.
*
* @tags Auth
* @name Signup
* @summary Signup
@ -872,8 +872,8 @@ export class Api<
}),
/**
* @description Authenticate existing user with their email and password. Successful login will return a JWT access-token.
*
* @description Authenticate existing user with their email and password. Successful login will return a JWT access-token.
*
* @tags Auth
* @name Signin
* @summary Signin
@ -960,7 +960,7 @@ export class Api<
/**
* @description Change password of authenticated user with a new one.
*
*
* @tags Auth
* @name PasswordChange
* @summary Password change
@ -1071,7 +1071,7 @@ export class Api<
/**
* No description
*
*
* @tags Auth
* @name ProjectUserList
* @summary Project users
@ -1192,7 +1192,7 @@ export class Api<
project = {
/**
* No description
*
*
* @tags Project
* @name MetaGet
* @summary Project info
@ -1377,7 +1377,7 @@ export class Api<
/**
* @description Read project details
*
*
* @tags Project
* @name SharedBaseGet
* @request GET:/api/v1/db/meta/projects/{projectId}/shared
@ -1420,7 +1420,7 @@ export class Api<
/**
* No description
*
*
* @tags Project
* @name SharedBaseCreate
* @request POST:/api/v1/db/meta/projects/{projectId}/shared
@ -1457,7 +1457,7 @@ export class Api<
/**
* No description
*
*
* @tags Project
* @name SharedBaseUpdate
* @request PATCH:/api/v1/db/meta/projects/{projectId}/shared
@ -1543,7 +1543,7 @@ export class Api<
/**
* No description
*
*
* @tags Project
* @name AuditList
* @request GET:/api/v1/db/meta/projects/{projectId}/audits
@ -2146,7 +2146,7 @@ export class Api<
/**
* No description
*
*
* @tags DB view share
* @name Create
* @request POST:/api/v1/db/meta/views/{viewId}/share
@ -2265,7 +2265,7 @@ export class Api<
dbTableSort = {
/**
* No description
*
*
* @tags DB table sort
* @name List
* @request GET:/api/v1/db/meta/views/{viewId}/sorts
@ -3455,7 +3455,7 @@ export class Api<
/**
* @description Read project details
*
*
* @tags Public
* @name SharedBaseGet
* @request GET:/api/v1/db/public/shared-base/{sharedBaseUuid}/meta
@ -3479,7 +3479,7 @@ export class Api<
/**
* No description
*
*
* @tags Public
* @name SharedViewMetaGet
* @request GET:/api/v1/db/public/shared-view/{sharedViewUuid}/meta
@ -3614,7 +3614,7 @@ export class Api<
/**
* No description
*
*
* @tags Utils
* @name TestConnection
* @request POST:/api/v1/db/meta/connection/test
@ -3724,7 +3724,7 @@ export class Api<
/**
* No description
*
*
* @tags Utils
* @name AggregatedMetaInfo
* @request GET:/api/v1/aggregated-meta-info
@ -3841,7 +3841,7 @@ export class Api<
dbTableWebhook = {
/**
* No description
*
*
* @tags DB table webhook
* @name List
* @request GET:/api/v1/db/meta/tables/{tableId}/hooks
@ -3913,7 +3913,7 @@ export class Api<
/**
* No description
*
*
* @tags DB table webhook
* @name SamplePayloadGet
* @request GET:/api/v1/db/meta/tables/{tableId}/hooks/samplePayload/{operation}
@ -3982,7 +3982,7 @@ export class Api<
plugin = {
/**
* No description
*
*
* @tags Plugin
* @name List
* @request GET:/api/v1/db/meta/plugins

122
scripts/sdk/swagger.json

@ -441,6 +441,125 @@
},
"parameters": []
},
"/api/v1/users": {
"get": {
"summary": "Project users",
"operationId": "org-users-list",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"users": {
"type": "object",
"properties": {
"list": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"$ref": "#/components/schemas/User"
}
},
"pageInfo": {
"$ref": "#/components/schemas/Paginated"
}
},
"required": [
"list",
"pageInfo"
]
}
}
}
}
}
}
},
"description": "",
"tags": [
"OrgUsers"
]
},
"parameters": [],
"post": {
"summary": "Project User Add",
"operationId": "rgo-users-add",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"tags": [
"Auth"
]
}
},
"/api/v1/users/{userId}": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "userId",
"in": "path",
"required": true
}
],
"patch": {
"summary": "",
"operationId": "org-users-update",
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"OrgUsers"
],
"description": "",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
},
"delete": {
"summary": "",
"operationId": "org-users-delete",
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"OrgUsers"
],
"description": ""
}
},
"/api/v1/db/meta/projects/{projectId}/users": {
"get": {
"summary": "Project users",
@ -4961,9 +5080,6 @@
"description": "",
"parameters": [
{
"schema": {
"type": "array"
},
"in": "query",
"name": "ids",
"required": true

Loading…
Cancel
Save