Fixes for API reference (#2010)
This commit is contained in:
@@ -1,4 +1,9 @@
|
|||||||
---
|
---
|
||||||
title: 'Add Member'
|
title: 'Add Member'
|
||||||
openapi: post /api/v1/orgs/organizations/{org_id}/members/
|
openapi: post /api/v1/orgs/organizations/{org_id}/members/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
The API provides two roles for organization members:
|
||||||
|
|
||||||
|
- `READER`: Allows viewing of organization resources.
|
||||||
|
- `OWNER`: Grants full administrative access to manage the organization and its resources.
|
||||||
|
|||||||
@@ -1,4 +1,9 @@
|
|||||||
---
|
---
|
||||||
title: 'Update Member'
|
title: 'Update Member'
|
||||||
openapi: put /api/v1/orgs/organizations/{org_id}/members/
|
openapi: put /api/v1/orgs/organizations/{org_id}/members/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
The API provides two roles for organization members:
|
||||||
|
|
||||||
|
- `READER`: Allows viewing of organization resources.
|
||||||
|
- `OWNER`: Grants full administrative access to manage the organization and its resources.
|
||||||
@@ -1,4 +1,9 @@
|
|||||||
---
|
---
|
||||||
title: 'Add Member'
|
title: 'Add Member'
|
||||||
openapi: post /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
openapi: post /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
The API provides two roles for project members:
|
||||||
|
|
||||||
|
- `READER`: Allows viewing of project resources.
|
||||||
|
- `OWNER`: Grants full administrative access to manage the project and its resources.
|
||||||
|
|||||||
@@ -1,4 +1,9 @@
|
|||||||
---
|
---
|
||||||
title: 'Update Member'
|
title: 'Update Member'
|
||||||
openapi: put /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
openapi: put /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
The API provides two roles for project members:
|
||||||
|
|
||||||
|
- `READER`: Allows viewing of project resources.
|
||||||
|
- `OWNER`: Grants full administrative access to manage the project and its resources.
|
||||||
|
|||||||
@@ -158,7 +158,12 @@
|
|||||||
},
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Type of the entity (e.g., 'user', 'agent')"
|
"enum": [
|
||||||
|
"user",
|
||||||
|
"agent",
|
||||||
|
"app",
|
||||||
|
"run"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
@@ -229,20 +234,28 @@
|
|||||||
"operationId": "entities_read",
|
"operationId": "entities_read",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"name": "org_name",
|
"name": "entity_type",
|
||||||
"in": "query",
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"user",
|
||||||
|
"agent",
|
||||||
|
"app",
|
||||||
|
"run"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"description": "Filter entities by organization name"
|
"description": "The type of the entity (user, agent, app, or run)"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "project_name",
|
"name": "entity_id",
|
||||||
"in": "query",
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"description": "Filter entities by project name"
|
"description": "The unique identifier of the entity"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
@@ -472,7 +485,9 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"user",
|
"user",
|
||||||
"agent"
|
"agent",
|
||||||
|
"app",
|
||||||
|
"run"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@@ -805,7 +820,9 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"user",
|
"user",
|
||||||
"agent"
|
"agent",
|
||||||
|
"app",
|
||||||
|
"run"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user