mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
feat: update mgmt api docs (#28378)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andphamhieu authored and GitHub committed
1 parent
4671c91c8a
commit
14f22a48a0
3 files changed
+155
-62
No files matched your search
@@ -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
|
||||
@@ -1616,11 +1616,9 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"required": true,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -1639,7 +1637,6 @@
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -1653,24 +1650,30 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"ownership_verification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"custom_origin_server": {
|
||||
"type": "string"
|
||||
@@ -1852,11 +1855,9 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"required": true,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -1875,7 +1876,6 @@
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -1889,24 +1889,30 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"ownership_verification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"custom_origin_server": {
|
||||
"type": "string"
|
||||
@@ -2034,11 +2040,9 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"required": true,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -2057,7 +2061,6 @@
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -2071,24 +2074,30 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"ownership_verification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"custom_origin_server": {
|
||||
"type": "string"
|
||||
@@ -2216,11 +2225,9 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"required": true,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -2239,7 +2246,6 @@
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -2253,24 +2259,30 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"ownership_verification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"custom_origin_server": {
|
||||
"type": "string"
|
||||
@@ -4092,6 +4104,9 @@
|
||||
"201": {
|
||||
"description": ""
|
||||
},
|
||||
"403": {
|
||||
"description": ""
|
||||
},
|
||||
"500": {
|
||||
"description": "Failed to set up read replica"
|
||||
}
|
||||
@@ -4145,6 +4160,9 @@
|
||||
"201": {
|
||||
"description": ""
|
||||
},
|
||||
"403": {
|
||||
"description": ""
|
||||
},
|
||||
"500": {
|
||||
"description": "Failed to remove read replica"
|
||||
}
|
||||
@@ -7062,7 +7080,7 @@
|
||||
"/v1/projects/{ref}/config/auth/third-party-auth": {
|
||||
"post": {
|
||||
"operationId": "createTPAForProject",
|
||||
"summary": "[Alpha] Creates a new third-party auth integration",
|
||||
"summary": "Creates a new third-party auth integration",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "ref",
|
||||
@@ -9241,7 +9259,8 @@
|
||||
"FAILED",
|
||||
"PENDING",
|
||||
"REMOVED",
|
||||
"ARCHIVED"
|
||||
"ARCHIVED",
|
||||
"CANCELLED"
|
||||
]
|
||||
},
|
||||
"is_physical_backup": {
|
||||
@@ -10320,6 +10339,69 @@
|
||||
"message"
|
||||
]
|
||||
},
|
||||
"SslValidation": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"txt_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"txt_value": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"txt_name",
|
||||
"txt_value"
|
||||
]
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"message"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"OwnershipVerification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"CustomHostnameDetails": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -10333,11 +10415,9 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"required": true,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -10356,7 +10436,6 @@
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -10370,24 +10449,30 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"ownership_verification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"custom_origin_server": {
|
||||
"type": "string"
|
||||
@@ -10442,11 +10527,9 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"required": true,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -10465,7 +10548,6 @@
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -10479,24 +10561,30 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"ownership_verification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"custom_origin_server": {
|
||||
"type": "string"
|
||||
@@ -10575,11 +10663,9 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validation_records": {
|
||||
"required": true,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -10598,7 +10684,6 @@
|
||||
}
|
||||
},
|
||||
"validation_errors": {
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
@@ -10612,24 +10697,30 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"status",
|
||||
"validation_records"
|
||||
]
|
||||
},
|
||||
"ownership_verification": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type",
|
||||
"name",
|
||||
"value"
|
||||
]
|
||||
},
|
||||
"custom_origin_server": {
|
||||
"type": "string"
|
||||
@@ -14225,7 +14316,8 @@
|
||||
"FAILED",
|
||||
"PENDING",
|
||||
"REMOVED",
|
||||
"ARCHIVED"
|
||||
"ARCHIVED",
|
||||
"CANCELLED"
|
||||
]
|
||||
},
|
||||
"is_physical_backup": {
|
||||
@@ -14276,7 +14368,8 @@
|
||||
"FAILED",
|
||||
"PENDING",
|
||||
"REMOVED",
|
||||
"ARCHIVED"
|
||||
"ARCHIVED",
|
||||
"CANCELLED"
|
||||
]
|
||||
},
|
||||
"is_physical_backup": {
|
||||
|
||||
@@ -288,7 +288,7 @@ th code {
|
||||
* widths
|
||||
*/
|
||||
.prose :where(td) code {
|
||||
@apply break-all
|
||||
@apply break-all;
|
||||
}
|
||||
|
||||
/* Zoomable image */
|
||||
|
||||
Reference in new issue
Block a user