Skip to content

Commit 7c8daa5

Browse files
committed
1 parent 6c7a073 commit 7c8daa5

6 files changed

Lines changed: 28 additions & 10 deletions

File tree

api_data.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3406,11 +3406,20 @@ define({ "api": [
34063406
"url": "/v0/auth/users/:userId/roles",
34073407
"title": "Add Roles to a user",
34083408
"description": "<p>Returns a list of current role ids of the user. You need have update permission to the user record in order to access this API.</p>",
3409+
"parameter": {
3410+
"examples": [
3411+
{
3412+
"title": "(Body) {json}:",
3413+
"content": "[\"xxxx-xxxx-xxx-xxx-xx1\", \"xx-xx-xxx-xxxx-xxx2\"]",
3414+
"type": "json"
3415+
}
3416+
]
3417+
},
34093418
"success": {
34103419
"examples": [
34113420
{
34123421
"title": "200",
3413-
"content": "[\"xxxx-xxxx-xxx-xxx-xx\", \"xx-xx-xxx-xxxx-xxxxx\"]",
3422+
"content": "[\"xxxx-xxxx-xxx-xxx-xx1\", \"xx-xx-xxx-xxxx-xxx2\", \"xx-xx-xxx-xxxx-xxx3\"]",
34143423
"type": "json"
34153424
}
34163425
]

api_data.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3406,11 +3406,20 @@
34063406
"url": "/v0/auth/users/:userId/roles",
34073407
"title": "Add Roles to a user",
34083408
"description": "<p>Returns a list of current role ids of the user. You need have update permission to the user record in order to access this API.</p>",
3409+
"parameter": {
3410+
"examples": [
3411+
{
3412+
"title": "(Body) {json}:",
3413+
"content": "[\"xxxx-xxxx-xxx-xxx-xx1\", \"xx-xx-xxx-xxxx-xxx2\"]",
3414+
"type": "json"
3415+
}
3416+
]
3417+
},
34093418
"success": {
34103419
"examples": [
34113420
{
34123421
"title": "200",
3413-
"content": "[\"xxxx-xxxx-xxx-xxx-xx\", \"xx-xx-xxx-xxxx-xxxxx\"]",
3422+
"content": "[\"xxxx-xxxx-xxx-xxx-xx1\", \"xx-xx-xxx-xxxx-xxx2\", \"xx-xx-xxx-xxxx-xxx3\"]",
34143423
"type": "json"
34153424
}
34163425
]

api_project.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

api_project.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "MAGDA API Documentation",
3-
"version": "5.2.0",
3+
"version": "5.3.0",
44
"description": "This API documentation is for the open data platform MAGDA. REST is used. Unless stated otherwise, the JSON data format is used for all request and response body.",
55
"title": "MAGDA API",
66
"url": "https://<host>/api",
@@ -13,7 +13,7 @@
1313
"apidoc": "0.3.0",
1414
"generator": {
1515
"name": "apidoc",
16-
"time": "2025-06-25T06:19:30.161Z",
16+
"time": "2025-06-25T14:40:33.262Z",
1717
"url": "https://apidocjs.com",
1818
"version": "0.17.6"
1919
}

openapi.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.1",
33
"info": {
44
"title": "MAGDA API Documentation",
5-
"version": "5.2.0",
5+
"version": "5.3.0",
66
"description": "This API documentation is for the open data platform MAGDA. REST is used. Unless stated otherwise, the JSON data format is used for all request and response body."
77
},
88
"servers": [
@@ -2217,7 +2217,7 @@
22172217
"parameters": [],
22182218
"responses": {
22192219
"200": {
2220-
"description": "<pre>[\"xxxx-xxxx-xxx-xxx-xx\", \"xx-xx-xxx-xxxx-xxxxx\"]<pre>"
2220+
"description": "<pre>[\"xxxx-xxxx-xxx-xxx-xx1\", \"xx-xx-xxx-xxxx-xxx2\", \"xx-xx-xxx-xxxx-xxx3\"]<pre>"
22212221
},
22222222
"401/500": {
22232223
"description": "<pre>{\n \"isError\": true,\n \"errorCode\": 401, //--- or 500 depends on error type\n \"errorMessage\": \"Not authorized\"\n}<pre>"

swagger.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"swagger": "2.0",
33
"info": {
44
"title": "MAGDA API Documentation",
5-
"version": "5.2.0",
5+
"version": "5.3.0",
66
"description": "This API documentation is for the open data platform MAGDA. REST is used. Unless stated otherwise, the JSON data format is used for all request and response body."
77
},
88
"schemes": [
@@ -2000,7 +2000,7 @@
20002000
"parameters": [],
20012001
"responses": {
20022002
"200": {
2003-
"description": "<pre>[\"xxxx-xxxx-xxx-xxx-xx\", \"xx-xx-xxx-xxxx-xxxxx\"]<pre>"
2003+
"description": "<pre>[\"xxxx-xxxx-xxx-xxx-xx1\", \"xx-xx-xxx-xxxx-xxx2\", \"xx-xx-xxx-xxxx-xxx3\"]<pre>"
20042004
},
20052005
"401/500": {
20062006
"description": "<pre>{\n \"isError\": true,\n \"errorCode\": 401, //--- or 500 depends on error type\n \"errorMessage\": \"Not authorized\"\n}<pre>"

0 commit comments

Comments
 (0)