chore(api): sync OpenAPI contract by kong[bot] · Pull Request #5 · Kong/volcano-sdk-ruby

kong · 2026-08-30T07:19:54Z

Summary

Sync the vendored OpenAPI contract from Kong/volcano-hosting@df2b380c9bff.
Regenerate checked-in client or contract types with this repository's pinned tooling.

API change report

Public API

New Endpoints: 36

POST /mcp
GET /openapi.json
HEAD /openapi.json
GET /openapi.yaml
HEAD /openapi.yaml
GET /projects/{id}/access-tokens
POST /projects/{id}/access-tokens
GET /projects/{id}/access-tokens/usage
DELETE /projects/{id}/access-tokens/{tokenId}
GET /projects/{id}/access-tokens/{tokenId}
GET /projects/{id}/access-tokens/{tokenId}/usage
PUT /projects/{id}/frontend-shared-variables
GET /projects/{id}/frontends/{frontendId}/function-routes
POST /projects/{id}/frontends/{frontendId}/function-routes
DELETE /projects/{id}/frontends/{frontendId}/function-routes/{routeId}
PUT /projects/{id}/frontends/{frontendId}/function-routes/{routeId}
POST /projects/{id}/sandbox-executions
GET /projects/{id}/sandbox-sessions
POST /projects/{id}/sandbox-sessions
GET /projects/{id}/sandboxes
POST /projects/{id}/sandboxes
DELETE /projects/{id}/sandboxes/{sandboxId}
GET /projects/{id}/sandboxes/{sandboxId}
PATCH /projects/{id}/sandboxes/{sandboxId}
GET /projects/{id}/sandboxes/{sandboxId}/deployments
DELETE /sandbox-sessions/{sessionId}
GET /sandbox-sessions/{sessionId}
POST /sandbox-sessions/{sessionId}/access
POST /sandbox-sessions/{sessionId}/exec
POST /sandbox-sessions/{sessionId}/files/read
POST /sandbox-sessions/{sessionId}/files/write
DELETE /sandbox-sessions/{sessionId}/grants/{subjectId}
PUT /sandbox-sessions/{sessionId}/grants/{subjectId}
POST /sandbox-sessions/{sessionId}/resume
POST /sandbox-sessions/{sessionId}/suspend
GET /sandboxes/presets

Deleted Endpoints: None

Modified Endpoints: 158

POST /auth/signin

Description changed from 'Authenticate with email and password. Requires an anon key.

Set session_mode to cookie to request HttpOnly refresh-token
storage. Cookie mode is honored only for an exact, credentialed CORS
origin on the same schemeful site as this API. Otherwise the response
retains the refresh token in its body.
' to 'Authenticate with email and password. Requires an anon key.

Set session_mode to cookie to request HttpOnly refresh-token
storage. Cookie mode is honored only for an exact, credentialed CORS
origin on the same schemeful site as this API. Otherwise the response
retains the refresh token in its body. A frontend on its default
Volcano URL is cross-site with this API and so always gets the body
token.
'

POST /databases/{databaseName}/branches/{branchName}/query/delete

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/branches/{branchName}/query/insert

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/branches/{branchName}/query/ping

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/branches/{branchName}/query/select

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/branches/{branchName}/query/update

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/query/delete

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/query/insert

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/query/ping

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/query/select

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /databases/{databaseName}/query/update

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

POST /durable-functions/{functionId}/executions

Responses changed
- Modified response: 202
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: status
        
        Description changed from 'Lifecycle state of an execution. pending covers the window between the
        platform reserving the execution name and the function accepting the
        start, and has no counterpart once the execution is under way.
        succeeded, failed, timed_out, stopped and unknown are
        terminal.

unknown means the platform lost track of the execution's outcome: it
was never seen to finish and is no longer reported, so no result or
error can be given for it. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry under a new
name rather than a state to wait on. completed_at on an unknown
execution is when the platform gave up, not when the work ended.
' to 'Lifecycle state of an execution. pending covers the window between the
platform reserving the execution name and the function accepting the
start, and has no counterpart once the execution is under way.
succeeded, failed, timed_out, stopped and unknown are
terminal.

unknown means the execution's outcome cannot be established, so no
result or error can be given for it. Either it was under way and was
never seen to finish, or its start failed with a 500 without the
platform establishing whether the execution began — which is why a
name whose start returned an error can later read as unknown rather
than not being found. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry rather than a
state to wait on. A retry under the same name picks this execution back
up instead of starting a second one, and needs a free concurrency slot
because an unknown execution has given its own up. completed_at on
an unknown execution is when the platform gave up, not when the work
ended.
'

