feat: update mgmt api docs (#27851)

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andphamhieu authored and GitHub committed 2024-07-08 19:13:11 +00:00
1 parent b79a138055
commit 8aef4a08bf
4 files changed
+1284 -9

No files matched your search

+1 -1
View File
@@ -1 +1 @@
{"openapi":"3.0.0","paths":{"/v1/branches/{branch_id}":{"get":{"operationId":"v1-get-a-branch-config","summary":"Get database branch config","description":"Fetches configurations of the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchDetailResponse"}}}},"500":{"description":"Failed to retrieve database branch"}},"tags":["environments"],"security":[{"bearer":[]}]},"patch":{"operationId":"v1-update-a-branch-config","summary":"Update database branch config","description":"Updates the configuration of the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBranchBody"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchResponse"}}}},"500":{"description":"Failed to update database branch"}},"tags":["environments"],"security":[{"bearer":[]}]},"delete":{"operationId":"v1-delete-a-branch","summary":"Delete a database branch","description":"Deletes the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchDeleteResponse"}}}},"500":{"description":"Failed to delete database branch"}},"tags":["environments"],"security":[{"bearer":[]}]}},"/v1/branches/{branch_id}/reset":{"post":{"operationId":"v1-reset-a-branch","summary":"Resets a database branch","description":"Resets the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchResetResponse"}}}},"500":{"description":"Failed to reset database branch"}},"tags":["environments"],"security":[{"bearer":[]}]}},"/v1/projects":{"get":{"operationId":"v1-list-all-projects","summary":"List all projects","description":"Returns a list of all projects you've previously created.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ProjectResponse"}}}}}},"tags":["projects"],"security":[{"bearer":[]}]},"post":{"operationId":"v1-create-a-project","summary":"Create a project","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateProjectBody"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ProjectResponse"}}}}},"tags":["projects"],"security":[{"bearer":[]}]}},"/v1/organizations":{"get":{"operationId":"v1-list-all-organizations","summary":"List all organizations","description":"Returns a list of organizations that you currently belong to.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationResponseV1"}}}}},"500":{"description":"Unexpected error listing organizations"}},"tags":["organizations"],"security":[{"bearer":[]}]},"post":{"operationId":"v1-create-an-organization","summary":"Create an organization","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationBodyV1"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseV1"}}}},"500":{"description":"Unexpected error creating an organization"}},"tags":["organizations"],"security":[{"bearer":[]}]}},"/v1/oauth/authorize":{"get":{"operationId":"v1-authorize-user","summary":"[Beta] Authorize user through oauth","parameters":[{"name":"client_id","required":true,"in":"query","schema":{"type":"string"}},{"name":"response_type","required":true,"in":"query","schema":{"enum":["code","token","id_token token"],"type":"string"}},{"name":"redirect_uri","required":true,"in":"query","schema":{"type":"string"}},{"name":"scope","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","required":false,"in":"query","schema":{"type":"string"}},{"name":"response_mode","required":false,"in":"query","schema":{"type":"string"}},{"name":"code_challenge","required":false,"in":"query","schema":{"type":"string"}},{"name":"code_challenge_method","required":false,"in":"query","schema":{"enum":["plain","sha256","S256"],"type":"string"}}],"responses":{"303":{"description":""}},"tags":["oauth"],"security":[{"oauth2":["read"]}]}},"/v1/oauth/token":{"post":{"operationId":"v1-exchange-oauth-token","summary":"[BeLine truncated
{"openapi":"3.0.0","paths":{"/v1/branches/{branch_id}":{"get":{"operationId":"v1-get-a-branch-config","summary":"Get database branch config","description":"Fetches configurations of the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchDetailResponse"}}}},"500":{"description":"Failed to retrieve database branch"}},"tags":["environments"],"security":[{"bearer":[]}]},"patch":{"operationId":"v1-update-a-branch-config","summary":"Update database branch config","description":"Updates the configuration of the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBranchBody"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchResponse"}}}},"500":{"description":"Failed to update database branch"}},"tags":["environments"],"security":[{"bearer":[]}]},"delete":{"operationId":"v1-delete-a-branch","summary":"Delete a database branch","description":"Deletes the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchDeleteResponse"}}}},"500":{"description":"Failed to delete database branch"}},"tags":["environments"],"security":[{"bearer":[]}]}},"/v1/branches/{branch_id}/reset":{"post":{"operationId":"v1-reset-a-branch","summary":"Resets a database branch","description":"Resets the specified database branch","parameters":[{"name":"branch_id","required":true,"in":"path","description":"Branch ID","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchResetResponse"}}}},"500":{"description":"Failed to reset database branch"}},"tags":["environments"],"security":[{"bearer":[]}]}},"/v1/projects":{"get":{"operationId":"v1-list-all-projects","summary":"List all projects","description":"Returns a list of all projects you've previously created.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ProjectResponse"}}}}}},"tags":["projects"],"security":[{"bearer":[]}]},"post":{"operationId":"v1-create-a-project","summary":"Create a project","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateProjectBody"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ProjectResponse"}}}}},"tags":["projects"],"security":[{"bearer":[]}]}},"/v1/organizations":{"get":{"operationId":"v1-list-all-organizations","summary":"List all organizations","description":"Returns a list of organizations that you currently belong to.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationResponseV1"}}}}},"500":{"description":"Unexpected error listing organizations"}},"tags":["organizations"],"security":[{"bearer":[]}]},"post":{"operationId":"v1-create-an-organization","summary":"Create an organization","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationBodyV1"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseV1"}}}},"500":{"description":"Unexpected error creating an organization"}},"tags":["organizations"],"security":[{"bearer":[]}]}},"/v1/oauth/authorize":{"get":{"operationId":"v1-authorize-user","summary":"[Beta] Authorize user through oauth","parameters":[{"name":"client_id","required":true,"in":"query","schema":{"type":"string"}},{"name":"response_type","required":true,"in":"query","schema":{"enum":["code","token","id_token token"],"type":"string"}},{"name":"redirect_uri","required":true,"in":"query","schema":{"type":"string"}},{"name":"scope","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","required":false,"in":"query","schema":{"type":"string"}},{"name":"response_mode","required":false,"in":"query","schema":{"type":"string"}},{"name":"code_challenge","required":false,"in":"query","schema":{"type":"string"}},{"name":"code_challenge_method","required":false,"in":"query","schema":{"enum":["plain","sha256","S256"],"type":"string"}}],"responses":{"303":{"description":""}},"tags":["oauth"],"security":[{"oauth2":["read"]}]}},"/v1/oauth/token":{"post":{"operationId":"v1-exchange-oauth-token","summary":"[BeLine truncated
+96
View File
@@ -5,6 +5,96 @@
"slug": "introduction",
"type": "markdown"
},
{
"type": "category",
"title": "analytics",
"items": [
{
"id": "v1-create-a-warehouse-collection",
"title": "Create a warehouse collection",
"slug": "v1-create-a-warehouse-collection",
"type": "operation"
},
{
"id": "v1-create-a-warehouse-endpoint",
"title": "Create a warehouse endpoint",
"slug": "v1-create-a-warehouse-endpoint",
"type": "operation"
},
{
"id": "v1-create-a-warehouse-token",
"title": "Create a warehouse token",
"slug": "v1-create-a-warehouse-token",
"type": "operation"
},
{
"id": "v1-delete-a-warehouse-collection",
"title": "Delete a warehouse collection",
"slug": "v1-delete-a-warehouse-collection",
"type": "operation"
},
{
"id": "v1-delete-a-warehouse-endpoint",
"title": "Delete a warehouse endpoint",
"slug": "v1-delete-a-warehouse-endpoint",
"type": "operation"
},
{
"id": "v1-delete-a-warehouse-token",
"title": "Delete a warehouse token",
"slug": "v1-delete-a-warehouse-token",
"type": "operation"
},
{
"id": "v1-get-a-warehouse-collection",
"title": "Get a warehouse collection",
"slug": "v1-get-a-warehouse-collection",
"type": "operation"
},
{
"id": "v1-list-all-warehouse-collections",
"title": "List all warehouse collections",
"slug": "v1-list-all-warehouse-collections",
"type": "operation"
},
{
"id": "v1-list-all-warehouse-endpoints",
"title": "List all warehouse endpoints",
"slug": "v1-list-all-warehouse-endpoints",
"type": "operation"
},
{
"id": "v1-list-all-warehouse-queries",
"title": "List all warehouse queries",
"slug": "v1-list-all-warehouse-queries",
"type": "operation"
},
{
"id": "v1-list-all-warehouse-tokens",
"title": "List all warehouse tokens",
"slug": "v1-list-all-warehouse-tokens",
"type": "operation"
},
{
"id": "v1-provision-a-warehouse-tenant",
"title": "Provision a warehouse tenant",
"slug": "v1-provision-a-warehouse-tenant",
"type": "operation"
},
{
"id": "v1-update-a-warehouse-collection",
"title": "Update a warehouse collection",
"slug": "v1-update-a-warehouse-collection",
"type": "operation"
},
{
"id": "v1-update-a-warehouse-endpoint",
"title": "Update a warehouse endpoint",
"slug": "v1-update-a-warehouse-endpoint",
"type": "operation"
}
]
},
{
"type": "category",
"title": "auth",
@@ -363,6 +453,12 @@
"slug": "v1-create-a-project",
"type": "operation"
},
{
"id": "v1-delete-a-project",
"title": "Delete a project",
"slug": "v1-delete-a-project",
"type": "operation"
},
{
"id": "v1-delete-network-bans",
"title": "Delete network bans",
File diff suppressed because it is too large. Load diff
-1
View File
@@ -335,4 +335,3 @@ th code {
background-position: 1000px 0;
}
}