feat: update mgmt api docs (#29442)

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andphamhieu authored and GitHub committed 2024-09-23 15:01:56 +00:00
1 parent 3572ca7970
commit 99a62b2f37
2 files changed
+618 -1

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
@@ -1269,6 +1269,50 @@
},
"api_key": {
"type": "string"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"nullable": true,
"type": "object"
},
"prefix": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"hash": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
},
"inserted_at": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"nullable": true
}
},
"required": [
@@ -1279,6 +1323,377 @@
}
}
}
}
},
"tags": [
"Secrets"
],
"security": [
{
"bearer": []
}
]
},
"post": {
"operationId": "createApiKey",
"summary": "[Alpha] Creates a new API key for the project",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": {
"minLength": 20,
"maxLength": 20,
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"enum": [
"publishable",
"secret"
],
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"required": [
"type"
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"api_key": {
"type": "string"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"nullable": true,
"type": "object"
},
"prefix": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"hash": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
},
"inserted_at": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"nullable": true
}
},
"required": [
"name",
"api_key"
]
}
}
}
}
},
"tags": [
"Secrets"
],
"security": [
{
"bearer": []
}
]
}
},
"/v1/projects/{ref}/api-keys/{id}": {
"patch": {
"operationId": "updateApiKey",
"summary": "[Alpha] Updates an API key for the project",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": {
"minLength": 20,
"maxLength": 20,
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"api_key": {
"type": "string"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"nullable": true,
"type": "object"
},
"prefix": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"hash": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
},
"inserted_at": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"nullable": true
}
},
"required": [
"name",
"api_key"
]
}
}
}
}
},
"tags": [
"Secrets"
],
"security": [
{
"bearer": []
}
]
},
"delete": {
"operationId": "deleteApiKey",
"summary": "[Alpha] Deletes an API key for the project",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": {
"minLength": 20,
"maxLength": 20,
"type": "string"
}
},
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"api_key": {
"type": "string"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"nullable": true,
"type": "object"
},
"prefix": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"hash": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
},
"inserted_at": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"nullable": true
}
},
"required": [
"name",
"api_key"
]
}
}
}
},
"403": {
"description": ""
@@ -4419,12 +4834,18 @@
"minimum": 0,
"maximum": 1024
},
"max_slot_wal_keep_size": {
"type": "string"
},
"max_standby_archive_delay": {
"type": "string"
},
"max_standby_streaming_delay": {
"type": "string"
},
"max_wal_size": {
"type": "string"
},
"max_worker_processes": {
"type": "integer",
"minimum": 0,
@@ -4433,6 +4854,9 @@
"shared_buffers": {
"type": "string"
},
"wal_keep_size": {
"type": "string"
},
"work_mem": {
"type": "string"
},
@@ -4519,12 +4943,18 @@
"minimum": 0,
"maximum": 1024
},
"max_slot_wal_keep_size": {
"type": "string"
},
"max_standby_archive_delay": {
"type": "string"
},
"max_standby_streaming_delay": {
"type": "string"
},
"max_wal_size": {
"type": "string"
},
"max_worker_processes": {
"type": "integer",
"minimum": 0,
@@ -4533,6 +4963,9 @@
"shared_buffers": {
"type": "string"
},
"wal_keep_size": {
"type": "string"
},
"work_mem": {
"type": "string"
},
@@ -4591,12 +5024,18 @@
"minimum": 0,
"maximum": 1024
},
"max_slot_wal_keep_size": {
"type": "string"
},
"max_standby_archive_delay": {
"type": "string"
},
"max_standby_streaming_delay": {
"type": "string"
},
"max_wal_size": {
"type": "string"
},
"max_worker_processes": {
"type": "integer",
"minimum": 0,
@@ -4605,6 +5044,9 @@
"shared_buffers": {
"type": "string"
},
"wal_keep_size": {
"type": "string"
},
"work_mem": {
"type": "string"
},
@@ -5352,6 +5794,14 @@
"type": "boolean",
"nullable": true
},
"mfa_web_authn_enroll_enabled": {
"type": "boolean",
"nullable": true
},
"mfa_web_authn_verify_enabled": {
"type": "boolean",
"nullable": true
},
"mfa_phone_otp_length": {
"type": "number"
},
@@ -5691,6 +6141,8 @@
"mfa_totp_verify_enabled",
"mfa_phone_enroll_enabled",
"mfa_phone_verify_enabled",
"mfa_web_authn_enroll_enabled",
"mfa_web_authn_verify_enabled",
"mfa_phone_otp_length",
"mfa_phone_template",
"mfa_phone_max_frequency",
@@ -6322,6 +6774,12 @@
"mfa_totp_verify_enabled": {
"type": "boolean"
},
"mfa_web_authn_enroll_enabled": {
"type": "boolean"
},
"mfa_web_authn_verify_enabled": {
"type": "boolean"
},
"mfa_phone_enroll_enabled": {
"type": "boolean"
},
@@ -6797,6 +7255,14 @@
"type": "boolean",
"nullable": true
},
"mfa_web_authn_enroll_enabled": {
"type": "boolean",
"nullable": true
},
"mfa_web_authn_verify_enabled": {
"type": "boolean",
"nullable": true
},
"mfa_phone_otp_length": {
"type": "number"
},
@@ -7136,6 +7602,8 @@
"mfa_totp_verify_enabled",
"mfa_phone_enroll_enabled",
"mfa_phone_verify_enabled",
"mfa_web_authn_enroll_enabled",
"mfa_web_authn_verify_enabled",
"mfa_phone_otp_length",
"mfa_phone_template",
"mfa_phone_max_frequency",
@@ -10433,6 +10901,17 @@
"content"
]
},
"ApiKeySecretJWTTemplate": {
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
},
"ApiKeyResponse": {
"type": "object",
"properties": {
@@ -10441,6 +10920,50 @@
},
"api_key": {
"type": "string"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"nullable": true,
"type": "object"
},
"prefix": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"hash": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
},
"inserted_at": {
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string",
"nullable": true
}
},
"required": [
@@ -10448,6 +10971,66 @@
"api_key"
]
},
"CreateApiKeyBody": {
"type": "object",
"properties": {
"type": {
"enum": [
"publishable",
"secret"
],
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"required": [
"type"
]
},
"UpdateApiKeyBody": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"secret_jwt_template": {
"nullable": true,
"allOf": [
{
"type": "object",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
]
}
]
}
}
},
"CreateBranchBody": {
"type": "object",
"properties": {
@@ -11753,12 +12336,18 @@
"minimum": 0,
"maximum": 1024
},
"max_slot_wal_keep_size": {
"type": "string"
},
"max_standby_archive_delay": {
"type": "string"
},
"max_standby_streaming_delay": {
"type": "string"
},
"max_wal_size": {
"type": "string"
},
"max_worker_processes": {
"type": "integer",
"minimum": 0,
@@ -11767,6 +12356,9 @@
"shared_buffers": {
"type": "string"
},
"wal_keep_size": {
"type": "string"
},
"work_mem": {
"type": "string"
},
@@ -11817,12 +12409,18 @@
"minimum": 0,
"maximum": 1024
},
"max_slot_wal_keep_size": {
"type": "string"
},
"max_standby_archive_delay": {
"type": "string"
},
"max_standby_streaming_delay": {
"type": "string"
},
"max_wal_size": {
"type": "string"
},
"max_worker_processes": {
"type": "integer",
"minimum": 0,
@@ -11831,6 +12429,9 @@
"shared_buffers": {
"type": "string"
},
"wal_keep_size": {
"type": "string"
},
"work_mem": {
"type": "string"
},
@@ -12416,6 +13017,14 @@
"type": "boolean",
"nullable": true
},
"mfa_web_authn_enroll_enabled": {
"type": "boolean",
"nullable": true
},
"mfa_web_authn_verify_enabled": {
"type": "boolean",
"nullable": true
},
"mfa_phone_otp_length": {
"type": "number"
},
@@ -12755,6 +13364,8 @@
"mfa_totp_verify_enabled",
"mfa_phone_enroll_enabled",
"mfa_phone_verify_enabled",
"mfa_web_authn_enroll_enabled",
"mfa_web_authn_verify_enabled",
"mfa_phone_otp_length",
"mfa_phone_template",
"mfa_phone_max_frequency",
@@ -13347,6 +13958,12 @@
"mfa_totp_verify_enabled": {
"type": "boolean"
},
"mfa_web_authn_enroll_enabled": {
"type": "boolean"
},
"mfa_web_authn_verify_enabled": {
"type": "boolean"
},
"mfa_phone_enroll_enabled": {
"type": "boolean"
},