Modified response: 503
- Description changed from 'Durable execution is not available in this environment, or the
  usage limit service could not be reached to charge the start. The
  first is returned by a deployment that has no durable execution
  engine, such as a local one, and is not retryable there; the second
  is transient.
  ' to 'Durable execution is not available in this environment, or the
  plan terms for the start could not be read. The first means the
  capability is paused or this deployment cannot serve it, so it is
  not one to retry in a loop; the second is transient.
  '

GET /functions/resolve

Description changed from 'Resolves a DNS-safe function name to its function ID within the caller's project.

SDKs use this endpoint internally to invoke by function name while routing by function ID.

With Service Key:

Allowed

With Auth User Token:

Allowed

With Anon Key:

Requires anon key permission: functions.invoke
Function must have is_public: true
' to 'Resolves a DNS-safe function name to its function ID and invocation URL within the caller's project.

SDKs use this endpoint internally to invoke by function name while routing by function ID.
Invoke the returned invoke_url as-is. It does not share a domain with the API, so a host
built from the API URL will not reach the function. When the deployment serves no public
invocation domain, as in local development, invoke_url is omitted and callers invoke
through POST /functions/{functionId}/invoke.

With Service Key:

Allowed

With Auth User Token:

Allowed

With Anon Key:

Requires anon key permission: functions.invoke
Function must have is_public: true
'
Responses changed
- Modified response: 200
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        New property: invoke_url

POST /functions/{functionId}/invoke

Description changed from 'Invoke a serverless function.

With Service Key (admin/background operations):

Use for background jobs, webhooks, cron, admin operations
Function receives payload only (no user context)
Database queries bypass RLS (admin access)

With Auth User Token (user-facing):

Use for user-initiated actions

Function receives payload + __volcano_auth context:

{
  user_id: "uuid",
  email: "user@example.com",
  project_id: "uuid",
  role: "authenticated" or "anonymous"
}

Database queries enforce RLS (user-scoped data)

With Anon Key (public function only):

Requires anon key permission: functions.invoke
Function must have is_public: true
Function receives payload only (no __volcano_auth)

Transport and CORS:

This operation is the authenticated direct RPC endpoint and always uses the
POST {payload: ...} contract, including for functions whose DNS ingress is
configured in HTTP mode.
The geo-routed DNS ingress is https://{functionId}.functions.<domain>/.
RPC-mode DNS ingress accepts POST at /. HTTP-mode DNS ingress accepts GET,
HEAD, POST, PUT, PATCH, and DELETE at / and nested paths.
Direct and RPC-mode CORS preflight advertises POST, OPTIONS. HTTP-mode DNS
preflight advertises GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS.
http_auth_mode: none applies only to public HTTP-mode DNS ingress; this
direct operation always requires a Volcano credential.

Durable functions are not invocable here. A durable function's id
answers 404, whatever its visibility, because a synchronous call would
run it with no execution record, no idempotency and no concurrency
accounting. Start one with
POST /durable-functions/{functionId}/executions.
' to 'Invoke a function.

With Service Key (admin/background operations):

Use for background jobs, webhooks, cron, admin operations
Function receives payload only (no user context)
Database queries bypass RLS (admin access)

With Auth User Token (user-facing):

Use for user-initiated actions

Function receives payload + __volcano_auth context:

{
  user_id: "uuid",
  email: "user@example.com",
  project_id: "uuid",
  role: "authenticated" or "anonymous"
}

Database queries enforce RLS (user-scoped data)

With Anon Key (public function only):

Requires anon key permission: functions.invoke
Function must have is_public: true
Function receives payload only (no __volcano_auth)

Transport and CORS:

This operation is the authenticated direct RPC endpoint and always uses the
POST {payload: ...} contract, including for functions whose DNS ingress is
configured in HTTP mode.
The geo-routed DNS ingress is the function's invoke_url. It is on a
different domain from this API, so it cannot be derived from the API host.
RPC-mode DNS ingress accepts POST at /. HTTP-mode DNS ingress accepts GET,
HEAD, POST, PUT, PATCH, and DELETE at / and nested paths.
Direct and RPC-mode CORS preflight advertises POST, OPTIONS. HTTP-mode DNS
preflight advertises GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS.
http_auth_mode: none applies only to public HTTP-mode DNS ingress; this
direct operation always requires a Volcano credential.

