lywsvip/supabase
1
0
Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-05-06 22:18:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: update mgmt api docs (#45497)

Browse Source 
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
This commit is contained in:
supabase-supabase-autofixer[bot]
2026-05-04 14:28:16 +02:00
committed by GitHub
parent 4608b38a09
commit bf0df280a3
2 changed files with 228 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
apps/docs/spec/api_v1_openapi.json
View File

@@ -1920,7 +1920,7 @@
"200": {
"description": "",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/JitAccessResponse" } }
"application/json": { "schema": { "$ref": "#/components/schemas/JitStateResponse" } }
}
},
"401": { "description": "Unauthorized" },
@@ -1964,7 +1964,7 @@
"200": {
"description": "",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/JitAccessResponse" } }
"application/json": { "schema": { "$ref": "#/components/schemas/JitStateResponse" } }
}
},
"401": { "description": "Unauthorized" },
@@ -8306,44 +8306,33 @@
"required": ["custom_hostname"],
"example": { "custom_hostname": "docs.example.com" }
},
"JitAccessResponse": {
"type": "object",
"properties": {
"user_id": { "type": "string", "format": "uuid" },
"user_roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": { "type": "string", "minLength": 1 },
"expires_at": { "type": "number" },
"allowed_networks": {
"type": "object",
"properties": {
"allowed_cidrs": {
"type": "array",
"items": {
"type": "object",
"properties": { "cidr": { "type": "string" } },
"required": ["cidr"]
}
},
"allowed_cidrs_v6": {
"type": "array",
"items": {
"type": "object",
"properties": { "cidr": { "type": "string" } },
"required": ["cidr"]
}
}
}
}
},
"required": ["role"]
}
"JitStateResponse": {
"discriminator": { "propertyName": "state" },
"oneOf": [
{
"type": "object",
"properties": {
"state": { "type": "string", "enum": ["enabled", "disabled"] },
"appliedSuccessfully": { "type": "boolean" }
},
"required": ["state"]
},
{
"type": "object",
"properties": {
"state": { "type": "string", "enum": ["unavailable"] },
"unavailableReason": {
"type": "string",
"enum": [
"manual_migration_required",
"postgres_upgrade_required",
"temporarily_unavailable"
]
}
},
"required": ["state", "unavailableReason"]
}
},
"required": ["user_id", "user_roles"]
]
},
"JitAccessRequestRequest": {
"type": "object",
@@ -10674,6 +10663,45 @@
"properties": { "message": { "type": "string" } },
"required": ["message"]
},
"JitAccessResponse": {
"type": "object",
"properties": {
"user_id": { "type": "string", "format": "uuid" },
"user_roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": { "type": "string", "minLength": 1 },
"expires_at": { "type": "number" },
"allowed_networks": {
"type": "object",
"properties": {
"allowed_cidrs": {
"type": "array",
"items": {
"type": "object",
"properties": { "cidr": { "type": "string" } },
"required": ["cidr"]
}
},
"allowed_cidrs_v6": {
"type": "array",
"items": {
"type": "object",
"properties": { "cidr": { "type": "string" } },
"required": ["cidr"]
}
}
}
}
},
"required": ["role"]
}
}
},
"required": ["user_id", "user_roles"]
},
"AuthorizeJitAccessBody": {
"type": "object",
"properties": {

318
apps/docs/spec/transforms/api_v1_openapi_deparsed.json
View File

@@ -5380,59 +5380,42 @@
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
},
"user_roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"minLength": 1
},
"expires_at": {
"type": "number"
},
"allowed_networks": {
"type": "object",
"properties": {
"allowed_cidrs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
},
"allowed_cidrs_v6": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
}
}
}
},
"required": ["role"]
}
}
"discriminator": {
"propertyName": "state"
},
"required": ["user_id", "user_roles"]
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["enabled", "disabled"]
},
"appliedSuccessfully": {
"type": "boolean"
}
},
"required": ["state"]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["unavailable"]
},
"unavailableReason": {
"type": "string",
"enum": [
"manual_migration_required",
"postgres_upgrade_required",
"temporarily_unavailable"
]
}
},
"required": ["state", "unavailableReason"]
}
]
}
}
}
@@ -5512,59 +5495,42 @@
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
},
"user_roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"minLength": 1
},
"expires_at": {
"type": "number"
},
"allowed_networks": {
"type": "object",
"properties": {
"allowed_cidrs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
},
"allowed_cidrs_v6": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
}
}
}
},
"required": ["role"]
}
}
"discriminator": {
"propertyName": "state"
},
"required": ["user_id", "user_roles"]
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["enabled", "disabled"]
},
"appliedSuccessfully": {
"type": "boolean"
}
},
"required": ["state"]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["unavailable"]
},
"unavailableReason": {
"type": "string",
"enum": [
"manual_migration_required",
"postgres_upgrade_required",
"temporarily_unavailable"
]
}
},
"required": ["state", "unavailableReason"]
}
]
}
}
}
@@ -24010,60 +23976,43 @@
"custom_hostname": "docs.example.com"
}
},
"JitAccessResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
},
"user_roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"minLength": 1
},
"expires_at": {
"type": "number"
},
"allowed_networks": {
"type": "object",
"properties": {
"allowed_cidrs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
},
"allowed_cidrs_v6": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
}
}
}
},
"required": ["role"]
}
}
"JitStateResponse": {
"discriminator": {
"propertyName": "state"
},
"required": ["user_id", "user_roles"]
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["enabled", "disabled"]
},
"appliedSuccessfully": {
"type": "boolean"
}
},
"required": ["state"]
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["unavailable"]
},
"unavailableReason": {
"type": "string",
"enum": [
"manual_migration_required",
"postgres_upgrade_required",
"temporarily_unavailable"
]
}
},
"required": ["state", "unavailableReason"]
}
]
},
"JitAccessRequestRequest": {
"type": "object",
@@ -28501,6 +28450,61 @@
},
"required": ["message"]
},
"JitAccessResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
},
"user_roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"minLength": 1
},
"expires_at": {
"type": "number"
},
"allowed_networks": {
"type": "object",
"properties": {
"allowed_cidrs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
},
"allowed_cidrs_v6": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
"required": ["cidr"]
}
}
}
}
},
"required": ["role"]
}
}
},
"required": ["user_id", "user_roles"]
},
"AuthorizeJitAccessBody": {
"type": "object",
"properties": {