Durable functions are not invocable here. A durable function's id
answers 404, whatever its visibility, because a synchronous call would
run it with no execution record, no idempotency and no concurrency
accounting. Start one with
POST /durable-functions/{functionId}/executions.
'

Responses changed
- Modified response: 200
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms
- Modified response: default
  - Headers changed
    - New header: x-volcano-compute-ms
    - New header: x-volcano-proxy-handler-ms
    - New header: x-volcano-proxy-ms

DELETE /projects/{id}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}

Security changed
- New security requirements: ProjectAccessToken

PATCH /projects/{id}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/anon-keys

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/anon-keys

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/anon-keys/{keyId}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/anon-keys/{keyId}

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/anon-keys/{keyId}/regenerate

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/anon-keys/{keyId}/set-default

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/config

Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/auth/config

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/auth/config/test-email

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/hosted-pages/{pageType}

Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/auth/hosted-pages/{pageType}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/insights

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/methods

Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/auth/methods

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/pages/appearance

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/auth/pages/theme

Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/auth/pages/theme

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/auth/pages/{pageType}/layout

Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/auth/pages/{pageType}/layout

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/auth/pages/{pageType}/preview

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/users

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/auth/users/{userId}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/users/{userId}

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/auth/users/{userId}/ban

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/auth/users/{userId}/sessions

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/auth/users/{userId}/sessions

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/auth/users/{userId}/sessions/{sessionId}

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/auth/users/{userId}/unban

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/config

Description changed from 'Exports the project's current user-facing configuration as a
declarative manifest. Returns JSON by default. Request the canonical
volcano-config.yaml rendering with Accept: application/yaml or
?format=yaml; the YAML is returned verbatim as the raw response body
(Content-Type: application/yaml) and is meant to be saved as-is.
Variable values and write-only secrets (SMTP password, OAuth client secrets, TLS material)
are omitted from the export; shared_variables contains names only; the YAML rendering adds a header comment
describing how to set them via CLI environment interpolation.
' to 'Exports the project's current user-facing configuration as a
declarative manifest. Returns JSON by default. Request the canonical
volcano-config.yaml rendering with Accept: application/yaml or
?format=yaml; the YAML is returned verbatim as the raw response body
(Content-Type: application/yaml) and is meant to be saved as-is.
Variable values and write-only secrets (SMTP password, OAuth client secrets, TLS material)
are omitted from the export; shared_variables and frontend_shared_variables contain names only; the YAML rendering adds a header comment
describing how to set them via CLI environment interpolation.
'
Responses changed
- Modified response: 200
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        New property: frontend_shared_variables
        
        Modified property: frontends
        
        Items changed
        
        Properties changed
        
        New property: function_routes
        
        New property: variable_scope
        
        New property: variables
        
        Modified property: functions
        
        Items changed
        
        Properties changed
        
        Modified property: variable_scope
        Extensions changed
        New extension: x-enum-varnames
        
        Modified property: variables
        
        Items changed
        
        Properties changed
        
        Modified property: name
        Description changed from '' to 'Project variable name. Function runtime names such as AWS_REGION are reserved and fail validation; see the environment variables guide for the full list.'
Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/config

Request body changed
- Content changed
  - Modified media type: application/json
    - Schema changed
      - Properties changed
        
        New property: frontend_shared_variables
        
        Modified property: frontends
        
        Items changed
        
        Properties changed
        
        New property: function_routes
        
        New property: variable_scope
        
        New property: variables
        
        Modified property: functions
        
        Items changed
        
        Properties changed
        
        Modified property: variable_scope
        
        Extensions changed
        New extension: x-enum-varnames
        
        Modified property: variables
        
        Items changed
        
        Properties changed
        
        Modified property: name
        
        Description changed from '' to 'Project variable name. Function runtime names such as AWS_REGION are reserved and fail validation; see the environment variables guide for the full list.'
Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/databases

Summary changed from 'Create a new serverless PostgreSQL database' to 'Create a new PostgreSQL database'
Description changed from 'Creates a serverless PostgreSQL database in the project.
Each project can hold 1 database on Free and up to 10,000 on Pro.
Requests over the plan's cap return 403.
' to 'Creates a PostgreSQL database in the project.
Each project can hold 1 database on Free and up to 10,000 on Pro.
Requests over the plan's cap return 403.
'
Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/databases/{databaseName}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/backup-schedule

Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/databases/{databaseName}/backup-schedule

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/backups

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/databases/{databaseName}/backups

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/databases/{databaseName}/backups/{backupName}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/backups/{backupName}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/branches

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/databases/{databaseName}/branches

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/databases/{databaseName}/branches/{branchName}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/branches/{branchName}

Security changed
- New security requirements: ProjectAccessToken

PATCH /projects/{id}/databases/{databaseName}/branches/{branchName}

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/databases/{databaseName}/branches/{branchName}/reset

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/databases/{databaseName}/branches/{branchName}/reset-password

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/queries

Description changed from 'Returns the database's current top queries from pg_stat_statements
ranked by total execution time.

PRO plan required. This endpoint is only available to projects owned
by users on the PRO billing plan.
' to 'Returns the database's current top queries from pg_stat_statements
ranked by total execution time. Only data statements (SELECT, INSERT,
UPDATE, DELETE, MERGE) are listed; statements Volcano runs to operate
the database are left out.

PRO plan required. This endpoint is only available to projects owned
by users on the PRO billing plan.
'

Responses changed
- Modified response: 200
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: data
        
        Items changed
        
        Properties changed
        
        Modified property: query
        Description changed from 'Normalized and obfuscated representative query text.' to 'Normalized representative query text with literal values replaced by ?.'
        
        Modified property: role
        Description changed from 'Database role used for the query.' to 'Postgres role that ran the query, such as anon or authenticated for RLS-enforced connections, service_role, the database owner role for full-access connections, or a role you created. unknown when the role no longer exists.'
Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/databases/{databaseName}/reset-password

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/restores

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/databases/{databaseName}/restores

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/restores/{restoreId}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/databases/{databaseName}/stats

Security changed
- New security requirements: ProjectAccessToken

PATCH /projects/{id}/databases/{databaseName}/type

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/deployments

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/deployments/summary

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/domains

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/durable-functions

Request body changed
- Content changed
  - Modified media type: multipart/form-data
    - Schema changed
      - Properties changed
        
        Modified property: variable_scope
        
        Extensions changed
        
        New extension: x-enum-varnames

DELETE /projects/{id}/durable-functions/{functionId}

Description changed from 'Accepted for asynchronous teardown; the work continues after the
response. The function's executions go with it: history stops being
readable whatever retention_days had left, and the executions still
running stop counting against the project's concurrency cap. Stop an
execution first if you need it to end before the function does.
' to 'Accepted for asynchronous teardown; the work continues after the
response. The function's executions go with it: executions still in
flight are stopped, and history stops being readable whatever
retention_days had left.

Stopping is asynchronous at the platform, and it does not interrupt a
step already running -- that step runs to its next checkpoint. So a
delete ends an execution rather than halting it mid-step; stop the
execution yourself first if you need to observe it ending.
'

GET /projects/{id}/durable-functions/{functionId}/executions

Modified query param: status
- Schema changed
  - Description changed from 'Lifecycle state of an execution. pending covers the window between the
    platform reserving the execution name and the function accepting the
    start, and has no counterpart once the execution is under way.
    succeeded, failed, timed_out, stopped and unknown are
    terminal.

unknown means the platform lost track of the execution's outcome: it
was never seen to finish and is no longer reported, so no result or
error can be given for it. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry under a new
name rather than a state to wait on. completed_at on an unknown
execution is when the platform gave up, not when the work ended.
' to 'Lifecycle state of an execution. pending covers the window between the
platform reserving the execution name and the function accepting the
start, and has no counterpart once the execution is under way.
succeeded, failed, timed_out, stopped and unknown are
terminal.

unknown means the execution's outcome cannot be established, so no
result or error can be given for it. Either it was under way and was
never seen to finish, or its start failed with a 500 without the
platform establishing whether the execution began — which is why a
name whose start returned an error can later read as unknown rather
than not being found. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry rather than a
state to wait on. A retry under the same name picks this execution back
up instead of starting a second one, and needs a free concurrency slot
because an unknown execution has given its own up. completed_at on
an unknown execution is when the platform gave up, not when the work
ended.
'

Responses changed
- Modified response: 200
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: data
        
        Items changed
        
        Properties changed
        
        Modified property: status
        Description changed from 'Lifecycle state of an execution. pending covers the window between the
        platform reserving the execution name and the function accepting the
        start, and has no counterpart once the execution is under way.
        succeeded, failed, timed_out, stopped and unknown are
        terminal.

unknown means the platform lost track of the execution's outcome: it
was never seen to finish and is no longer reported, so no result or
error can be given for it. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry under a new
name rather than a state to wait on. completed_at on an unknown
execution is when the platform gave up, not when the work ended.
' to 'Lifecycle state of an execution. pending covers the window between the
platform reserving the execution name and the function accepting the
start, and has no counterpart once the execution is under way.
succeeded, failed, timed_out, stopped and unknown are
terminal.

unknown means the execution's outcome cannot be established, so no
result or error can be given for it. Either it was under way and was
never seen to finish, or its start failed with a 500 without the
platform establishing whether the execution began — which is why a
name whose start returned an error can later read as unknown rather
than not being found. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry rather than a
state to wait on. A retry under the same name picks this execution back
up instead of starting a second one, and needs a free concurrency slot
because an unknown execution has given its own up. completed_at on
an unknown execution is when the platform gave up, not when the work
ended.
'

POST /projects/{id}/durable-functions/{functionId}/executions

Responses changed
- Modified response: 202
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: status
        
        Description changed from 'Lifecycle state of an execution. pending covers the window between the
        platform reserving the execution name and the function accepting the
        start, and has no counterpart once the execution is under way.
        succeeded, failed, timed_out, stopped and unknown are
        terminal.

unknown means the platform lost track of the execution's outcome: it
was never seen to finish and is no longer reported, so no result or
error can be given for it. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry under a new
name rather than a state to wait on. completed_at on an unknown
execution is when the platform gave up, not when the work ended.
' to 'Lifecycle state of an execution. pending covers the window between the
platform reserving the execution name and the function accepting the
start, and has no counterpart once the execution is under way.
succeeded, failed, timed_out, stopped and unknown are
terminal.

unknown means the execution's outcome cannot be established, so no
result or error can be given for it. Either it was under way and was
never seen to finish, or its start failed with a 500 without the
platform establishing whether the execution began — which is why a
name whose start returned an error can later read as unknown rather
than not being found. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry rather than a
state to wait on. A retry under the same name picks this execution back
up instead of starting a second one, and needs a free concurrency slot
because an unknown execution has given its own up. completed_at on
an unknown execution is when the platform gave up, not when the work
ended.
'

Modified response: 503
- Description changed from 'Durable execution is not available in this environment, or the
  usage limit service could not be reached to charge the start. The
  first is returned by a deployment that has no durable execution
  engine, such as a local one, and is not retryable there; the second
  is transient.
  ' to 'Durable execution is not available in this environment, or the
  plan terms for the start could not be read. The first means the
  capability is paused or this deployment cannot serve it, so it is
  not one to retry in a loop; the second is transient.
  '

GET /projects/{id}/durable-functions/{functionId}/executions/{executionId}

Responses changed
- Modified response: 200
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: status
        
        Description changed from 'Lifecycle state of an execution. pending covers the window between the
        platform reserving the execution name and the function accepting the
        start, and has no counterpart once the execution is under way.
        succeeded, failed, timed_out, stopped and unknown are
        terminal.

unknown means the platform lost track of the execution's outcome: it
was never seen to finish and is no longer reported, so no result or
error can be given for it. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry under a new
name rather than a state to wait on. completed_at on an unknown
execution is when the platform gave up, not when the work ended.
' to 'Lifecycle state of an execution. pending covers the window between the
platform reserving the execution name and the function accepting the
start, and has no counterpart once the execution is under way.
succeeded, failed, timed_out, stopped and unknown are
terminal.

unknown means the execution's outcome cannot be established, so no
result or error can be given for it. Either it was under way and was
never seen to finish, or its start failed with a 500 without the
platform establishing whether the execution began — which is why a
name whose start returned an error can later read as unknown rather
than not being found. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry rather than a
state to wait on. A retry under the same name picks this execution back
up instead of starting a second one, and needs a free concurrency slot
because an unknown execution has given its own up. completed_at on
an unknown execution is when the platform gave up, not when the work
ended.
'

Modified response: 503
- Description changed from 'Durable execution is not available in this environment. Returned by
  a deployment that has no durable execution engine, such as a local
  one; the request is not retryable there.
  ' to 'Durable execution is not available in this environment. Either the
  capability is paused or this deployment cannot serve it, so the
  request is not one to retry in a loop.
  '

POST /projects/{id}/durable-functions/{functionId}/executions/{executionId}/stop

Responses changed
- Modified response: 200
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: status
        
        Description changed from 'Lifecycle state of an execution. pending covers the window between the
        platform reserving the execution name and the function accepting the
        start, and has no counterpart once the execution is under way.
        succeeded, failed, timed_out, stopped and unknown are
        terminal.

unknown means the platform lost track of the execution's outcome: it
was never seen to finish and is no longer reported, so no result or
error can be given for it. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry under a new
name rather than a state to wait on. completed_at on an unknown
execution is when the platform gave up, not when the work ended.
' to 'Lifecycle state of an execution. pending covers the window between the
platform reserving the execution name and the function accepting the
start, and has no counterpart once the execution is under way.
succeeded, failed, timed_out, stopped and unknown are
terminal.

unknown means the execution's outcome cannot be established, so no
result or error can be given for it. Either it was under way and was
never seen to finish, or its start failed with a 500 without the
platform establishing whether the execution began — which is why a
name whose start returned an error can later read as unknown rather
than not being found. It is terminal because nothing can settle it
later, and it is rare — treat it as an outcome to retry rather than a
state to wait on. A retry under the same name picks this execution back
up instead of starting a second one, and needs a free concurrency slot
because an unknown execution has given its own up. completed_at on
an unknown execution is when the platform gave up, not when the work
ended.
'

Modified response: 503
- Description changed from 'Durable execution is not available in this environment. Returned by
  a deployment that has no durable execution engine, such as a local
  one; the request is not retryable there.
  ' to 'Durable execution is not available in this environment. Either the
  capability is paused or this deployment cannot serve it, so the
  request is not one to retry in a loop.
  '

GET /projects/{id}/email-templates

Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/email-templates

Security changed
- New security requirements: ProjectAccessToken

DELETE /projects/{id}/email-templates/{type}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/email-templates/{type}

Security changed
- New security requirements: ProjectAccessToken

PUT /projects/{id}/email-templates/{type}

Security changed
- New security requirements: ProjectAccessToken

GET /projects/{id}/frontends

Responses changed
- Modified response: 200
  - Content changed
    - Modified media type: application/json
      - Schema changed
        
        Properties changed
        
        Modified property: data
        
        Items changed
        
        Properties changed
        
        New property: declared_variables
        
        New property: variable_scope
Security changed
- New security requirements: ProjectAccessToken

POST /projects/{id}/frontends

Description changed from 'Creates and deploys a frontend for the project.
If a frontend with the same name already exists in the project, this operation updates that
frontend using the uploaded archive and starts a new deployment. A deployment that starts
immediately returns status: provisioning, then transitions to active, degraded, or
failed. If another deployment is running, the response preserves the frontend's current status
and exposes the queued deployment through pending_deployment_id.
Existing frontend traffic continues to use an available runtime while the new deployment builds
and provisions. Each deployment publishes its own static assets before the runtimes switch to its
build, and the live build's assets keep serving until the new deployment is live, so a page loaded
mid-deployment resolves its assets whichever build served i

Report truncated; see the source commit for the complete contract diff.

Validation

Contract generation completed in the source workflow run.
Target repository CI validates the generated result.

CLAassistant · 2026-09-10T22:01:01Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

kong Bot force-pushed the chore/sync-openapi branch 6 times, most recently from c6391e8 to ea3d391 Compare September 5, 2026 02:49

kong Bot force-pushed the chore/sync-openapi branch 2 times, most recently from 1af2768 to 09b12fe Compare September 10, 2026 22:00

kong Bot force-pushed the chore/sync-openapi branch 13 times, most recently from 574efbb to 3d26a9c Compare September 17, 2026 18:05

kong Bot force-pushed the chore/sync-openapi branch 8 times, most recently from 4f5a9fd to 3fada80 Compare September 19, 2026 06:17

kong Bot force-pushed the chore/sync-openapi branch 17 times, most recently from 38cd363 to 18f1695 Compare September 26, 2026 13:04

chore(api): sync OpenAPI contract

cb3d502

kong Bot force-pushed the chore/sync-openapi branch from 18f1695 to cb3d502 Compare September 26, 2026 23:34

Navigation Menu

chore(api): sync OpenAPI contract - #5

chore(api): sync OpenAPI contract#5
kong[bot] wants to merge 1 commit into
mainfrom
chore/sync-openapi

kong Bot commented Aug 30, 2026 •

edited

Loading

Uh oh!

CLAassistant commented Sep 10, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

kong Bot commented Aug 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

API change report

Public API

New Endpoints: 36

Deleted Endpoints: None

Modified Endpoints: 158

Validation

Uh oh!

CLAassistant commented Sep 10, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

kong Bot commented Aug 30, 2026 •

edited

Loading