{ "openapi": "3.1.1", "info": { "title": "BuildWithHQ Platform Account API", "description": "Owned SaaS app lifecycle, diagnostics and support, account/team/security settings, API clients, provisioning status, billing/storage, and marketplace/template management. Requires a verified Builder JWT session; SQL enforces CustomerAccount ownership and action permissions. Tenant organization operations belong to the separate app-scoped Developer API. Provider and worker readiness still apply to every operation.", "version": "v1" }, "servers": [ { "url": "https://api.buildwithhq.com" } ], "paths": { "/v1/platform/account/branding": { "get": { "tags": [ "BuilderBranding" ], "summary": "Returns the account brand kit and its opaque rowVersion.", "description": "Returns the account brand kit and its opaque rowVersion. Sender-domain status is read-only in this contract.", "operationId": "platformBuilderBrandingGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBrandingSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBrandingSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBrandingSettings" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "put": { "tags": [ "BuilderBranding" ], "summary": "Creates or updates account branding.", "description": "Creates or updates account branding. Omit expectedRowVersion only when kitExists is false; an existing kit requires the exact latest value.", "operationId": "platformBuilderBrandingUpdateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBrandingUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBrandingUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderBrandingUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBrandingSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBrandingSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBrandingSettings" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/account/communications": { "get": { "tags": [ "BuilderCommunicationSettings" ], "summary": "Returns account communication preferences.", "description": "Returns account communication preferences. Required security notifications cannot be disabled.", "operationId": "platformBuilderCommunicationSettingsGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "put": { "tags": [ "BuilderCommunicationSettings" ], "summary": "Creates or updates communication preferences.", "description": "Creates or updates communication preferences. Existing preferences require the exact latest rowVersion; security notifications must remain enabled.", "operationId": "platformBuilderCommunicationSettingsUpdateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderCommunicationSettings" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/account": { "get": { "tags": [ "BuilderAccountProfile" ], "summary": "Returns the account profile derived from the verified Builder session.", "description": "Returns the account profile derived from the verified Builder session. The opaque rowVersion is required for updates.", "operationId": "platformBuilderAccountProfileGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfile" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "patch": { "tags": [ "BuilderAccountProfile" ], "summary": "Updates the verified Builder account profile with an exact rowVersion fence and CanManageAccount permission.", "description": "Updates the verified Builder account profile with an exact rowVersion fence and CanManageAccount permission. A stale value returns conflict.", "operationId": "platformBuilderAccountProfileUpdateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfileUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfileUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfileUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAccountProfile" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/api-clients": { "get": { "tags": [ "BuilderApiClients" ], "summary": "Lists API-client metadata and the current supported scope catalog for the owned app.", "description": "Lists API-client metadata and the current supported scope catalog for the owned app. Secret material is never returned.", "operationId": "platformBuilderApiClientsListAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderApiClientsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderApiClientsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderApiClientsResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderApiClients" ], "summary": "Creates an API client for the owned active app.", "description": "Creates an API client for the owned active app. The credential is returned exactly once. Do not log it; persist it in a secret manager before discarding the response.", "operationId": "platformBuilderApiClientsCreateAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderCreateApiClientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderCreateApiClientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderCreateApiClientRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "minLength": 1, "type": "string", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ false ] } } } }, "application/json": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "minLength": 1, "type": "string", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ false ] } } } }, "text/json": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "minLength": 1, "type": "string", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ false ] } } } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "type": "null", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ true ] } } } }, "application/json": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "type": "null", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ true ] } } } }, "text/json": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "type": "null", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ true ] } } } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/api-clients/{apiClientId}/rotate": { "post": { "tags": [ "BuilderApiClients" ], "summary": "Rotates one active API-client secret for the owned app and returns the replacement credential exactly once.", "description": "Rotates one active API-client secret for the owned app and returns the replacement credential exactly once. The prior credential stops working. An ambiguous response requires another deliberate rotation.", "operationId": "platformBuilderApiClientsRotateAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "apiClientId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "minLength": 1, "type": "string", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ false ] } } } }, "application/json": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "minLength": 1, "type": "string", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ false ] } } } }, "text/json": { "schema": { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "minLength": 1, "type": "string", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ false ] } } } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/api-clients/{apiClientId}/revoke": { "post": { "tags": [ "BuilderApiClients" ], "summary": "Revokes one API client owned by the app and invalidates its credential.", "description": "Revokes one API client owned by the app and invalidates its credential. Repeating after success returns conflict; reconcile with the client list first.", "operationId": "platformBuilderApiClientsRevokeAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "apiClientId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/api-clients/{apiClientId}/principal": { "put": { "tags": [ "BuilderApiClients" ], "summary": "Binds an active API client to an active tenant account/user pair only after the server resolves the owned app's tenant database and verifies both records there.", "description": "Binds an active API client to an active tenant account/user pair only after the server resolves the owned app's tenant database and verifies both records there. Client-supplied IDs are query targets, not authorization proof.", "operationId": "platformBuilderApiClientsBindPrincipalAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "apiClientId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBindApiClientPrincipalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBindApiClientPrincipalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderBindApiClientPrincipalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperApiClientSummary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperApiClientSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperApiClientSummary" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/analytics": { "get": { "tags": [ "BuilderAppObservability" ], "summary": "Returns a bounded usage snapshot for the owned app.", "description": "Returns a bounded usage snapshot for the owned app. The server derives the Builder account from the verified session and rejects a foreign app identifier.", "operationId": "platformBuilderAppObservabilityGetAnalyticsAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "months", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 6 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppAnalyticsSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppAnalyticsSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppAnalyticsSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/logs": { "get": { "tags": [ "BuilderAppObservability" ], "summary": "Returns a bounded, cursor-based merge of safe control-plane and tenant-runtime log summaries for the owned app.", "description": "Returns a bounded, cursor-based merge of safe control-plane and tenant-runtime log summaries for the owned app. The maximum lookback is 31 days and private payloads are not returned.", "operationId": "platformBuilderAppObservabilityGetLogsAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sinceUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "logCorrelationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "controlBeforeUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "controlBeforeSourceRank", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "uint8" } }, { "name": "controlBeforeSourceRecordId", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, { "name": "runtimeBeforeUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "runtimeCursorHash", "in": "query", "schema": { "type": "string" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "controlExhausted", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "runtimeExhausted", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppLogsPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppLogsPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppLogsPage" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/unattributed-login-failures": { "get": { "tags": [ "BuilderAppObservability" ], "summary": "Lists only unassigned, unsuccessful sign-in attempts for an owned app after verifying Builder log-read authority and the routed Logs database identity.", "description": "Lists only unassigned, unsuccessful sign-in attempts for an owned app after verifying Builder log-read authority and the routed Logs database identity. Returns bounded outcome, UTC timestamp and observed network metadata without submitted email or username. Continue with the exact nextBeforeLoginAuditLogId cursor; this read does not create attempts or change security state.", "operationId": "platformBuilderAppObservabilityGetUnattributedLoginFailuresAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "beforeLoginAuditLogId", "in": "query", "schema": { "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, { "name": "top", "in": "query", "schema": { "maximum": 100, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppUnattributedLoginFailuresPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppUnattributedLoginFailuresPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppUnattributedLoginFailuresPage" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/failures": { "get": { "tags": [ "BuilderAppObservability" ], "summary": "Returns a bounded, cursor-based list of developer failure summaries for the owned app.", "description": "Returns a bounded, cursor-based list of developer failure summaries for the owned app. Failure details are safe diagnostic metadata and correlation references rather than customer payloads.", "operationId": "platformBuilderAppObservabilityGetFailuresAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sinceUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "severity", "in": "query", "schema": { "type": "string" } }, { "name": "failureCode", "in": "query", "schema": { "type": "string" } }, { "name": "beforeLastSeenUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "beforeProblemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppFailuresPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppFailuresPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppFailuresPage" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/failures/{problemId}/closed": { "patch": { "tags": [ "BuilderAppObservability" ], "summary": "Closes or reopens one owned-app failure with an exact rowVersion fence.", "description": "Closes or reopens one owned-app failure with an exact rowVersion fence. A stale failure returns conflict; refresh the failure list before retrying.", "operationId": "platformBuilderAppObservabilitySetFailureClosedAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "problemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppFailureClosedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppFailureClosedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderAppFailureClosedRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppFailureClosedReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppFailureClosedReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppFailureClosedReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps": { "get": { "tags": [ "BuilderApps" ], "summary": "Lists SaaS apps owned by the verified Builder account.", "description": "Lists SaaS apps owned by the verified Builder account. includeDeleted is an explicit query target and never broadens account scope.", "operationId": "platformBuilderAppsListAsync", "parameters": [ { "name": "includeDeleted", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppsResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderApps" ], "summary": "Creates one SaaS app for the verified Builder account and enqueues the existing fenced provisioning job.", "description": "Creates one SaaS app for the verified Builder account and enqueues the existing fenced provisioning job. The body uses an exact template version when supplied. Do not automatically retry an ambiguous create response; reconcile with the app list and provisioning status first.", "operationId": "platformBuilderAppsCreateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderCreateAppRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderCreateAppRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderCreateAppRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/starter-templates": { "get": { "tags": [ "BuilderApps" ], "summary": "Apps List Starter Templates.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderAppsListStarterTemplatesAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderStarterTemplatesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderStarterTemplatesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderStarterTemplatesResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}": { "get": { "tags": [ "BuilderApps" ], "summary": "Returns the owned SaaS app's administrative detail after the server verifies Builder account membership and app ownership.", "description": "Returns the owned SaaS app's administrative detail after the server verifies Builder account membership and app ownership.", "operationId": "platformBuilderAppsGetAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppDetail" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/provisioning": { "get": { "tags": [ "BuilderApps" ], "summary": "Returns the current owned-app provisioning job, retry schedule, terminal state, progress version, and ordered step statuses.", "description": "Returns the current owned-app provisioning job, retry schedule, terminal state, progress version, and ordered step statuses. This read does not advance the job.", "operationId": "platformBuilderAppsGetProvisioningAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderProvisioningProgress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderProvisioningProgress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderProvisioningProgress" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/suspend": { "post": { "tags": [ "BuilderApps" ], "summary": "Suspends an owned active app through the existing audited lifecycle procedure.", "description": "Suspends an owned active app through the existing audited lifecycle procedure. Repeating the operation against an already suspended app is safe.", "operationId": "platformBuilderAppsSuspendAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/resume": { "post": { "tags": [ "BuilderApps" ], "summary": "Resumes an owned suspended app only when active routing and a domain are present.", "description": "Resumes an owned suspended app only when active routing and a domain are present. Repeating the operation against an already active app is safe.", "operationId": "platformBuilderAppsResumeAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAppResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/audit": { "get": { "tags": [ "BuilderAudit" ], "summary": "Searches the verified Builder account's bounded audit history.", "description": "Searches the verified Builder account's bounded audit history. Query filters never broaden account scope.", "operationId": "platformBuilderAuditSearchAsync", "parameters": [ { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "actionCode", "in": "query", "schema": { "type": "string" } }, { "name": "beforeAuditId", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderAuditPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAuditPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAuditPage" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/backups": { "get": { "tags": [ "BuilderBackups" ], "summary": "Lists the 50 most recent backup records for the owned app, including asynchronous status.", "description": "Lists the 50 most recent backup records for the owned app, including asynchronous status.", "operationId": "platformBuilderBackupsListBackupsAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBackupsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBackupsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBackupsResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderBackups" ], "summary": "Queues a manual backup for the owned app after validating an optional enabled destination.", "description": "Queues a manual backup for the owned app after validating an optional enabled destination. A successful response is a Pending record, not proof that provider storage completed. Do not automatically retry an ambiguous request; list backups and reconcile first.", "operationId": "platformBuilderBackupsRequestBackupAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderRequestBackupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderRequestBackupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderRequestBackupRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBackup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBackup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBackup" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/database-upgrade": { "get": { "tags": [ "BuilderBackups" ], "summary": "Returns the owned app's current and target database release state plus the reviewed migration inventory.", "description": "Returns the owned app's current and target database release state plus the reviewed migration inventory. Blocked or manual-review inventory entries mean the upgrade is not ready.", "operationId": "platformBuilderBackupsGetDatabaseUpgradeAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderDatabaseUpgradeState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderDatabaseUpgradeState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderDatabaseUpgradeState" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderBackups" ], "summary": "Queues the reviewed database upgrade state machine for the owned app.", "description": "Queues the reviewed database upgrade state machine for the owned app. The worker revalidates ownership and database markers, takes and verifies required backups, and never overwrites an unrelated database. Reconcile status before retrying an ambiguous request.", "operationId": "platformBuilderBackupsRequestDatabaseUpgradeAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderDatabaseUpgradeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderDatabaseUpgradeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderDatabaseUpgradeRequest" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/backup-destinations": { "get": { "tags": [ "BuilderBackups" ], "summary": "Lists S3 backup destinations for the owned app.", "description": "Lists S3 backup destinations for the owned app. Provider credentials remain server-side; returned role and external identifiers are configuration references, not secrets.", "operationId": "platformBuilderBackupsListDestinationsAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBackupDestinationsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBackupDestinationsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBackupDestinationsResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderBackups" ], "summary": "Creates or updates an owned app's S3 backup destination.", "description": "Creates or updates an owned app's S3 backup destination. Supplying backupDestinationId updates only a destination already owned by this app. Reconcile an ambiguous response by listing destinations before retrying. Saving configuration does not prove provider access.", "operationId": "platformBuilderBackupsSaveDestinationAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderSaveBackupDestinationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderSaveBackupDestinationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderSaveBackupDestinationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBackupDestination" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBackupDestination" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBackupDestination" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/catalog": { "get": { "tags": [ "BuilderBillingCatalog" ], "summary": "Billing Catalog Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderBillingCatalogGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingCatalogSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingCatalogSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingCatalogSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/customer": { "post": { "tags": [ "BuilderBillingCustomer" ], "summary": "Billing Customer Ensure Mapped.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderBillingCustomerEnsureMappedAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingCustomerMappingReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingCustomerMappingReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingCustomerMappingReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/history": { "get": { "tags": [ "BuilderBillingHistory" ], "summary": "Billing History Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderBillingHistoryGetAsync", "parameters": [ { "name": "invoiceLimit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "paymentLimit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingHistorySnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingHistorySnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingHistorySnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/resources": { "get": { "tags": [ "BuilderBillingResources" ], "summary": "Billing Resources Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderBillingResourcesGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBillingResourcesSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBillingResourcesSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBillingResourcesSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/organizations/{appAccountId}/buildspec/sessions": { "post": { "tags": [ "BuilderBuildSpec" ], "summary": "Starts a durable BuildSpec session for one active organization inside an owned SaaS app.", "description": "Starts a durable BuildSpec session for one active organization inside an owned SaaS app. App and organization IDs select the target; the server revalidates the Builder owner, owned route and tenant account before persistence. This operation pins the active schema and does not invoke an external AI provider.", "operationId": "platformBuilderBuildSpecStartAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecStartRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecStartRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecStartRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/organizations/{appAccountId}/buildspec/sessions/{sessionId}": { "get": { "tags": [ "BuilderBuildSpec" ], "summary": "Returns the exact durable BuildSpec session owned by the selected active organization after server-side Builder, app and account verification.", "description": "Returns the exact durable BuildSpec session owned by the selected active organization after server-side Builder, app and account verification.", "operationId": "platformBuilderBuildSpecGetAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/organizations/{appAccountId}/buildspec/sessions/{sessionId}/requirements": { "post": { "tags": [ "BuilderBuildSpec" ], "summary": "Records bounded source requirement text in the owned BuildSpec session.", "description": "Records bounded source requirement text in the owned BuildSpec session. The public workflow does not accept client-authored structured slot fills and does not claim external model extraction; validation reports the resulting deterministic gaps.", "operationId": "platformBuilderBuildSpecRecordRequirementAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecRequirementRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecRequirementRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecRequirementRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/organizations/{appAccountId}/buildspec/sessions/{sessionId}/validation": { "post": { "tags": [ "BuilderBuildSpec" ], "summary": "Runs the current deterministic validator against the exact schema version pinned to the owned BuildSpec session.", "description": "Runs the current deterministic validator against the exact schema version pinned to the owned BuildSpec session. Validation does not queue materialization when required fields remain incomplete.", "operationId": "platformBuilderBuildSpecValidateAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecSessionResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/organizations/{appAccountId}/buildspec/sessions/{sessionId}/progress": { "get": { "tags": [ "BuilderBuildSpec" ], "summary": "Returns bounded durable BuildSpec status, job steps, retries, safe failure codes, completion artifacts and any pending human review for the owned organization.", "description": "Returns bounded durable BuildSpec status, job steps, retries, safe failure codes, completion artifacts and any pending human review for the owned organization. It does not expose database targets, raw worker errors or blueprint snapshots.", "operationId": "platformBuilderBuildSpecGetProgressAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecProgressResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecProgressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecProgressResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/organizations/{appAccountId}/buildspec/sessions/{sessionId}/reviews/{reviewId}/decision": { "post": { "tags": [ "BuilderBuildSpec" ], "summary": "Approves or rejects one pending BuildSpec change review as the verified Builder account owner.", "description": "Approves or rejects one pending BuildSpec change review as the verified Builder account owner. Approval requeues only the parked job's exact plan fingerprint; rejection fails that job. A stale or conflicting transition returns conflict.", "operationId": "platformBuilderBuildSpecDecideReviewAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reviewId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReviewDecisionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReviewDecisionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReviewDecisionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReviewResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/organizations/{appAccountId}/buildspec/sessions/{sessionId}/reuse-candidates": { "post": { "tags": [ "BuilderBuildSpec" ], "summary": "Creates an idempotent unpublished template reuse candidate from the owned session's approved completed build.", "description": "Creates an idempotent unpublished template reuse candidate from the owned session's approved completed build. This does not publish marketplace content; the existing owner review and immutable publication lifecycle still apply.", "operationId": "platformBuilderBuildSpecCreateReuseCandidateAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateResponse" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidateResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/cost-telemetry": { "get": { "tags": [ "BuilderCostTelemetry" ], "summary": "Cost Telemetry Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderCostTelemetryGetAsync", "parameters": [ { "name": "periodStartUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderCostTelemetrySnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderCostTelemetrySnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderCostTelemetrySnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/domains": { "get": { "tags": [ "BuilderDomains" ], "summary": "Lists domains for the owned app with opaque rowVersion values used for primary-domain concurrency.", "description": "Lists domains for the owned app with opaque rowVersion values used for primary-domain concurrency.", "operationId": "platformBuilderDomainsListAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderDomainsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderDomainsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderDomainsResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderDomains" ], "summary": "Adds a normalized hostname to the owned app and attempts provider setup when configured.", "description": "Adds a normalized hostname to the owned app and attempts provider setup when configured. A Pending domain or missing verification value is not provider verification. Reconcile the domain list before retrying an ambiguous request.", "operationId": "platformBuilderDomainsAddAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderAddDomainRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderAddDomainRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderAddDomainRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderDomainMutationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderDomainMutationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderDomainMutationResult" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/domains/{saasAppDomainId}/verify": { "post": { "tags": [ "BuilderDomains" ], "summary": "Rechecks the provider state for one domain already owned by this app and records only provider-derived hostname and TLS status.", "description": "Rechecks the provider state for one domain already owned by this app and records only provider-derived hostname and TLS status. Provider-unavailable responses are retryable; Pending is not verified.", "operationId": "platformBuilderDomainsVerifyAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppDomainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderDomainMutationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderDomainMutationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderDomainMutationResult" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/domains/{saasAppDomainId}/primary": { "post": { "tags": [ "BuilderDomains" ], "summary": "Makes one verified owned domain primary using its opaque rowVersion concurrency value.", "description": "Makes one verified owned domain primary using its opaque rowVersion concurrency value. A stale value returns conflict; refresh the domain list before retrying.", "operationId": "platformBuilderDomainsSetPrimaryAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppDomainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderSetPrimaryDomainRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderSetPrimaryDomainRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderSetPrimaryDomainRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderDomain" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderDomain" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderDomain" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/domains/{saasAppDomainId}": { "delete": { "tags": [ "BuilderDomains" ], "summary": "Removes one non-primary domain from the owned app before best-effort provider cleanup.", "description": "Removes one non-primary domain from the owned app before best-effort provider cleanup. The last or primary domain cannot be removed. Repeating after success returns not found.", "operationId": "platformBuilderDomainsRemoveAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppDomainId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses": { "get": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration List.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationListAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessPackEditorList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessPackEditorList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessPackEditorList" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}": { "get": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationGetAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessPackEditorSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessPackEditorSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessPackEditorSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "put": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration Save Pack.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationSavePackAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarnessPackDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessPackDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HarnessPackDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessPackSaveReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessPackSaveReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessPackSaveReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}/components/{componentKey}": { "put": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration Save Component.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationSaveComponentAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "componentKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarnessComponentDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessComponentDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HarnessComponentDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessComponentSaveReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessComponentSaveReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessComponentSaveReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}/eval-sets/{evalSetName}": { "put": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration Save Eval Set.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationSaveEvalSetAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "evalSetName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalSetDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalSetDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HarnessEvalSetDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessEvalSetSaveReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalSetSaveReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalSetSaveReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}/eval-sets/{evalSetId}/cases/{caseKey}": { "put": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration Save Eval Case.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationSaveEvalCaseAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "evalSetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "caseKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalCaseDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalCaseDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HarnessEvalCaseDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessEvalCaseSaveReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalCaseSaveReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessEvalCaseSaveReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}/versions": { "post": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration Create Version.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationCreateVersionAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarnessVersionDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessVersionDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HarnessVersionDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessVersionReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessVersionReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessVersionReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}/versions/{templateVersionId}/publish": { "post": { "tags": [ "BuilderHarnessAdministration" ], "summary": "Harness Administration Publish Version.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationPublishVersionAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessPublicationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessPublicationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessPublicationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}/evaluations": { "get": { "tags": [ "BuilderHarnessConsole" ], "summary": "Harness Console Get Evaluations.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessConsoleGetEvaluationsAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/{harnessPackKey}/versions/{templateVersionId}/evaluations": { "post": { "tags": [ "BuilderHarnessConsole" ], "summary": "Harness Console Queue Evaluation.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessConsoleQueueEvaluationAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationQueueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationQueueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationQueueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationQueueReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationQueueReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessEvaluationQueueReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/harnesses/installations": { "get": { "tags": [ "BuilderHarnessConsole" ], "summary": "Harness Console Get Installations.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderHarnessConsoleGetInstallationsAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HarnessInstallationInventorySnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HarnessInstallationInventorySnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HarnessInstallationInventorySnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin": { "get": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAdminSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAdminSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAdminSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/products": { "get": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Get Products.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationGetProductsAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedCatalog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedCatalog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedCatalog" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Create Product.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationCreateProductAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/products/{marketplaceProductId}": { "get": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Get Product.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationGetProductAsync", "parameters": [ { "name": "marketplaceProductId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedCatalog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedCatalog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedCatalog" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "patch": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Update Product Metadata.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationUpdateProductMetadataAsync", "parameters": [ { "name": "marketplaceProductId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductMetadataRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/seller": { "post": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Create Seller.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationCreateSellerAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/versions": { "post": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Create Version.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationCreateVersionAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceVersionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceVersionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceVersionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/versions/{marketplaceProductVersionId}/submit": { "post": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Submit Version.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationSubmitVersionAsync", "parameters": [ { "name": "marketplaceProductVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/offers": { "post": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Create Offer.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationCreateOfferAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOfferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOfferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceOfferRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/offers/{marketplaceOfferId}/prices": { "post": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Create Price.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationCreatePriceAsync", "parameters": [ { "name": "marketplaceOfferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplacePriceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplacePriceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplacePriceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/offers/{marketplaceOfferId}/activate": { "post": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Activate Offer.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationActivateOfferAsync", "parameters": [ { "name": "marketplaceOfferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/offers/{marketplaceOfferId}/availability": { "put": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Set Offer Availability.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationSetOfferAvailabilityAsync", "parameters": [ { "name": "marketplaceOfferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAvailabilityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAvailabilityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAvailabilityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/admin/prices/{marketplacePriceId}/availability": { "put": { "tags": [ "BuilderMarketplaceAdministration" ], "summary": "Marketplace Administration Set Price Availability.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationSetPriceAvailabilityAsync", "parameters": [ { "name": "marketplacePriceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAvailabilityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAvailabilityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceAvailabilityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/orders": { "post": { "tags": [ "BuilderMarketplaceCheckout" ], "summary": "Marketplace Checkout Create.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceCheckoutCreateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceCheckoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceCheckoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceCheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceCheckoutReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceCheckoutReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceCheckoutReceipt" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace": { "get": { "tags": [ "BuilderMarketplace" ], "summary": "Marketplace Browse.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceBrowseAsync", "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "productType", "in": "query", "schema": { "type": "string" } }, { "name": "searchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "currencyCode", "in": "query", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceProductsResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/products/{marketplaceProductId}": { "get": { "tags": [ "BuilderMarketplace" ], "summary": "Marketplace Get Product.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceGetProductAsync", "parameters": [ { "name": "marketplaceProductId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "currencyCode", "in": "query", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceProductDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceProductDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceProductDetail" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/entitlements": { "get": { "tags": [ "BuilderMarketplace" ], "summary": "Marketplace Get Entitlements.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceGetEntitlementsAsync", "parameters": [ { "name": "onlyUnassigned", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceEntitlementsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceEntitlementsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceEntitlementsResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/entitlements/versions": { "get": { "tags": [ "BuilderMarketplace" ], "summary": "Marketplace Get Entitled Versions.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceGetEntitledVersionsAsync", "parameters": [ { "name": "marketplaceEntitlementId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceEntitlementVersionCatalog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceEntitlementVersionCatalog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceEntitlementVersionCatalog" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/entitlements/{marketplaceEntitlementId}/assignment": { "put": { "tags": [ "BuilderMarketplaceEntitlementAssignment" ], "summary": "Marketplace Entitlement Assignment Assign.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceEntitlementAssignmentAssignAsync", "parameters": [ { "name": "marketplaceEntitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceEntitlementAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceEntitlementAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceEntitlementAssignmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceEntitlementAssignmentReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceEntitlementAssignmentReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceEntitlementAssignmentReceipt" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/entitlements/{marketplaceEntitlementId}/install-requests": { "post": { "tags": [ "BuilderMarketplaceInstallRequest" ], "summary": "Marketplace Install Request Request Install.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceInstallRequestRequestInstallAsync", "parameters": [ { "name": "marketplaceEntitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceInstallRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceInstallRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceInstallRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallRequestReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallRequestReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallRequestReceipt" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/entitlements/{marketplaceEntitlementId}/license-actions": { "post": { "tags": [ "BuilderMarketplaceLicense" ], "summary": "Marketplace License Request.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceLicenseRequestAsync", "parameters": [ { "name": "marketplaceEntitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/license-actions/{marketplaceAppLicenseActionId}": { "get": { "tags": [ "BuilderMarketplaceLicense" ], "summary": "Marketplace License Get Status.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceLicenseGetStatusAsync", "parameters": [ { "name": "marketplaceAppLicenseActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceLicenseActionReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/payouts": { "get": { "tags": [ "BuilderMarketplacePayout" ], "summary": "Marketplace Payout Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplacePayoutGetAsync", "parameters": [ { "name": "currencyCode", "in": "query", "schema": { "type": "string" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderMarketplacePayout" ], "summary": "Marketplace Payout Request.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplacePayoutRequestAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplacePayoutReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller": { "get": { "tags": [ "BuilderMarketplaceSeller" ], "summary": "Marketplace Seller Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "post": { "tags": [ "BuilderMarketplaceSeller" ], "summary": "Marketplace Seller Create.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerCreateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "patch": { "tags": [ "BuilderMarketplaceSeller" ], "summary": "Marketplace Seller Update.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerUpdateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/terms": { "post": { "tags": [ "BuilderMarketplaceSeller" ], "summary": "Marketplace Seller Accept Terms.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerAcceptTermsAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerTermsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerTermsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerTermsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceSellerOnboardingSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/revenue": { "get": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Marketplace Seller Workspace Get Revenue.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceGetRevenueAsync", "parameters": [ { "name": "currencyCode", "in": "query", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerRevenue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerRevenue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerRevenue" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/artifacts": { "get": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Marketplace Seller Workspace Get Artifacts.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceGetArtifactsAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/artifacts/templates": { "post": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Marketplace Seller Workspace Register Template.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceRegisterTemplateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceArtifactRegistrationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceArtifactRegistrationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceArtifactRegistrationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/artifacts/appliances": { "post": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Marketplace Seller Workspace Register Appliance.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceRegisterApplianceAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceArtifactRegistrationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceArtifactRegistrationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceArtifactRegistrationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerArtifact" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/product-versions/{versionId}": { "get": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Returns up to 100 safe marketplace diagnostic events for a product version owned by the verified seller account.", "description": "Returns up to 100 safe marketplace diagnostic events for a product version owned by the verified seller account.", "operationId": "platformBuilderMarketplaceSellerWorkspaceGetCompositionAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerComposition" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerComposition" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceSellerComposition" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/product-versions/{versionId}/components": { "post": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Marketplace Seller Workspace Add Component.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceAddComponentAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceComponentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceComponentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceComponentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/product-versions/{versionId}/components/{componentId}": { "delete": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Closes one marketplace diagnostic session for a product version owned by the verified seller account.", "description": "Closes one marketplace diagnostic session for a product version owned by the verified seller account.", "operationId": "platformBuilderMarketplaceSellerWorkspaceRemoveComponentAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "componentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/product-versions/{versionId}/bindings": { "post": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Marketplace Seller Workspace Add Binding.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceAddBindingAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceActionBindingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceActionBindingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceActionBindingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/product-versions/{versionId}/recommended": { "post": { "tags": [ "BuilderMarketplaceSellerWorkspace" ], "summary": "Marketplace Seller Workspace Set Recommended.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceSetRecommendedAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceMutationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/entitlements/{marketplaceEntitlementId}/upgrade-preview": { "get": { "tags": [ "BuilderMarketplaceUpgrade" ], "summary": "Marketplace Upgrade Preview.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceUpgradePreviewAsync", "parameters": [ { "name": "marketplaceEntitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "targetProductVersionId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceUpgradePreview" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceUpgradePreview" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceUpgradePreview" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/entitlements/{marketplaceEntitlementId}/upgrade-requests": { "post": { "tags": [ "BuilderMarketplaceUpgrade" ], "summary": "Marketplace Upgrade Apply.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceUpgradeApplyAsync", "parameters": [ { "name": "marketplaceEntitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceUpgradeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceUpgradeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderMarketplaceUpgradeRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallRequestReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallRequestReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallRequestReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/addon-checkout": { "post": { "tags": [ "BuilderPlatformAddOnCheckout" ], "summary": "Platform Add On Checkout Create.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderPlatformAddOnCheckoutCreateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformAddOnCheckoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlatformAddOnCheckoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlatformAddOnCheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/checkout": { "post": { "tags": [ "BuilderPlatformCheckout" ], "summary": "Platform Checkout Create.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderPlatformCheckoutCreateAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlatformCheckoutReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/resource-allocations": { "get": { "tags": [ "BuilderResourceAllocations" ], "summary": "Resource Allocations Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderResourceAllocationsGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationsSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationsSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationsSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/resource-allocations/{saasAppId}": { "put": { "tags": [ "BuilderResourceAllocations" ], "summary": "Resource Allocations Update.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderResourceAllocationsUpdateAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderResourceAllocationReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/runtime": { "get": { "tags": [ "BuilderRuntimeControl" ], "summary": "Returns technology-neutral workload status and safe recent-event pointers for the owned app.", "description": "Returns technology-neutral workload status and safe recent-event pointers for the owned app. restartAvailable is true only when a scoped workload can be restarted and the host provider is configured.", "operationId": "platformBuilderRuntimeControlGetAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderRuntimeSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderRuntimeSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderRuntimeSnapshot" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/runtime/restart": { "post": { "tags": [ "BuilderRuntimeControl" ], "summary": "Restarts only the workload resolved from the owned app.", "description": "Restarts only the workload resolved from the owned app. Success requires provider evidence that ownership was verified and the resulting status is Running. Reconcile runtime status before retrying an ambiguous response.", "operationId": "platformBuilderRuntimeControlRestartAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderRuntimeRestartReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderRuntimeRestartReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderRuntimeRestartReceipt" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlPlaneErrorResponse" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/security/sessions": { "get": { "tags": [ "BuilderSecurityCenter" ], "summary": "Lists the verified Builder user's active and historical sessions.", "description": "Lists the verified Builder user's active and historical sessions. Revoke a session through the existing same-origin Builder identity endpoint documented in the Developer Kit.", "operationId": "platformBuilderSecurityCenterListSessionsAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderSecuritySessionsSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderSecuritySessionsSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderSecuritySessionsSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/security/audit": { "get": { "tags": [ "BuilderSecurityCenter" ], "summary": "Returns a bounded account audit view only when the verified Builder role permits audit access.", "description": "Returns a bounded account audit view only when the verified Builder role permits audit access.", "operationId": "platformBuilderSecurityCenterListAuditAsync", "parameters": [ { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderSecurityAuditEvent" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderSecurityAuditEvent" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderSecurityAuditEvent" } } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/cancellation": { "post": { "tags": [ "BuilderSubscriptionCancellation" ], "summary": "Subscription Cancellation Request.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderSubscriptionCancellationRequestAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCancellationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCancellationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubscriptionCancellationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubscriptionCancellationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCancellationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCancellationResult" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/team": { "get": { "tags": [ "BuilderTeam" ], "summary": "Lists account-scoped Builder users, roles, and invitations.", "description": "Lists account-scoped Builder users, roles, and invitations. includeDisabled and includeClosedInvitations affect only the verified account.", "operationId": "platformBuilderTeamGetAsync", "parameters": [ { "name": "includeDisabled", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "includeClosedInvitations", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderTeamSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/team/roles": { "get": { "tags": [ "BuilderTeam" ], "summary": "Lists assignable Builder roles and their current permission flags for the verified account.", "description": "Lists assignable Builder roles and their current permission flags for the verified account. Owner transfer remains a separate identity ceremony.", "operationId": "platformBuilderTeamGetRolesAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderTeamRole" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderTeamRole" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderTeamRole" } } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/team/invitations": { "post": { "tags": [ "BuilderTeam" ], "summary": "Creates a one-time Builder invitation after CanManageUsers, subscription capacity, duplicate-email, expiry, and role checks.", "description": "Creates a one-time Builder invitation after CanManageUsers, subscription capacity, duplicate-email, expiry, and role checks. Failed delivery is compensated by revoking the invitation.", "operationId": "platformBuilderTeamInviteAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamInvitationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamInvitationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderTeamInvitationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderTeamInvitation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamInvitation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamInvitation" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/team/invitations/{invitationId}": { "delete": { "tags": [ "BuilderTeam" ], "summary": "Revokes one pending invitation owned by the verified Builder account.", "description": "Revokes one pending invitation owned by the verified Builder account. No invitation token is returned.", "operationId": "platformBuilderTeamRevokeInvitationAsync", "parameters": [ { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/team/users/{builderUserId}/role": { "patch": { "tags": [ "BuilderTeam" ], "summary": "Changes a non-owner team member's role with the exact latest rowVersion.", "description": "Changes a non-owner team member's role with the exact latest rowVersion. Ownership transfer uses the separate identity ceremony.", "operationId": "platformBuilderTeamUpdateRoleAsync", "parameters": [ { "name": "builderUserId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamRoleUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamRoleUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderTeamRoleUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/team/users/{builderUserId}/status": { "patch": { "tags": [ "BuilderTeam" ], "summary": "Activates or disables a non-owner team member with the exact latest rowVersion.", "description": "Activates or disables a non-owner team member with the exact latest rowVersion. Disabling the member revokes that user's Builder sessions.", "operationId": "platformBuilderTeamSetStatusAsync", "parameters": [ { "name": "builderUserId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamStatusUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTeamStatusUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderTeamStatusUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/admin": { "get": { "tags": [ "BuilderTemplateAdministration" ], "summary": "Template Administration List.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationListAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderTemplateAdminSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateAdminSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateAdminSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/admin/drafts": { "post": { "tags": [ "BuilderTemplateAdministration" ], "summary": "Template Administration Create Draft.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationCreateDraftAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaasBlueprintDraftReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintDraftReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintDraftReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/admin/{templatePackKey}/validate": { "post": { "tags": [ "BuilderTemplateAdministration" ], "summary": "Template Administration Validate.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationValidateAsync", "parameters": [ { "name": "templatePackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaasBlueprintValidationReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintValidationReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintValidationReport" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/admin/{templatePackKey}/publish": { "post": { "tags": [ "BuilderTemplateAdministration" ], "summary": "Template Administration Publish.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationPublishAsync", "parameters": [ { "name": "templatePackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaasBlueprintPublication" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintPublication" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintPublication" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/admin/{templatePackKey}/archive": { "post": { "tags": [ "BuilderTemplateAdministration" ], "summary": "Template Administration Archive.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationArchiveAsync", "parameters": [ { "name": "templatePackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateArchiveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateArchiveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateArchiveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SaasBlueprintArchiveReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintArchiveReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaasBlueprintArchiveReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/authoring": { "get": { "tags": [ "BuilderTemplateAuthoring" ], "summary": "Template Authoring Get Workspace.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAuthoringGetWorkspaceAsync", "parameters": [ { "name": "templateVersionId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "templateKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringWorkspace" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringWorkspace" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringWorkspace" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/authoring/drafts": { "post": { "tags": [ "BuilderTemplateAuthoring" ], "summary": "Template Authoring Create Draft.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAuthoringCreateDraftAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringDraftReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringDraftReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringDraftReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/authoring/{templateVersionId}": { "put": { "tags": [ "BuilderTemplateAuthoring" ], "summary": "Template Authoring Save Draft.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAuthoringSaveDraftAsync", "parameters": [ { "name": "templateVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringSaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringSaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringSaveReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringSaveReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringSaveReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/authoring/{templateVersionId}/validate": { "post": { "tags": [ "BuilderTemplateAuthoring" ], "summary": "Template Authoring Validate.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAuthoringValidateAsync", "parameters": [ { "name": "templateVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringValidationReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringValidationReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringValidationReport" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/templates/authoring/{templateVersionId}/publish": { "post": { "tags": [ "BuilderTemplateAuthoring" ], "summary": "Template Authoring Publish.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateAuthoringPublishAsync", "parameters": [ { "name": "templateVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringPublishReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringPublishReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateAuthoringPublishReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/apps/{saasAppId}/template-harvests": { "post": { "tags": [ "BuilderTemplateHarvest" ], "summary": "Template Harvest Harvest.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderTemplateHarvestHarvestAsync", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateHarvestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateHarvestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateHarvestRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderTemplateHarvestReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateHarvestReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderTemplateHarvestReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/billing/usage-alerts": { "get": { "tags": [ "BuilderUsageAlerts" ], "summary": "Usage Alerts Get.", "description": "Uses the existing secured platform operation. The request body is derived from its controller DTO. Account identity comes from the verified Builder session. A public route does not enable purchases, installation, or provider actions without configured readiness and permissions.", "operationId": "platformBuilderUsageAlertsGetAsync", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BuilderUsageAlertsSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuilderUsageAlertsSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuilderUsageAlertsSnapshot" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/developer-problems": { "get": { "tags": [ "DeveloperProblemIndex" ], "summary": "Lists only the SaaSDeveloper problem view for the supplied owned app.", "description": "Lists only the SaaSDeveloper problem view for the supplied owned app. The public contract rejects MarketplacePublisher and MasterOperator audiences.", "operationId": "platformBuilderDeveloperProblemsListAsync", "parameters": [ { "name": "audience", "in": "query", "required": true, "schema": { "enum": [ "SaaSDeveloper" ], "type": "string", "description": "Only SaaSDeveloper is accepted on the public Builder API." } }, { "name": "saasAppId", "in": "query", "description": "Required owned SaaS app target. It is never authorization proof.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperProblemPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperProblemPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperProblemPage" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/developer-problems/{workItemId}/transitions": { "post": { "tags": [ "DeveloperProblemIndex" ], "summary": "Transitions one SaaSDeveloper problem for the supplied owned app using its exact rowVersion.", "description": "Transitions one SaaSDeveloper problem for the supplied owned app using its exact rowVersion. Publisher and operator work queues are not reachable through this public operation.", "operationId": "platformBuilderDeveloperProblemsTransitionAsync", "parameters": [ { "name": "workItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperProblemTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperProblemTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperProblemTransitionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperProblemTransitionReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperProblemTransitionReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperProblemTransitionReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/product-versions/{versionId}/debug/sessions": { "post": { "tags": [ "PublisherDebugTimeline" ], "summary": "Starts a 15-minute diagnostic session for a marketplace product version owned by the verified seller account.", "description": "Starts a 15-minute diagnostic session for a marketplace product version owned by the verified seller account.", "operationId": "platformBuilderPublisherDebugStartAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublisherDebugSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublisherDebugSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublisherDebugSession" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } }, "/v1/platform/marketplace/seller/product-versions/{versionId}/debug/sessions/{debugSessionId}": { "get": { "tags": [ "PublisherDebugTimeline" ], "summary": "Returns up to 100 safe marketplace diagnostic events for a product version owned by the verified seller account.", "description": "Returns up to 100 safe marketplace diagnostic events for a product version owned by the verified seller account.", "operationId": "platformBuilderPublisherDebugQueryAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "debugSessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "afterCreatedUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "afterEventId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublisherDebugTimeline" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublisherDebugTimeline" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublisherDebugTimeline" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] }, "delete": { "tags": [ "PublisherDebugTimeline" ], "summary": "Closes one marketplace diagnostic session for a product version owned by the verified seller account.", "description": "Closes one marketplace diagnostic session for a product version owned by the verified seller account.", "operationId": "platformBuilderPublisherDebugCloseAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "debugSessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublisherDebugCloseReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublisherDebugCloseReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublisherDebugCloseReceipt" } } } }, "400": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "401": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "403": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "404": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "409": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "413": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "415": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "429": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "500": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "502": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." }, "503": { "description": "Safe platform error with code, error and correlationId; retry only when appropriate to the operation's idempotency contract." } }, "security": [ { "BuilderSession": [ ] } ] } } }, "components": { "schemas": { "BillingCatalogPlan": { "type": "object", "properties": { "platformPlanId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "planCode": { "type": [ "null", "string" ] }, "planName": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "basePriceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "primaryDbSizeGb": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "logFileDbSizeGb": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "aiDbSizeGb": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "containerSizeGb": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "includedSaasCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "includedBuilderUsers": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "includedAiTokensPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "BillingCatalogSnapshot": { "type": "object", "properties": { "plans": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BillingCatalogPlan" } }, "storageAddOns": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BillingCatalogStorageAddOn" } }, "checkoutReady": { "type": "boolean" }, "checkoutReadinessMessage": { "type": [ "null", "string" ] } } }, "BillingCatalogStorageAddOn": { "type": "object", "properties": { "code": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "resource": { "type": [ "null", "string" ] }, "quantityGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unitPriceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "priceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BillingCustomerMappingReceipt": { "type": "object", "properties": { "mapped": { "type": "boolean" }, "provider": { "type": [ "null", "string" ] } } }, "BillingHistoryInvoice": { "type": "object", "properties": { "platformInvoiceId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "amountDueCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "amountPaidCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "dueUtc": { "type": [ "null", "string" ], "format": "date-time" }, "paidUtc": { "type": [ "null", "string" ], "format": "date-time" }, "hostedInvoiceUrl": { "type": [ "null", "string" ] }, "invoicePdfUrl": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "periodStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "periodEndUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BillingHistoryInvoiceLine" } } } }, "BillingHistoryInvoiceLine": { "type": "object", "properties": { "lineType": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unitAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "amountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "periodStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "periodEndUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "BillingHistoryPayment": { "type": "object", "properties": { "platformPaymentId": { "type": "string", "format": "uuid" }, "platformInvoiceId": { "type": [ "null", "string" ], "format": "uuid" }, "amountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "refundedAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "paymentMethod": { "type": [ "null", "string" ] }, "paidUtc": { "type": [ "null", "string" ], "format": "date-time" }, "receiptUrl": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "refunds": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BillingHistoryRefund" } } } }, "BillingHistoryRefund": { "type": "object", "properties": { "platformRefundId": { "type": "string", "format": "uuid" }, "amountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BillingHistorySnapshot": { "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/BillingHistorySubscription" }, "invoices": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BillingHistoryInvoice" } }, "payments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BillingHistoryPayment" } } } }, "BillingHistorySubscription": { "type": "object", "properties": { "platformSubscriptionId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "providerStatus": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "currentPeriodStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "currentPeriodEndUtc": { "type": [ "null", "string" ], "format": "date-time" }, "trialEndsUtc": { "type": [ "null", "string" ], "format": "date-time" }, "cancelAtPeriodEnd": { "type": "boolean" }, "scheduledCancellationUtc": { "type": [ "null", "string" ], "format": "date-time" }, "dunningState": { "type": [ "null", "string" ] }, "graceEndsUtc": { "type": [ "null", "string" ], "format": "date-time" }, "planCode": { "type": [ "null", "string" ] }, "planName": { "type": [ "null", "string" ] }, "basePriceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "BuilderAccountProfile": { "type": "object", "properties": { "customerAccountId": { "type": "string", "format": "uuid" }, "accountName": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "primaryEmail": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] }, "rowVersion": { "type": [ "null", "string" ] } } }, "BuilderAccountProfileUpdateRequest": { "required": [ "accountName", "primaryEmail", "rowVersion" ], "type": "object", "properties": { "accountName": { "maxLength": 200, "minLength": 1, "type": "string" }, "firstName": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "lastName": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "primaryEmail": { "maxLength": 320, "minLength": 3, "type": "string" }, "phone": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "companyName": { "maxLength": 200, "minLength": 0, "type": [ "null", "string" ] }, "rowVersion": { "maxLength": 12, "minLength": 12, "pattern": "^[A-Za-z0-9+/]{11}=$", "type": "string" } } }, "BuilderAddDomainRequest": { "required": [ "hostName" ], "type": "object", "properties": { "hostName": { "maxLength": 253, "minLength": 3, "type": "string" } } }, "BuilderApiClientsResponse": { "required": [ "clients", "availableScopes" ], "type": "object", "properties": { "clients": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperApiClientSummary" } }, "availableScopes": { "type": "array", "items": { "type": "string" } } } }, "BuilderAppAnalyticsSnapshot": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "monthsBack": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "generatedUtc": { "type": "string", "format": "date-time" }, "metrics": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderAppUsageMetric" } } } }, "BuilderAppContainerStatus": { "type": "object", "properties": { "containerName": { "type": [ "null", "string" ] }, "externalDns": { "type": [ "null", "string" ] }, "port": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "cpuLimit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "memoryLimitMb": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "BuilderAppDataRoutingStatus": { "type": "object", "properties": { "routingStatus": { "type": [ "null", "string" ] }, "coreReady": { "type": "boolean" }, "logsReady": { "type": "boolean" }, "aiReady": { "type": "boolean" } } }, "BuilderAppDetail": { "type": "object", "properties": { "app": { "$ref": "#/components/schemas/BuilderAppSummary" }, "dataRouting": { "$ref": "#/components/schemas/BuilderAppDataRoutingStatus" }, "resources": { "$ref": "#/components/schemas/BuilderAppResourceStatus" }, "domains": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderAppDomainStatus" } }, "container": { "$ref": "#/components/schemas/BuilderAppContainerStatus" } } }, "BuilderAppDomainStatus": { "type": "object", "properties": { "hostName": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderAppFailureClosedReceipt": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "problemId": { "type": "string", "format": "uuid" }, "isClosed": { "type": "boolean" }, "closedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "closedOccurrenceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "rowVersion": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" } } }, "BuilderAppFailureClosedRequest": { "required": [ "expectedRowVersion" ], "type": "object", "properties": { "isClosed": { "type": "boolean" }, "expectedRowVersion": { "maxLength": 16, "minLength": 16, "pattern": "^[0-9A-Fa-f]{16}$", "type": "string" } } }, "BuilderAppFailureProblem": { "type": "object", "properties": { "problemId": { "type": "string", "format": "uuid" }, "fingerprint": { "type": [ "null", "string" ] }, "failureCode": { "type": [ "null", "string" ] }, "failureClass": { "type": [ "null", "string" ] }, "sourceService": { "type": [ "null", "string" ] }, "operation": { "type": [ "null", "string" ] }, "route": { "type": [ "null", "string" ] }, "buildVersion": { "type": [ "null", "string" ] }, "severity": { "type": [ "null", "string" ] }, "firstSeenUtc": { "type": "string", "format": "date-time" }, "lastSeenUtc": { "type": "string", "format": "date-time" }, "occurrenceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "latestCorrelationId": { "type": "string", "format": "uuid" }, "isClosed": { "type": "boolean" }, "closedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "closedOccurrenceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "rowVersion": { "type": [ "null", "string" ] } } }, "BuilderAppFailuresPage": { "required": [ "hasMore" ], "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "hasMore": { "type": "boolean" }, "nextBeforeLastSeenUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextBeforeProblemId": { "type": [ "null", "string" ], "format": "uuid" }, "problems": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderAppFailureProblem" } } } }, "BuilderAppLogCursor": { "type": "object", "properties": { "controlBeforeUtc": { "type": [ "null", "string" ], "format": "date-time" }, "controlBeforeSourceRank": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "uint8" }, "controlBeforeSourceRecordId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "runtimeBeforeUtc": { "type": [ "null", "string" ], "format": "date-time" }, "runtimeCursorHash": { "type": [ "null", "string" ] }, "controlExhausted": { "type": "boolean" }, "runtimeExhausted": { "type": "boolean" } } }, "BuilderAppLogEntry": { "type": "object", "properties": { "source": { "type": [ "null", "string" ] }, "occurredUtc": { "type": "string", "format": "date-time" }, "title": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "referenceId": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "operationId": { "type": [ "null", "string" ], "format": "uuid" }, "parentOperationId": { "type": [ "null", "string" ], "format": "uuid" }, "moduleKey": { "type": [ "null", "string" ] }, "route": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "wasSuccessful": { "type": [ "null", "boolean" ] }, "severity": { "type": [ "null", "string" ] } } }, "BuilderAppLogsPage": { "required": [ "hasMore" ], "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "logs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderAppLogEntry" } }, "hasMore": { "type": "boolean" }, "nextCursor": { "$ref": "#/components/schemas/BuilderAppLogCursor" }, "runtimeAvailable": { "type": "boolean" }, "runtimeErrorCode": { "type": [ "null", "string" ] } } }, "BuilderAppResourceAllocation": { "required": [ "isMutable", "allocatedPrimaryGb", "allocatedLogFileGb", "allocatedAiGb", "allocatedContainerGb", "usedPrimaryGb", "usedLogFileGb", "usedAiGb", "usedContainerGb" ], "type": "object", "properties": { "saasAppId": { "type": "string", "format": "uuid" }, "appName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "appPurpose": { "type": [ "null", "string" ] }, "isMutable": { "type": "boolean" }, "allocatedPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "usedPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "usedLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "usedAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "usedContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "notes": { "type": [ "null", "string" ] }, "rowVersion": { "type": [ "null", "string" ] } } }, "BuilderAppResourceStatus": { "type": "object", "properties": { "effectivePrimaryGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "effectiveLogsGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "effectiveAiGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "effectiveContainerGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedPrimaryGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedLogsGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedAiGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedContainerGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "BuilderAppResponse": { "required": [ "app" ], "type": "object", "properties": { "app": { "$ref": "#/components/schemas/BuilderAppSummary" } } }, "BuilderAppsResponse": { "required": [ "apps" ], "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderAppSummary" } } } }, "BuilderAppSummary": { "type": "object", "properties": { "saasAppId": { "type": "string", "format": "uuid" }, "appName": { "type": [ "null", "string" ] }, "slug": { "type": [ "null", "string" ] }, "primaryHostName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "deploymentType": { "type": [ "null", "string" ] }, "containerStatus": { "type": [ "null", "string" ] }, "appPurpose": { "type": [ "null", "string" ] }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "BuilderAppUnattributedLoginFailure": { "required": [ "outcome" ], "type": "object", "properties": { "loginAuditLogId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "outcome": { "enum": [ "invalid_credentials", "throttled", "dependency_failed", "account_selection_required", "host_not_resolved" ], "type": "string" }, "ipAddress": { "type": [ "null", "string" ] }, "attemptKeyHash": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "occurredUtc": { "type": "string", "format": "date-time" } } }, "BuilderAppUnattributedLoginFailuresPage": { "required": [ "hasMore", "attempts" ], "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "hasMore": { "type": "boolean" }, "nextBeforeLoginAuditLogId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderAppUnattributedLoginFailure" } } } }, "BuilderAppUsageMetric": { "type": "object", "properties": { "metricKey": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "measurementType": { "type": [ "null", "string" ] }, "aggregationMethod": { "type": [ "null", "string" ] }, "periodType": { "type": [ "null", "string" ] }, "unitCode": { "type": [ "null", "string" ] }, "unitName": { "type": [ "null", "string" ] }, "unitSymbol": { "type": [ "null", "string" ] }, "maxDecimalPlaces": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderAuditPage": { "required": [ "events", "hasMore", "nextBeforeAuditId" ], "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderSecurityAuditEvent" } }, "hasMore": { "type": "boolean" }, "nextBeforeAuditId": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } } }, "BuilderBackup": { "type": "object", "properties": { "saasAppBackupId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "backupType": { "type": [ "null", "string" ] }, "backupStatus": { "enum": [ "Pending", "Running", "Completed", "Failed", "Expired" ], "type": "string" }, "backupFileName": { "type": [ "null", "string" ] }, "backupSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "startedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "expiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "destinationProvider": { "type": [ "null", "string" ] }, "destinationBucket": { "type": [ "null", "string" ] } } }, "BuilderBackupDestination": { "type": "object", "properties": { "backupDestinationId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "provider": { "enum": [ "AWS_S3" ], "type": "string" }, "bucketName": { "type": [ "null", "string" ] }, "regionName": { "type": [ "null", "string" ] }, "s3Prefix": { "type": [ "null", "string" ] }, "roleArn": { "type": [ "null", "string" ] }, "externalId": { "type": [ "null", "string" ] }, "useObjectLock": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderBackupDestinationsResponse": { "required": [ "destinations" ], "type": "object", "properties": { "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderBackupDestination" } } } }, "BuilderBackupsResponse": { "required": [ "backups" ], "type": "object", "properties": { "backups": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderBackup" } } } }, "BuilderBillingPlan": { "required": [ "platformSubscriptionId", "status", "billingInterval", "currentPeriodStartUtc", "currentPeriodEndUtc", "trialEndsUtc", "cancelAtPeriodEnd", "planCode", "planName", "basePriceCents", "includedSaaSCount", "includedBuilderUsers", "includedAiTokensPerMonth" ], "type": "object", "properties": { "platformSubscriptionId": { "minLength": 1, "type": "string", "format": "uuid" }, "status": { "minLength": 1, "type": "string" }, "billingInterval": { "minLength": 1, "type": "string" }, "currentPeriodStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "currentPeriodEndUtc": { "type": [ "null", "string" ], "format": "date-time" }, "trialEndsUtc": { "type": [ "null", "string" ], "format": "date-time" }, "cancelAtPeriodEnd": { "type": "boolean" }, "planCode": { "minLength": 1, "type": "string" }, "planName": { "minLength": 1, "type": "string" }, "basePriceCents": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "includedSaaSCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "includedBuilderUsers": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "includedAiTokensPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } } }, "BuilderBillingResourcesSnapshot": { "required": [ "plan", "capacity" ], "type": "object", "properties": { "plan": { "$ref": "#/components/schemas/BuilderBillingPlan" }, "capacity": { "$ref": "#/components/schemas/BuilderResourceCapacity" } } }, "BuilderBindApiClientPrincipalRequest": { "required": [ "appAccountId", "userId" ], "type": "object", "properties": { "appAccountId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" } } }, "BuilderBrandingSettings": { "type": "object", "properties": { "kitExists": { "type": "boolean" }, "logoUrl": { "type": [ "null", "string" ] }, "logoDarkUrl": { "type": [ "null", "string" ] }, "faviconUrl": { "type": [ "null", "string" ] }, "designTokensJson": { "type": [ "null", "string" ] }, "basedOnThemeKey": { "type": [ "null", "string" ] }, "brandVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] }, "rowVersion": { "type": [ "null", "string" ] }, "senderDomains": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderSenderDomain" } } } }, "BuilderBrandingUpdate": { "type": "object", "properties": { "logoUrl": { "type": [ "null", "string" ] }, "logoDarkUrl": { "type": [ "null", "string" ] }, "faviconUrl": { "type": [ "null", "string" ] }, "designTokensJson": { "type": [ "null", "string" ] }, "basedOnThemeKey": { "type": [ "null", "string" ] }, "expectedRowVersion": { "maxLength": 12, "minLength": 12, "pattern": "^[A-Za-z0-9+/]{11}=$", "type": [ "null", "string" ], "description": "Required when a brand kit already exists; omit only for the first create. Read the latest value and return it unchanged." } } }, "BuilderBuildSpecMessage": { "type": "object", "properties": { "Seq": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "Role": { "type": [ "null", "string" ] }, "Content": { "type": [ "null", "string" ] }, "SlotFill": { "$ref": "#/components/schemas/JsonElement" } } }, "BuilderBuildSpecPendingReview": { "type": "object", "properties": { "BuildSpecChangeReviewId": { "type": "string", "format": "uuid" }, "PolicyVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "PlanFingerprint": { "type": [ "null", "string" ] }, "Status": { "type": [ "null", "string" ] }, "RequestedUtc": { "type": "string", "format": "date-time" }, "ReviewedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "ReviewedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "DecisionNote": { "type": [ "null", "string" ] }, "BuildPlan": { "$ref": "#/components/schemas/JsonElement" }, "Reasons": { "type": [ "null", "array" ] } } }, "BuilderBuildSpecPinnedTemplate": { "type": "object", "properties": { "TemplatePackKey": { "type": [ "null", "string" ] }, "TemplatePackVersionId": { "type": "string", "format": "uuid" }, "VersionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ArtifactSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ManifestFingerprint": { "type": [ "null", "string" ] }, "MemberSetFingerprint": { "type": [ "null", "string" ] } } }, "BuilderBuildSpecProgress": { "type": "object", "properties": { "BuildSpecSessionId": { "type": "string", "format": "uuid" }, "Status": { "type": [ "null", "string" ] }, "ProvisionedSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "UpdatedUtc": { "type": "string", "format": "date-time" }, "JobCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "JobsTruncated": { "type": "boolean" }, "Jobs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderBuildSpecProgressJob" } } } }, "BuilderBuildSpecProgressJob": { "type": "object", "properties": { "BuildSpecJobId": { "type": "string", "format": "uuid" }, "Status": { "type": [ "null", "string" ] }, "Attempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "MaxAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "RetriesUsed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "RetryScheduled": { "type": "boolean" }, "NextAttemptUtc": { "type": [ "null", "string" ], "format": "date-time" }, "CreatedUtc": { "type": "string", "format": "date-time" }, "CompletedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "FailureCode": { "type": [ "null", "string" ] }, "PinnedTemplate": { "$ref": "#/components/schemas/BuilderBuildSpecPinnedTemplate" }, "Artifact": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "ChangeReview": { "$ref": "#/components/schemas/BuilderBuildSpecPendingReview" }, "Steps": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderBuildSpecStep" } } } }, "BuilderBuildSpecProgressResponse": { "required": [ "progress" ], "type": "object", "properties": { "progress": { "$ref": "#/components/schemas/BuilderBuildSpecProgress" } } }, "BuilderBuildSpecRequirementRequest": { "required": [ "message" ], "type": "object", "properties": { "message": { "maxLength": 20000, "minLength": 1, "type": "string" } } }, "BuilderBuildSpecReuseCandidate": { "type": "object", "properties": { "buildSpecReuseCandidateId": { "type": "string", "format": "uuid" }, "templatePackId": { "type": "string", "format": "uuid" }, "templatePackKey": { "type": [ "null", "string" ] }, "featureTemplateId": { "type": "string", "format": "uuid" }, "featureTemplateKey": { "type": [ "null", "string" ] }, "ownerAccountId": { "type": "string", "format": "uuid" }, "isPublished": { "type": "boolean" }, "canUse": { "type": "boolean" }, "disposition": { "type": [ "null", "string" ] }, "provenance": { "$ref": "#/components/schemas/BuilderBuildSpecReuseProvenance" }, "completedUtc": { "type": "string", "format": "date-time" } } }, "BuilderBuildSpecReuseCandidateRequest": { "required": [ "requestId", "templatePackKey", "templatePackName" ], "type": "object", "properties": { "requestId": { "minLength": 1, "type": "string", "format": "uuid" }, "templatePackKey": { "maxLength": 92, "minLength": 3, "pattern": "^[a-z0-9_-]+$", "type": "string" }, "templatePackName": { "maxLength": 200, "minLength": 1, "type": "string" }, "category": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "description": { "maxLength": 500, "minLength": 0, "type": [ "null", "string" ] } } }, "BuilderBuildSpecReuseCandidateResponse": { "required": [ "candidate" ], "type": "object", "properties": { "candidate": { "$ref": "#/components/schemas/BuilderBuildSpecReuseCandidate" } } }, "BuilderBuildSpecReuseProvenance": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "buildSpecSessionId": { "type": "string", "format": "uuid" }, "buildSpecJobId": { "type": "string", "format": "uuid" }, "sourceSaaSAppId": { "type": "string", "format": "uuid" }, "blueprintSchemaKey": { "type": [ "null", "string" ] }, "blueprintSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "blueprintSha256": { "type": [ "null", "string" ] }, "capturedBlueprintSha256": { "type": [ "null", "string" ] }, "buildResultSha256": { "type": [ "null", "string" ] }, "sourceCompletedUtc": { "type": "string", "format": "date-time" } } }, "BuilderBuildSpecReview": { "type": "object", "properties": { "BuildSpecChangeReviewId": { "type": "string", "format": "uuid" }, "BuildSpecJobId": { "type": "string", "format": "uuid" }, "BuildSpecSessionId": { "type": "string", "format": "uuid" }, "PolicyVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "PlanFingerprint": { "type": [ "null", "string" ] }, "Status": { "type": [ "null", "string" ] }, "ReviewedByUserId": { "type": "string", "format": "uuid" }, "ReviewedUtc": { "type": "string", "format": "date-time" }, "DecisionNote": { "type": [ "null", "string" ] } } }, "BuilderBuildSpecReviewDecisionRequest": { "required": [ "decision" ], "type": "object", "properties": { "decision": { "maxLength": 10, "minLength": 6, "enum": [ "Approve", "Reject" ], "type": "string" }, "note": { "maxLength": 500, "minLength": 0, "type": [ "null", "string" ] } } }, "BuilderBuildSpecReviewResponse": { "required": [ "review" ], "type": "object", "properties": { "review": { "$ref": "#/components/schemas/BuilderBuildSpecReview" } } }, "BuilderBuildSpecSession": { "type": "object", "properties": { "BuildSpecSessionId": { "type": "string", "format": "uuid" }, "BlueprintSchemaKey": { "type": [ "null", "string" ] }, "SchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "Status": { "type": [ "null", "string" ] }, "ProvisionedSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "Blueprint": { "$ref": "#/components/schemas/JsonElement" }, "Report": { "$ref": "#/components/schemas/JsonElement" }, "Messages": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderBuildSpecMessage" } } } }, "BuilderBuildSpecSessionResponse": { "required": [ "session" ], "type": "object", "properties": { "session": { "$ref": "#/components/schemas/BuilderBuildSpecSession" } } }, "BuilderBuildSpecStartRequest": { "type": "object", "properties": { "schemaKey": { "maxLength": 100, "minLength": 1, "type": [ "null", "string" ] } } }, "BuilderBuildSpecStep": { "type": "object", "properties": { "StepOrdinal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "StepKey": { "type": [ "null", "string" ] }, "StepStatus": { "type": [ "null", "string" ] } } }, "BuilderCommunicationSettings": { "type": "object", "properties": { "emailOptIn": { "type": "boolean" }, "smsOptIn": { "type": "boolean" }, "billingEmail": { "type": [ "null", "string" ] }, "technicalEmail": { "type": [ "null", "string" ] }, "securityEmail": { "type": [ "null", "string" ] }, "marketingEmail": { "type": [ "null", "string" ] }, "productUpdatesEmail": { "type": [ "null", "string" ] }, "billingNotificationsEnabled": { "type": "boolean" }, "technicalNotificationsEnabled": { "type": "boolean" }, "securityNotificationsEnabled": { "type": "boolean" }, "productUpdatesEnabled": { "type": "boolean" }, "marketingNotificationsEnabled": { "type": "boolean" }, "preferredTimezone": { "type": [ "null", "string" ] }, "preferredLocale": { "type": [ "null", "string" ] }, "rowVersion": { "maxLength": 12, "minLength": 12, "pattern": "^[A-Za-z0-9+/]{11}=$", "type": [ "null", "string" ], "description": "Required when preferences already exist; omit only for the first create. A stale or missing value for an existing row returns conflict." } } }, "BuilderCostTelemetryApp": { "required": [ "saasAppId", "appName", "infrastructureCostMicros", "aiCostMicros", "totalCostMicros", "metrics" ], "type": "object", "properties": { "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" }, "appName": { "minLength": 1, "type": "string" }, "infrastructureCostMicros": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "aiCostMicros": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "totalCostMicros": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderCostTelemetryMetric" } } } }, "BuilderCostTelemetryCoverage": { "required": [ "usageRowCount", "ratedUsageRowCount", "unratedUsageRowCount", "isComplete" ], "type": "object", "properties": { "usageRowCount": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ratedUsageRowCount": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unratedUsageRowCount": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isComplete": { "type": "boolean" } } }, "BuilderCostTelemetryMetric": { "required": [ "metricKey", "displayName", "unitCode", "usageValue", "usageUpdatedUtc", "costCategory", "unitCostMicros", "estimatedCostMicros", "rateEffectiveFromUtc", "rateSourceLabel" ], "type": "object", "properties": { "metricKey": { "minLength": 1, "type": "string" }, "displayName": { "minLength": 1, "type": "string" }, "unitCode": { "minLength": 1, "type": "string" }, "usageValue": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "usageUpdatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "costCategory": { "type": [ "null", "string" ] }, "unitCostMicros": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "estimatedCostMicros": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "rateEffectiveFromUtc": { "type": [ "null", "string" ], "format": "date-time" }, "rateSourceLabel": { "type": [ "null", "string" ] } } }, "BuilderCostTelemetrySnapshot": { "required": [ "generatedUtc", "periodStartUtc", "periodEndUtc", "currencyCode", "coverage", "account", "apps", "unratedUsage" ], "type": "object", "properties": { "generatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "periodStartUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "periodEndUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "currencyCode": { "minLength": 1, "type": "string" }, "coverage": { "$ref": "#/components/schemas/BuilderCostTelemetryCoverage" }, "account": { "$ref": "#/components/schemas/BuilderCostTelemetryTotals" }, "apps": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderCostTelemetryApp" } }, "unratedUsage": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderUnratedUsage" } } } }, "BuilderCostTelemetryTotals": { "required": [ "infrastructureCostMicros", "aiCostMicros", "totalCostMicros" ], "type": "object", "properties": { "infrastructureCostMicros": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "aiCostMicros": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "totalCostMicros": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "BuilderCreateApiClientRequest": { "required": [ "clientName", "scopes", "mode", "idempotencyKey" ], "type": "object", "properties": { "clientName": { "maxLength": 200, "minLength": 1, "type": "string" }, "scopes": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "mode": { "minLength": 1, "pattern": "^(draft|live)$", "enum": [ "draft", "live" ], "type": "string" }, "idempotencyKey": { "minLength": 1, "type": "string", "format": "uuid" } } }, "BuilderCreateAppRequest": { "required": [ "appName", "deploymentType", "idempotencyKey" ], "type": "object", "properties": { "appName": { "maxLength": 200, "minLength": 1, "type": "string" }, "deploymentType": { "minLength": 1, "enum": [ "BuilderOnly", "ContainerOnly", "Hybrid" ], "type": "string" }, "templatePackVersionId": { "type": [ "null", "string" ], "format": "uuid" }, "idempotencyKey": { "minLength": 1, "type": "string", "format": "uuid" } } }, "BuilderDatabaseInventory": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "generatedUtc": { "type": "string", "format": "date-time" }, "planSha256": { "type": [ "null", "string" ] }, "planes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderDatabaseInventoryPlane" } } } }, "BuilderDatabaseInventoryPlane": { "type": "object", "properties": { "plane": { "type": [ "null", "string" ] }, "ready": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "blocked": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "manualReview": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "schemaChanges": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "procedures": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderDatabaseInventoryProcedure" } } } }, "BuilderDatabaseInventoryProcedure": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "reasons": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "BuilderDatabaseUpgradeRequest": { "type": "object", "properties": { "databaseUpgradeRequestId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "releaseVersion": { "type": [ "null", "string" ] }, "upgradeStatus": { "type": [ "null", "string" ] }, "requestedUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" } } }, "BuilderDatabaseUpgradeState": { "type": "object", "properties": { "inventory": { "anyOf": [ { "$ref": "#/components/schemas/BuilderDatabaseInventory" }, { "type": "null" } ] }, "saasAppId": { "type": "string", "format": "uuid" }, "appName": { "type": [ "null", "string" ] }, "appStatus": { "type": [ "null", "string" ] }, "currentReleaseVersion": { "type": [ "null", "string" ] }, "targetCoreSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "targetLogsSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "targetAiSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "observedCoreSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "observedLogsSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "observedAiSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isDatabaseReleaseCurrent": { "type": "boolean" }, "latestRequestId": { "type": [ "null", "string" ], "format": "uuid" }, "latestRequestStatus": { "type": [ "null", "string" ] }, "latestRequestedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "latestBackupVerifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "latestCompletedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "latestFailureCode": { "type": [ "null", "string" ] } } }, "BuilderDomain": { "type": "object", "properties": { "saasAppDomainId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "hostName": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" }, "status": { "enum": [ "Pending", "Active", "Failed", "Inactive" ], "type": "string" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" }, "rowVersion": { "type": [ "null", "string" ] } } }, "BuilderDomainMutationResult": { "required": [ "domain", "verification" ], "type": "object", "properties": { "domain": { "$ref": "#/components/schemas/BuilderDomain" }, "verification": { "anyOf": [ { "$ref": "#/components/schemas/DomainVerificationState" }, { "type": "null" } ] } } }, "BuilderDomainsResponse": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderDomain" } } } }, "BuilderMarketplaceActionBindingRequest": { "required": [ "actionKey", "applianceSellerArtifactId", "endpointKey" ], "type": "object", "properties": { "actionKey": { "type": "string" }, "applianceSellerArtifactId": { "type": "string", "format": "uuid" }, "endpointKey": { "type": "string" }, "requestMappingJson": { "type": [ "null", "string" ] }, "responseMappingJson": { "type": [ "null", "string" ] }, "failurePolicyJson": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceAdminProduct": { "type": "object", "properties": { "marketplaceProductId": { "type": "string", "format": "uuid" }, "productName": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "productStatus": { "type": [ "null", "string" ] }, "publishedVersionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activeOfferCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BuilderMarketplaceAdminSnapshot": { "required": [ "products", "purchases" ], "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceAdminProduct" } }, "purchases": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBuyerEntitlement" } } } }, "BuilderMarketplaceArtifactRegistrationRequest": { "required": [ "artifactVersionId" ], "type": "object", "properties": { "artifactVersionId": { "type": "string", "format": "uuid" }, "sourceSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" } } }, "BuilderMarketplaceAvailabilityRequest": { "required": [ "isAvailable" ], "type": "object", "properties": { "isAvailable": { "type": "boolean" } } }, "BuilderMarketplaceCheckoutRequest": { "required": [ "marketplacePriceId", "checkoutIntentId" ], "type": "object", "properties": { "marketplacePriceId": { "minLength": 1, "type": "string", "format": "uuid" }, "requestedTargetSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "checkoutIntentId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "BuilderMarketplaceComponentRequest": { "required": [ "sellerArtifactId", "componentRole" ], "type": "object", "properties": { "sellerArtifactId": { "type": "string", "format": "uuid" }, "componentRole": { "type": "string" }, "isRequired": { "type": "boolean" }, "installOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "configurationJson": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceEntitlementAssignmentRequest": { "required": [ "saasAppId" ], "type": "object", "properties": { "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "BuilderMarketplaceEntitlementsResponse": { "required": [ "entitlements" ], "type": "object", "properties": { "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceBuyerEntitlement" } } } }, "BuilderMarketplaceInstallRequest": { "type": "object", "properties": { "marketplaceProductVersionId": { "type": [ "null", "string" ], "format": "uuid" } } }, "BuilderMarketplaceMutationReceipt": { "type": "object", "properties": { "resourceId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceOfferRequest": { "required": [ "marketplaceProductVersionId", "offerName", "billingModel", "billingInterval" ], "type": "object", "properties": { "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "offerName": { "type": "string" }, "billingModel": { "type": "string" }, "billingInterval": { "type": "string" }, "allowUpdates": { "type": "boolean" }, "trialDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BuilderMarketplaceOwnedCatalog": { "required": [ "products", "versions", "offers", "prices" ], "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedProduct" } }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedVersion" } }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedOffer" } }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceOwnedPrice" } } } }, "BuilderMarketplaceOwnedOffer": { "type": "object", "properties": { "marketplaceOfferId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "offerName": { "type": [ "null", "string" ] }, "billingModel": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "licenseType": { "type": [ "null", "string" ] }, "allowUpdates": { "type": "boolean" }, "trialDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offerStatus": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderMarketplaceOwnedPrice": { "type": "object", "properties": { "marketplacePriceId": { "type": "string", "format": "uuid" }, "marketplaceOfferId": { "type": "string", "format": "uuid" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "currencyCode": { "type": [ "null", "string" ] }, "unitAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "hasProviderPrice": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderMarketplaceOwnedProduct": { "type": "object", "properties": { "marketplaceProductId": { "type": "string", "format": "uuid" }, "productSlug": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "shortDescription": { "type": [ "null", "string" ] }, "fullDescription": { "type": [ "null", "string" ] }, "previewImageUrl": { "type": [ "null", "string" ] }, "documentationUrl": { "type": [ "null", "string" ] }, "supportUrl": { "type": [ "null", "string" ] }, "visibility": { "type": [ "null", "string" ] }, "productStatus": { "type": [ "null", "string" ] }, "isFeatured": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderMarketplaceOwnedVersion": { "type": "object", "properties": { "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": [ "null", "string" ] }, "versionStatus": { "type": [ "null", "string" ] }, "isRecommendedForPurchase": { "type": "boolean" }, "releaseNotes": { "type": [ "null", "string" ] }, "installNotes": { "type": [ "null", "string" ] }, "hasProductManifest": { "type": "boolean" }, "submittedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "reviewedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "reviewNote": { "type": [ "null", "string" ] }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderMarketplacePriceRequest": { "required": [ "unitAmountCents" ], "type": "object", "properties": { "currencyCode": { "type": [ "null", "string" ] }, "unitAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "BuilderMarketplaceProductMetadataRequest": { "required": [ "productName", "visibility" ], "type": "object", "properties": { "productName": { "type": "string" }, "category": { "type": [ "null", "string" ] }, "shortDescription": { "type": [ "null", "string" ] }, "fullDescription": { "type": [ "null", "string" ] }, "previewImageUrl": { "type": [ "null", "string" ] }, "documentationUrl": { "type": [ "null", "string" ] }, "supportUrl": { "type": [ "null", "string" ] }, "visibility": { "type": "string" } } }, "BuilderMarketplaceProductRequest": { "required": [ "productSlug", "productName", "productType" ], "type": "object", "properties": { "productSlug": { "type": "string" }, "productName": { "type": "string" }, "productType": { "type": "string" }, "category": { "type": [ "null", "string" ] }, "shortDescription": { "type": [ "null", "string" ] }, "fullDescription": { "type": [ "null", "string" ] }, "previewImageUrl": { "type": [ "null", "string" ] }, "visibility": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceProductsResponse": { "required": [ "products" ], "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceCatalogItem" } } } }, "BuilderMarketplaceSellerActionBinding": { "type": "object", "properties": { "productActionBindingId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "actionKey": { "type": [ "null", "string" ] }, "applianceSellerArtifactId": { "type": "string", "format": "uuid" }, "applianceArtifactKey": { "type": [ "null", "string" ] }, "applianceVersionLabel": { "type": [ "null", "string" ] }, "endpointKey": { "type": [ "null", "string" ] }, "requestMappingJson": { "type": [ "null", "string" ] }, "responseMappingJson": { "type": [ "null", "string" ] }, "failurePolicyJson": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderMarketplaceSellerArtifact": { "type": "object", "properties": { "sellerArtifactId": { "type": "string", "format": "uuid" }, "sourceSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "artifactType": { "type": [ "null", "string" ] }, "artifactSubtype": { "type": [ "null", "string" ] }, "artifactVersionId": { "type": "string", "format": "uuid" }, "artifactKeySnapshot": { "type": [ "null", "string" ] }, "versionLabelSnapshot": { "type": [ "null", "string" ] }, "artifactFingerprint": { "type": [ "null", "string" ] }, "artifactStatus": { "type": [ "null", "string" ] }, "registeredUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderMarketplaceSellerBalance": { "type": "object", "properties": { "currencyCode": { "type": [ "null", "string" ] }, "ledgerBalanceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "availableBalanceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "BuilderMarketplaceSellerComponent": { "type": "object", "properties": { "productVersionComponentId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "sellerArtifactId": { "type": "string", "format": "uuid" }, "artifactType": { "type": [ "null", "string" ] }, "artifactSubtype": { "type": [ "null", "string" ] }, "artifactVersionId": { "type": "string", "format": "uuid" }, "artifactKeySnapshot": { "type": [ "null", "string" ] }, "versionLabelSnapshot": { "type": [ "null", "string" ] }, "artifactFingerprint": { "type": [ "null", "string" ] }, "artifactStatus": { "type": [ "null", "string" ] }, "componentRole": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "installOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "configurationJson": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderMarketplaceSellerComposition": { "required": [ "version", "components", "bindings" ], "type": "object", "properties": { "version": { "$ref": "#/components/schemas/BuilderMarketplaceSellerVersion" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerComponent" } }, "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerActionBinding" } } } }, "BuilderMarketplaceSellerCreateRequest": { "required": [ "storeSlug", "storeDisplayName" ], "type": "object", "properties": { "storeSlug": { "type": "string" }, "storeDisplayName": { "type": "string" }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceSellerLedgerEntry": { "type": "object", "properties": { "marketplaceSellerLedgerId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "entryType": { "type": [ "null", "string" ] }, "sourceType": { "type": [ "null", "string" ] }, "sourceId": { "type": [ "null", "string" ] }, "grossAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "platformFeeCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "sellerNetCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "balanceDeltaCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "availableUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderMarketplaceSellerRequest": { "required": [ "storeSlug", "storeDisplayName" ], "type": "object", "properties": { "storeSlug": { "type": "string" }, "storeDisplayName": { "type": "string" }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceSellerRevenue": { "required": [ "products", "balances", "ledger" ], "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerRevenueProduct" } }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerBalance" } }, "ledger": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderMarketplaceSellerLedgerEntry" } } } }, "BuilderMarketplaceSellerRevenueProduct": { "type": "object", "properties": { "marketplaceProductId": { "type": "string", "format": "uuid" }, "productName": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "productStatus": { "type": [ "null", "string" ] }, "publishedVersionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activeOfferCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BuilderMarketplaceSellerTermsRequest": { "required": [ "termsVersion" ], "type": "object", "properties": { "termsVersion": { "type": "string" } } }, "BuilderMarketplaceSellerUpdateRequest": { "required": [ "storeDisplayName" ], "type": "object", "properties": { "storeDisplayName": { "type": "string" }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] }, "logoUrl": { "type": [ "null", "string" ] }, "bannerUrl": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceSellerVersion": { "type": "object", "properties": { "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "productName": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "semanticVersion": { "type": [ "null", "string" ] }, "versionStatus": { "type": [ "null", "string" ] }, "isRecommendedForPurchase": { "type": "boolean" }, "releaseNotes": { "type": [ "null", "string" ] }, "installNotes": { "type": [ "null", "string" ] }, "hasProductManifest": { "type": "boolean" }, "submittedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "reviewedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "reviewNote": { "type": [ "null", "string" ] }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderMarketplaceUpgradeRequest": { "required": [ "targetProductVersionId" ], "type": "object", "properties": { "expectedCurrentProductVersionId": { "type": "string", "format": "uuid" }, "targetProductVersionId": { "type": "string", "format": "uuid" } } }, "BuilderMarketplaceVersionRequest": { "required": [ "marketplaceProductId", "semanticVersion" ], "type": "object", "properties": { "marketplaceProductId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": "string" }, "releaseNotes": { "type": [ "null", "string" ] }, "installNotes": { "type": [ "null", "string" ] } } }, "BuilderProvisioningProgress": { "type": "object", "properties": { "saasAppId": { "type": "string", "format": "uuid" }, "appName": { "type": [ "null", "string" ] }, "appStatus": { "type": [ "null", "string" ] }, "provisioningJobId": { "type": [ "null", "string" ], "format": "uuid" }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "currentStepKey": { "type": [ "null", "string" ] }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "maxAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "nextAttemptUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastHeartbeatUtc": { "type": [ "null", "string" ], "format": "date-time" }, "failureCode": { "type": [ "null", "string" ] }, "failureMessage": { "type": [ "null", "string" ] }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "startedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] }, "progressVersion": { "type": [ "null", "string" ] }, "progressAvailable": { "type": "boolean" }, "isTerminal": { "type": "boolean" }, "pollAfterSeconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "steps": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderProvisioningStepProgress" } } } }, "BuilderProvisioningStepProgress": { "type": "object", "properties": { "stepKey": { "type": [ "null", "string" ] }, "stepOrdinal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "operationId": { "type": "string", "format": "uuid" }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastHeartbeatUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "failureCode": { "type": [ "null", "string" ] }, "failureMessage": { "type": [ "null", "string" ] }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderRequestBackupRequest": { "required": [ "requestId" ], "type": "object", "properties": { "backupDestinationId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "requestId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "BuilderResourceAllocationReceipt": { "required": [ "allocatedPrimaryGb", "allocatedLogFileGb", "allocatedAiGb", "allocatedContainerGb" ], "type": "object", "properties": { "saasAppId": { "type": "string", "format": "uuid" }, "rowVersion": { "type": [ "null", "string" ] }, "allocatedPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "BuilderResourceAllocationsSnapshot": { "type": "object", "properties": { "apps": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderAppResourceAllocation" } } } }, "BuilderResourceAllocationUpdate": { "required": [ "allocatedPrimaryGb", "allocatedLogFileGb", "allocatedAiGb", "allocatedContainerGb" ], "type": "object", "properties": { "allocatedPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "notes": { "type": [ "null", "string" ] }, "expectedRowVersion": { "type": [ "null", "string" ] } } }, "BuilderResourceCapacity": { "required": [ "planPrimaryGb", "planLogFileGb", "planAiGb", "planContainerGb", "purchasedPrimaryGb", "purchasedLogFileGb", "purchasedAiGb", "purchasedContainerGb", "totalPrimaryGb", "totalLogFileGb", "totalAiGb", "totalContainerGb", "allocatedPrimaryGb", "allocatedLogFileGb", "allocatedAiGb", "allocatedContainerGb", "availablePrimaryGb", "availableLogFileGb", "availableAiGb", "availableContainerGb" ], "type": "object", "properties": { "planPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "planLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "planAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "planContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "purchasedPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "purchasedLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "purchasedAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "purchasedContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedPrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "availablePrimaryGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "availableLogFileGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "availableAiGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "availableContainerGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "BuilderRuntimeLogPointer": { "type": "object", "properties": { "source": { "type": [ "null", "string" ] }, "occurredUtc": { "type": "string", "format": "date-time" }, "eventName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "referenceId": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" } } }, "BuilderRuntimeRestartReceipt": { "type": "object", "properties": { "saasAppId": { "type": "string", "format": "uuid" }, "status": { "enum": [ "Running" ], "type": "string" }, "restartedUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" } } }, "BuilderRuntimeSnapshot": { "type": "object", "properties": { "saasAppId": { "type": "string", "format": "uuid" }, "appName": { "type": [ "null", "string" ] }, "deploymentType": { "type": [ "null", "string" ] }, "workload": { "anyOf": [ { "$ref": "#/components/schemas/BuilderRuntimeWorkload" }, { "type": "null" } ] }, "restartAvailable": { "type": "boolean" }, "recentEvents": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderRuntimeLogPointer" } } } }, "BuilderRuntimeWorkload": { "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "endpoint": { "type": [ "null", "string" ] }, "cpuLimit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "memoryLimitMb": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "BuilderSaveBackupDestinationRequest": { "required": [ "bucketName", "regionName" ], "type": "object", "properties": { "backupDestinationId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "bucketName": { "maxLength": 255, "minLength": 1, "type": "string" }, "regionName": { "maxLength": 100, "minLength": 1, "type": "string" }, "s3Prefix": { "maxLength": 500, "minLength": 0, "type": [ "null", "string" ] }, "roleArn": { "maxLength": 500, "minLength": 0, "type": [ "null", "string" ] }, "externalId": { "maxLength": 200, "minLength": 0, "type": [ "null", "string" ] }, "useObjectLock": { "type": "boolean" }, "isEnabled": { "type": "boolean" } } }, "BuilderSecurityAuditEvent": { "type": "object", "properties": { "auditId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "actorBuilderUserId": { "type": [ "null", "string" ], "format": "uuid" }, "actorDisplayName": { "type": [ "null", "string" ] }, "actorEmail": { "type": [ "null", "string" ] }, "saasAppId": { "type": [ "null", "string" ], "format": "uuid" }, "actionCode": { "type": [ "null", "string" ] }, "targetType": { "type": [ "null", "string" ] }, "targetId": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "ipAddress": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderSecuritySession": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid" }, "issuedUtc": { "type": "string", "format": "date-time" }, "expiresUtc": { "type": "string", "format": "date-time" }, "lastSeenUtc": { "type": [ "null", "string" ], "format": "date-time" }, "revokedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "revocationReason": { "type": [ "null", "string" ] }, "ipAddress": { "type": [ "null", "string" ] }, "userAgent": { "type": [ "null", "string" ] }, "deviceName": { "type": [ "null", "string" ] } } }, "BuilderSecuritySessionsSnapshot": { "required": [ "currentSessionId", "sessions" ], "type": "object", "properties": { "currentSessionId": { "minLength": 1, "type": "string", "format": "uuid" }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderSecuritySession" } } } }, "BuilderSenderDomain": { "type": "object", "properties": { "customerSenderDomainId": { "type": "string", "format": "uuid" }, "domainName": { "type": [ "null", "string" ] }, "fromName": { "type": [ "null", "string" ] }, "fromLocalPart": { "type": [ "null", "string" ] }, "dkimRecordName": { "type": [ "null", "string" ] }, "spfStatus": { "type": [ "null", "string" ] }, "dkimStatus": { "type": [ "null", "string" ] }, "verificationStatus": { "type": [ "null", "string" ] }, "verifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastCheckedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isDefault": { "type": "boolean" } } }, "BuilderSetPrimaryDomainRequest": { "required": [ "rowVersion" ], "type": "object", "properties": { "rowVersion": { "maxLength": 12, "minLength": 12, "pattern": "^[A-Za-z0-9+/]{11}=$", "type": "string" } } }, "BuilderStarterTemplate": { "required": [ "templatePackVersionId", "templatePackKey", "templatePackName", "versionNumber", "isDefault" ], "type": "object", "properties": { "templatePackVersionId": { "minLength": 1, "type": "string", "format": "uuid" }, "templatePackKey": { "minLength": 1, "type": "string" }, "templatePackName": { "minLength": 1, "type": "string" }, "versionNumber": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDefault": { "type": "boolean" } } }, "BuilderStarterTemplatesResponse": { "required": [ "templates" ], "type": "object", "properties": { "templates": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderStarterTemplate" } } } }, "BuilderTeamInvitation": { "type": "object", "properties": { "invitationId": { "type": "string", "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "roleCode": { "type": [ "null", "string" ] }, "expiresUtc": { "type": "string", "format": "date-time" }, "acceptedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "revokedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderTeamInvitationRequest": { "required": [ "email", "roleCode" ], "type": "object", "properties": { "email": { "maxLength": 320, "minLength": 3, "type": "string" }, "roleCode": { "maxLength": 50, "minLength": 1, "type": "string" }, "expiresInDays": { "maximum": 30, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BuilderTeamRole": { "type": "object", "properties": { "roleCode": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "canCreateSaaS": { "type": "boolean" }, "canManageBilling": { "type": "boolean" }, "canManageUsers": { "type": "boolean" }, "canManageApiKeys": { "type": "boolean" }, "canDeploy": { "type": "boolean" }, "canManageAccount": { "type": "boolean" }, "canManageStorage": { "type": "boolean" }, "canManageDomains": { "type": "boolean" }, "canManageBackups": { "type": "boolean" }, "canManageIntegrations": { "type": "boolean" }, "canManageSecurity": { "type": "boolean" }, "canViewAuditLog": { "type": "boolean" }, "canManageMarketplaceStore": { "type": "boolean" }, "canPurchaseMarketplace": { "type": "boolean" }, "canInstallMarketplaceProducts": { "type": "boolean" }, "canViewMarketplaceRevenue": { "type": "boolean" }, "canManageMarketplacePayouts": { "type": "boolean" }, "canManageTemplates": { "type": "boolean" }, "canManageAppliances": { "type": "boolean" } } }, "BuilderTeamRoleUpdateRequest": { "required": [ "roleCode", "rowVersion" ], "type": "object", "properties": { "roleCode": { "maxLength": 50, "minLength": 1, "type": "string" }, "rowVersion": { "maxLength": 12, "minLength": 12, "pattern": "^[A-Za-z0-9+/]{11}=$", "type": "string" } } }, "BuilderTeamSnapshot": { "required": [ "users", "roles", "invitations" ], "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderTeamUser" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderTeamRole" } }, "invitations": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderTeamInvitation" } } } }, "BuilderTeamStatusUpdateRequest": { "required": [ "status", "rowVersion" ], "type": "object", "properties": { "status": { "minLength": 1, "pattern": "^(Active|Disabled)$", "enum": [ "Active", "Disabled" ], "type": "string" }, "rowVersion": { "maxLength": 12, "minLength": 12, "pattern": "^[A-Za-z0-9+/]{11}=$", "type": "string" } } }, "BuilderTeamUser": { "type": "object", "properties": { "builderUserId": { "type": "string", "format": "uuid" }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "roleCode": { "type": [ "null", "string" ] }, "isOwner": { "type": "boolean" }, "status": { "type": [ "null", "string" ] }, "lastLoginUtc": { "type": [ "null", "string" ], "format": "date-time" }, "mfaEnabled": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "rowVersion": { "type": [ "null", "string" ] } } }, "BuilderTemplateAdminItem": { "type": "object", "properties": { "templatePackId": { "type": "string", "format": "uuid" }, "templatePackKey": { "type": [ "null", "string" ] }, "templatePackName": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "shortDescription": { "type": [ "null", "string" ] }, "industry": { "type": [ "null", "string" ] }, "pageCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isPublished": { "type": "boolean" }, "publishedTemplatePackVersionId": { "type": [ "null", "string" ], "format": "uuid" }, "publishedVersionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "BuilderTemplateAdminSnapshot": { "required": [ "templates" ], "type": "object", "properties": { "templates": { "type": "array", "items": { "$ref": "#/components/schemas/BuilderTemplateAdminItem" } } } }, "BuilderTemplateArchiveRequest": { "required": [ "expectedTemplatePackVersionId" ], "type": "object", "properties": { "expectedTemplatePackVersionId": { "type": "string", "format": "uuid" } } }, "BuilderTemplateHarvestReceipt": { "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid" }, "correlationId": { "type": "string", "format": "uuid" }, "artifactType": { "type": [ "null", "string" ] }, "templateKey": { "type": [ "null", "string" ] }, "templateObjectId": { "type": "string", "format": "uuid" }, "templateVersionId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "sourceSaaSAppId": { "type": "string", "format": "uuid" }, "sourceObjectId": { "type": "string", "format": "uuid" }, "sourceVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "sourceFingerprintSha256": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } }, "BuilderTemplateHarvestRequest": { "required": [ "operationId", "artifactType", "sourceKey", "templatePackKey", "targetTemplateKey" ], "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid" }, "artifactType": { "type": "string" }, "sourceKey": { "type": "string" }, "templatePackKey": { "type": "string" }, "targetTemplateKey": { "type": "string" }, "templateName": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] } } }, "BuilderUnratedUsage": { "required": [ "metricKey", "displayName", "unitCode", "usageValue", "saasAppId" ], "type": "object", "properties": { "metricKey": { "minLength": 1, "type": "string" }, "displayName": { "minLength": 1, "type": "string" }, "unitCode": { "minLength": 1, "type": "string" }, "usageValue": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "BuilderUsageAlert": { "required": [ "currentValueGb", "capacityGb", "utilizationPercent" ], "type": "object", "properties": { "usageAlertId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "scopeType": { "type": [ "null", "string" ] }, "saasAppId": { "type": [ "null", "string" ], "format": "uuid" }, "appName": { "type": [ "null", "string" ] }, "resourceKey": { "type": [ "null", "string" ] }, "thresholdPercent": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "severity": { "type": [ "null", "string" ] }, "currentValueGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "capacityGb": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "utilizationPercent": { "minLength": 1, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "status": { "type": [ "null", "string" ] }, "firstTriggeredUtc": { "type": "string", "format": "date-time" }, "lastTriggeredUtc": { "type": "string", "format": "date-time" }, "lastObservedUtc": { "type": "string", "format": "date-time" }, "resolvedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "triggerCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" } } }, "BuilderUsageAlertsSnapshot": { "type": "object", "properties": { "evaluatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "alerts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderUsageAlert" } } } }, "ControlPlaneErrorResponse": { "required": [ "code", "error", "correlationId" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "error": { "minLength": 1, "type": "string" }, "correlationId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "DeveloperApiClientSecretReceipt": { "oneOf": [ { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "minLength": 1, "type": "string", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ false ] } } }, { "required": [ "client", "credential", "isReplay" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/DeveloperApiClientSummary" }, "credential": { "type": "null", "description": "One-time API credential returned exactly once by a fresh create or rotation. An idempotent create replay returns null with isReplay=true; it never returns the earlier secret. Store a fresh credential securely; list never returns it and BuildWithHQ cannot recover it." }, "isReplay": { "enum": [ true ] } } } ] }, "DeveloperApiClientSummary": { "required": [ "apiClientId", "saasAppId", "clientName", "clientKey", "mode", "scopes", "status", "createdUtc", "updatedUtc" ], "type": "object", "properties": { "apiClientId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "clientName": { "type": "string" }, "clientKey": { "type": "string" }, "mode": { "enum": [ "draft", "live" ], "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "status": { "enum": [ "Active", "Inactive", "Revoked" ], "type": "string" }, "runtimeAppAccountId": { "type": [ "null", "string" ], "format": "uuid" }, "runtimeUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" }, "lastUsedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastRotatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "revokedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "DeveloperProblemItem": { "type": "object", "properties": { "workItemId": { "type": "string", "format": "uuid" }, "problemId": { "type": "string", "format": "uuid" }, "fingerprint": { "type": [ "null", "string" ] }, "failureCode": { "type": [ "null", "string" ] }, "failureClass": { "type": [ "null", "string" ] }, "sourceService": { "type": [ "null", "string" ] }, "operationCode": { "type": [ "null", "string" ] }, "buildVersion": { "type": [ "null", "string" ] }, "severity": { "type": [ "null", "string" ] }, "workflowState": { "type": [ "null", "string" ] }, "attributionKind": { "type": [ "null", "string" ] }, "marketplaceArtifactType": { "type": [ "null", "string" ] }, "marketplaceArtifactVersionId": { "type": [ "null", "string" ], "format": "uuid" }, "firstSeenUtc": { "type": "string", "format": "date-time" }, "lastSeenUtc": { "type": "string", "format": "date-time" }, "occurrenceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "affectedScopeCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "latestCorrelationId": { "type": "string", "format": "uuid" }, "conditionState": { "type": [ "null", "string" ] }, "ageBucket": { "type": [ "null", "string" ] }, "backlogCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "rowVersion": { "type": [ "null", "string" ] } } }, "DeveloperProblemPage": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "audienceKind": { "enum": [ "SaaSDeveloper" ], "type": "string" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "problems": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperProblemItem" } } } }, "DeveloperProblemTransitionReceipt": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "workItemId": { "type": "string", "format": "uuid" }, "workflowState": { "type": [ "null", "string" ] }, "rowVersion": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperProblemTransitionRequest": { "required": [ "audienceKind", "saasAppId", "action", "expectedRowVersion" ], "type": "object", "properties": { "audienceKind": { "enum": [ "SaaSDeveloper" ], "type": "string" }, "saasAppId": { "type": "string", "format": "uuid" }, "action": { "enum": [ "Acknowledge", "Investigate", "Resolve", "Reopen" ], "type": "string" }, "expectedRowVersion": { "maxLength": 16, "minLength": 16, "pattern": "^[0-9A-Fa-f]{16}$", "type": "string" } } }, "DomainVerificationRecord": { "type": "object", "properties": { "recordType": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "value": { "type": [ "null", "string" ] } } }, "DomainVerificationState": { "type": "object", "properties": { "hostnameStatus": { "enum": [ "Pending", "Verified", "Failed" ], "type": "string" }, "sslStatus": { "enum": [ "Pending", "Verified", "Failed" ], "type": "string" }, "providerHostnameStatus": { "type": [ "null", "string" ] }, "providerSslStatus": { "type": [ "null", "string" ] }, "cnameTarget": { "type": [ "null", "string" ] }, "validationRecords": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DomainVerificationRecord" } } } }, "HarnessComponentDraftRequest": { "required": [ "componentKey", "componentType", "payloadJson" ], "type": "object", "properties": { "componentKey": { "type": "string" }, "componentType": { "type": "string" }, "targetFeature": { "type": [ "null", "string" ] }, "payloadJson": { "type": "string" }, "notes": { "type": [ "null", "string" ] }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isActive": { "type": "boolean" } } }, "HarnessComponentEditorItem": { "type": "object", "properties": { "harnessComponentId": { "type": "string", "format": "uuid" }, "componentKey": { "type": [ "null", "string" ] }, "componentType": { "type": [ "null", "string" ] }, "targetFeature": { "type": [ "null", "string" ] }, "payloadJson": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isActive": { "type": "boolean" }, "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] } } }, "HarnessComponentSaveReceipt": { "type": "object", "properties": { "harnessComponentId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "componentKey": { "type": [ "null", "string" ] }, "componentType": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" } } }, "HarnessEvalCaseDraftRequest": { "required": [ "caseKey", "inputJson", "expectedJson", "scoringMethod" ], "type": "object", "properties": { "harnessEvalSetId": { "type": "string", "format": "uuid" }, "caseKey": { "type": "string" }, "inputJson": { "type": "string" }, "expectedJson": { "type": "string" }, "scoringMethod": { "type": "string" }, "passThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isActive": { "type": "boolean" } } }, "HarnessEvalCaseEditorItem": { "type": "object", "properties": { "harnessEvalCaseId": { "type": "string", "format": "uuid" }, "caseKey": { "type": [ "null", "string" ] }, "inputJson": { "type": [ "null", "string" ] }, "expectedJson": { "type": [ "null", "string" ] }, "scoringMethod": { "type": [ "null", "string" ] }, "passThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isActive": { "type": "boolean" } } }, "HarnessEvalCaseSaveReceipt": { "type": "object", "properties": { "harnessEvalCaseId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "harnessEvalSetId": { "type": "string", "format": "uuid" }, "caseKey": { "type": [ "null", "string" ] }, "scoringMethod": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" } } }, "HarnessEvalSetDraftRequest": { "required": [ "evalSetName" ], "type": "object", "properties": { "evalSetName": { "type": "string" }, "isPublishGate": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "HarnessEvalSetEditorItem": { "type": "object", "properties": { "harnessEvalSetId": { "type": "string", "format": "uuid" }, "evalSetName": { "type": [ "null", "string" ] }, "isPublishGate": { "type": "boolean" }, "isActive": { "type": "boolean" }, "cases": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessEvalCaseEditorItem" } } } }, "HarnessEvalSetSaveReceipt": { "type": "object", "properties": { "harnessEvalSetId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "evalSetName": { "type": [ "null", "string" ] }, "isPublishGate": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "HarnessEvaluationCaseResult": { "type": "object", "properties": { "harnessEvalSetId": { "type": "string", "format": "uuid" }, "harnessEvalCaseId": { "type": "string", "format": "uuid" }, "caseKey": { "type": [ "null", "string" ] }, "scoringMethod": { "type": [ "null", "string" ] }, "passThreshold": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "passed": { "type": "boolean" }, "structuredOutputValid": { "type": "boolean" }, "securityPassed": { "type": "boolean" }, "reasonCode": { "type": [ "null", "string" ] }, "responseSha256": { "type": [ "null", "string" ] }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "modelKey": { "type": [ "null", "string" ] } } }, "HarnessEvaluationPack": { "type": "object", "properties": { "harnessPackId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "packName": { "type": [ "null", "string" ] } } }, "HarnessEvaluationQueueReceipt": { "type": "object", "properties": { "harnessEvalRunId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "templateVersionId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "queued": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "HarnessEvaluationQueueRequest": { "required": [ "requestId" ], "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" } } }, "HarnessEvaluationRun": { "type": "object", "properties": { "harnessEvalRunId": { "type": "string", "format": "uuid" }, "templateVersionId": { "type": "string", "format": "uuid" }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "totalCases": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "passedCases": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "failedCases": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "nextAttemptUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastFailureCode": { "type": [ "null", "string" ] }, "lastFailureType": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "startedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" }, "resultFingerprintSha256": { "type": [ "null", "string" ] }, "cases": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessEvaluationCaseResult" } } } }, "HarnessEvaluationSnapshot": { "type": "object", "properties": { "pack": { "$ref": "#/components/schemas/HarnessEvaluationPack" }, "versions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessEvaluationVersion" } }, "runs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessEvaluationRun" } } } }, "HarnessEvaluationVersion": { "type": "object", "properties": { "templateVersionId": { "type": "string", "format": "uuid" }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "latestHarnessEvalRunId": { "type": [ "null", "string" ], "format": "uuid" }, "latestEvalStatus": { "type": [ "null", "string" ] }, "latestEvalCompletedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "HarnessInstallationInventorySnapshot": { "type": "object", "properties": { "packsLive": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "installations": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "customerAccounts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "behindLatest": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastObservedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "packs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessPackInstallationInventory" } } } }, "HarnessInstalledVersionInventory": { "type": "object", "properties": { "templateVersionId": { "type": "string", "format": "uuid" }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "installedCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastObservedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "HarnessPackDraftRequest": { "required": [ "harnessPackKey", "packName" ], "type": "object", "properties": { "harnessPackKey": { "type": "string" }, "packName": { "type": "string" }, "industry": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "basedOnHarnessPackKey": { "type": [ "null", "string" ] }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isActive": { "type": "boolean" } } }, "HarnessPackEditorList": { "type": "object", "properties": { "packs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessPackSummary" } } } }, "HarnessPackEditorSnapshot": { "type": "object", "properties": { "pack": { "$ref": "#/components/schemas/HarnessPackSummary" }, "components": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessComponentEditorItem" } }, "evalSets": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessEvalSetEditorItem" } }, "versions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessVersionEditorItem" } } } }, "HarnessPackInstallationInventory": { "type": "object", "properties": { "harnessPackId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "packName": { "type": [ "null", "string" ] }, "publishedTemplateVersionId": { "type": "string", "format": "uuid" }, "publishedVersionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "installedCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "customerAccounts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "behindLatest": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastObservedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "installedVersions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/HarnessInstalledVersionInventory" } } } }, "HarnessPackSaveReceipt": { "type": "object", "properties": { "harnessPackId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "created": { "type": "boolean" }, "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "HarnessPackSummary": { "type": "object", "properties": { "harnessPackId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "packName": { "type": [ "null", "string" ] }, "industry": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "basedOnHarnessPackKey": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "componentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "evalSetCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "latestDraftVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "publishedVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] } } }, "HarnessPublicationReceipt": { "type": "object", "properties": { "templateVersionId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "published": { "type": "boolean" }, "blockCode": { "type": [ "null", "string" ] }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "HarnessVersionDraftRequest": { "type": "object", "properties": { "changeNote": { "type": [ "null", "string" ] } } }, "HarnessVersionEditorItem": { "type": "object", "properties": { "templateVersionId": { "type": "string", "format": "uuid" }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "latestEvalStatus": { "type": [ "null", "string" ] }, "latestEvalCompletedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "HarnessVersionReceipt": { "type": "object", "properties": { "templateVersionId": { "type": "string", "format": "uuid" }, "harnessPackKey": { "type": [ "null", "string" ] }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } }, "JsonElement": { }, "MarketplaceBuyerEntitlement": { "type": "object", "properties": { "marketplaceEntitlementId": { "type": "string", "format": "uuid" }, "entitlementStatus": { "type": [ "null", "string" ] }, "startsUtc": { "type": "string", "format": "date-time" }, "endsUtc": { "type": [ "null", "string" ], "format": "date-time" }, "assignedSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "allowUpdates": { "type": "boolean" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "productName": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "productSlug": { "type": [ "null", "string" ] }, "grantedProductVersionId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": [ "null", "string" ] }, "marketplaceOfferId": { "type": "string", "format": "uuid" }, "offerName": { "type": [ "null", "string" ] }, "billingModel": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "appName": { "type": [ "null", "string" ] }, "appSlug": { "type": [ "null", "string" ] }, "marketplaceInstalledProductId": { "type": [ "null", "string" ], "format": "uuid" }, "installedStatus": { "type": [ "null", "string" ] }, "installedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "MarketplaceCatalogItem": { "type": "object", "properties": { "marketplaceProductId": { "type": "string", "format": "uuid" }, "productSlug": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "shortDescription": { "type": [ "null", "string" ] }, "previewImageUrl": { "type": [ "null", "string" ] }, "isFeatured": { "type": "boolean" }, "sellerCustomerAccountId": { "type": "string", "format": "uuid" }, "storeSlug": { "type": [ "null", "string" ] }, "storeDisplayName": { "type": [ "null", "string" ] }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": [ "null", "string" ] }, "marketplaceOfferId": { "type": "string", "format": "uuid" }, "offerName": { "type": [ "null", "string" ] }, "billingModel": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "licenseType": { "type": [ "null", "string" ] }, "allowUpdates": { "type": "boolean" }, "trialDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "marketplacePriceId": { "type": "string", "format": "uuid" }, "currencyCode": { "type": [ "null", "string" ] }, "unitAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "MarketplaceCheckoutReceipt": { "required": [ "order", "paymentRequired", "checkoutUrl", "checkoutExpiresUtc" ], "type": "object", "properties": { "order": { "$ref": "#/components/schemas/MarketplaceOrderCheckoutContext" }, "paymentRequired": { "type": "boolean" }, "checkoutUrl": { "anyOf": [ { "minLength": 1, "type": "string", "format": "uri" }, { "type": "null" } ] }, "checkoutExpiresUtc": { "anyOf": [ { "minLength": 1, "type": "string", "format": "date-time" }, { "type": "null" } ] } } }, "MarketplaceComponentSummary": { "type": "object", "properties": { "artifactType": { "type": [ "null", "string" ] }, "artifactSubtype": { "type": [ "null", "string" ] }, "artifactKeySnapshot": { "type": [ "null", "string" ] }, "versionLabelSnapshot": { "type": [ "null", "string" ] }, "componentRole": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "installOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "MarketplaceEntitledVersionGrant": { "type": "object", "properties": { "marketplaceEntitlementVersionGrantId": { "type": "string", "format": "uuid" }, "marketplaceEntitlementId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": [ "null", "string" ] }, "versionStatus": { "type": [ "null", "string" ] }, "grantReason": { "type": [ "null", "string" ] }, "sourceMarketplaceOrderItemId": { "type": [ "null", "string" ], "format": "uuid" }, "grantedByBuilderUserId": { "type": [ "null", "string" ], "format": "uuid" }, "grantedUtc": { "type": "string", "format": "date-time" }, "metadataJson": { "type": [ "null", "string" ] }, "isReinstallable": { "type": "boolean" } } }, "MarketplaceEntitlementAssignmentReceipt": { "type": "object", "properties": { "marketplaceEntitlementId": { "type": "string", "format": "uuid" }, "assignedSaaSAppId": { "type": "string", "format": "uuid" }, "assignedByBuilderUserId": { "type": "string", "format": "uuid" }, "assignedUtc": { "type": "string", "format": "date-time" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "grantedProductVersionId": { "type": "string", "format": "uuid" }, "licenseType": { "type": [ "null", "string" ] }, "allowUpdates": { "type": "boolean" }, "entitlementStatus": { "type": [ "null", "string" ] }, "startsUtc": { "type": "string", "format": "date-time" }, "endsUtc": { "type": [ "null", "string" ], "format": "date-time" }, "marketplaceInstallJobId": { "type": "string", "format": "uuid" } } }, "MarketplaceEntitlementVersionCatalog": { "required": [ "entitlements", "versionGrants" ], "type": "object", "properties": { "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceEntitlementVersionState" } }, "versionGrants": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceEntitledVersionGrant" } } } }, "MarketplaceEntitlementVersionState": { "type": "object", "properties": { "marketplaceEntitlementId": { "type": "string", "format": "uuid" }, "buyerCustomerAccountId": { "type": "string", "format": "uuid" }, "assignedSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "productName": { "type": [ "null", "string" ] }, "entitlementStatus": { "type": [ "null", "string" ] }, "startsUtc": { "type": "string", "format": "date-time" }, "endsUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatePolicy": { "type": [ "null", "string" ] }, "purchasedProductVersionId": { "type": "string", "format": "uuid" }, "purchasedSemanticVersion": { "type": [ "null", "string" ] }, "latestEntitledProductVersionId": { "type": "string", "format": "uuid" }, "latestEntitledSemanticVersion": { "type": [ "null", "string" ] }, "installedProductVersionId": { "type": [ "null", "string" ], "format": "uuid" }, "installedSemanticVersion": { "type": [ "null", "string" ] }, "installedStatus": { "type": [ "null", "string" ] }, "installedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "installedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "recommendedProductVersionId": { "type": [ "null", "string" ], "format": "uuid" }, "recommendedSemanticVersion": { "type": [ "null", "string" ] }, "purchasedVersionIsAccessible": { "type": "boolean" }, "entitledVersionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "updateAvailable": { "type": "boolean" }, "newCatalogVersionNotEntitled": { "type": "boolean" }, "subscriptionIsCurrent": { "type": "boolean" } } }, "MarketplaceInstallRequestReceipt": { "type": "object", "properties": { "marketplaceInstallJobId": { "type": "string", "format": "uuid" }, "marketplaceEntitlementId": { "type": "string", "format": "uuid" }, "targetSaaSAppId": { "type": "string", "format": "uuid" }, "productVersionId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": [ "null", "string" ] }, "installSelection": { "type": [ "null", "string" ] }, "installStatus": { "type": [ "null", "string" ] }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maxAttempts": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "requestedUtc": { "type": "string", "format": "date-time" }, "nextAttemptUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "MarketplaceLicenseActionReceipt": { "type": "object", "properties": { "marketplaceAppLicenseActionId": { "type": "string", "format": "uuid" }, "marketplaceEntitlementId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "actionType": { "type": [ "null", "string" ] }, "actionStatus": { "type": [ "null", "string" ] }, "entitlementStatus": { "type": [ "null", "string" ] }, "marketplaceInstalledProductId": { "type": [ "null", "string" ], "format": "uuid" }, "installedStatus": { "type": [ "null", "string" ] }, "attemptCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdUtc": { "type": "string", "format": "date-time" }, "startedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "MarketplaceLicenseActionRequest": { "required": [ "actionType", "requestId" ], "type": "object", "properties": { "actionType": { "type": "string" }, "reason": { "type": [ "null", "string" ] }, "requestId": { "type": "string", "format": "uuid" } } }, "MarketplaceOfferSummary": { "type": "object", "properties": { "marketplaceOfferId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "offerName": { "type": [ "null", "string" ] }, "billingModel": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "licenseType": { "type": [ "null", "string" ] }, "allowUpdates": { "type": "boolean" }, "trialDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "marketplacePriceId": { "type": "string", "format": "uuid" }, "currencyCode": { "type": [ "null", "string" ] }, "unitAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "MarketplaceOrderCheckoutContext": { "type": "object", "properties": { "marketplaceOrderId": { "type": "string", "format": "uuid" }, "marketplaceProductId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "marketplaceOfferId": { "type": "string", "format": "uuid" }, "marketplacePriceId": { "type": "string", "format": "uuid" }, "requestedTargetSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "productName": { "type": [ "null", "string" ] }, "productVersion": { "type": [ "null", "string" ] }, "offerName": { "type": [ "null", "string" ] }, "billingModel": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "licenseType": { "type": [ "null", "string" ] }, "allowUpdates": { "type": "boolean" }, "trialDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "currencyCode": { "type": [ "null", "string" ] }, "unitAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "orderStatus": { "type": [ "null", "string" ] }, "marketplaceEntitlementId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" } } }, "MarketplacePayoutBalance": { "type": "object", "properties": { "currencyCode": { "type": [ "null", "string" ] }, "ledgerBalanceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "availableBalanceCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "pendingPayoutCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "paidPayoutCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "failedPayoutCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "isReconciled": { "type": "boolean" } } }, "MarketplacePayoutReceipt": { "type": "object", "properties": { "marketplacePayoutId": { "type": "string", "format": "uuid" }, "currencyCode": { "type": [ "null", "string" ] }, "amountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "payoutStatus": { "type": [ "null", "string" ] }, "processor": { "type": [ "null", "string" ] }, "externalPayoutId": { "type": [ "null", "string" ] }, "requestId": { "type": [ "null", "string" ], "format": "uuid" }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "requestedUtc": { "type": "string", "format": "date-time" }, "processedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "hasFailure": { "type": "boolean" } } }, "MarketplacePayoutRequest": { "required": [ "currencyCode", "amountCents", "requestId" ], "type": "object", "properties": { "currencyCode": { "type": "string" }, "amountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "requestId": { "type": "string", "format": "uuid" } } }, "MarketplacePayoutSnapshot": { "required": [ "balances", "payouts" ], "type": "object", "properties": { "balances": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplacePayoutBalance" } }, "payouts": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplacePayoutReceipt" } } } }, "MarketplaceProductDetail": { "required": [ "product", "offers", "components" ], "type": "object", "properties": { "product": { "$ref": "#/components/schemas/MarketplaceProductHeader" }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceOfferSummary" } }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceComponentSummary" } }, "paidCheckoutReady": { "type": "boolean", "default": true }, "paidCheckoutReadinessMessage": { "type": [ "null", "string" ] } } }, "MarketplaceProductHeader": { "type": "object", "properties": { "marketplaceProductId": { "type": "string", "format": "uuid" }, "productSlug": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "shortDescription": { "type": [ "null", "string" ] }, "fullDescription": { "type": [ "null", "string" ] }, "previewImageUrl": { "type": [ "null", "string" ] }, "documentationUrl": { "type": [ "null", "string" ] }, "supportUrl": { "type": [ "null", "string" ] }, "sellerCustomerAccountId": { "type": "string", "format": "uuid" }, "storeSlug": { "type": [ "null", "string" ] }, "storeDisplayName": { "type": [ "null", "string" ] }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": [ "null", "string" ] }, "releaseNotes": { "type": [ "null", "string" ] }, "installNotes": { "type": [ "null", "string" ] }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "MarketplaceSellerOnboardingSnapshot": { "type": "object", "properties": { "customerAccountId": { "type": "string", "format": "uuid" }, "storeSlug": { "type": [ "null", "string" ] }, "storeDisplayName": { "type": [ "null", "string" ] }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] }, "logoUrl": { "type": [ "null", "string" ] }, "bannerUrl": { "type": [ "null", "string" ] }, "sellerStatus": { "type": [ "null", "string" ] }, "onboardingStatus": { "type": [ "null", "string" ] }, "chargesEnabled": { "type": "boolean" }, "payoutsEnabled": { "type": "boolean" }, "hasPayoutAccount": { "type": "boolean" }, "taxStatus": { "type": [ "null", "string" ] }, "hasTaxProfile": { "type": "boolean" }, "complianceStatus": { "type": [ "null", "string" ] }, "hasComplianceProfile": { "type": "boolean" }, "termsAcceptedVersion": { "type": [ "null", "string" ] }, "termsAcceptedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" } } }, "MarketplaceUpgradePreview": { "type": "object", "properties": { "marketplaceEntitlementId": { "type": "string", "format": "uuid" }, "targetSaaSAppId": { "type": "string", "format": "uuid" }, "currentProductVersionId": { "type": "string", "format": "uuid" }, "currentSemanticVersion": { "type": [ "null", "string" ] }, "targetProductVersionId": { "type": "string", "format": "uuid" }, "targetSemanticVersion": { "type": [ "null", "string" ] }, "targetVersionStatus": { "type": [ "null", "string" ] }, "installedStatus": { "type": [ "null", "string" ] }, "addedComponentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "removedComponentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "changedComponentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unchangedComponentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "rollbackAvailable": { "type": "boolean" }, "tenantDriftCheckRequired": { "type": "boolean" }, "driftPolicy": { "type": [ "null", "string" ] }, "canApply": { "type": "boolean" } } }, "PlatformAddOnCheckoutRequest": { "required": [ "addOnCode", "checkoutIntentId" ], "type": "object", "properties": { "addOnCode": { "type": "string" }, "checkoutIntentId": { "type": "string", "format": "uuid" } } }, "PlatformCheckoutReceipt": { "type": "object", "properties": { "checkoutUrl": { "type": [ "null", "string" ] }, "expiresUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "PlatformCheckoutRequest": { "required": [ "platformPlanId", "checkoutIntentId" ], "type": "object", "properties": { "platformPlanId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "checkoutIntentId": { "type": "string", "format": "uuid" } } }, "PublisherDebugCloseReceipt": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "debugSessionId": { "type": "string", "format": "uuid" }, "closed": { "type": "boolean" }, "queryCorrelationId": { "type": "string", "format": "uuid" } } }, "PublisherDebugEvent": { "type": "object", "properties": { "debugEventId": { "type": "string", "format": "uuid" }, "actionId": { "type": "string", "format": "uuid" }, "parentActionId": { "type": [ "null", "string" ], "format": "uuid" }, "operation": { "type": [ "null", "string" ] }, "outcome": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "durationMilliseconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "artifactType": { "type": [ "null", "string" ] }, "artifactVersionId": { "type": "string", "format": "uuid" }, "correlationId": { "type": "string", "format": "uuid" }, "failureCode": { "type": [ "null", "string" ] }, "occurredUtc": { "type": "string", "format": "date-time" } } }, "PublisherDebugSession": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "debugSessionId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "expiresUtc": { "type": "string", "format": "date-time" }, "queryCorrelationId": { "type": "string", "format": "uuid" } } }, "PublisherDebugTimeline": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "debugSessionId": { "type": "string", "format": "uuid" }, "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "expiresUtc": { "type": "string", "format": "date-time" }, "nextCreatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextEventId": { "type": [ "null", "string" ], "format": "uuid" }, "events": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PublisherDebugEvent" } } } }, "SaasBlueprintArchiveReceipt": { "type": "object", "properties": { "templatePackId": { "type": "string", "format": "uuid" }, "templatePackKey": { "type": [ "null", "string" ] }, "templatePackVersionId": { "type": "string", "format": "uuid" }, "packVersionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "archived": { "type": "boolean" }, "archivedUtc": { "type": "string", "format": "date-time" } } }, "SaasBlueprintDraftReceipt": { "type": "object", "properties": { "templatePackId": { "type": "string", "format": "uuid" }, "templatePackKey": { "type": [ "null", "string" ] }, "templatePackName": { "type": [ "null", "string" ] }, "isPublished": { "type": "boolean" }, "ownerAccountId": { "type": "string", "format": "uuid" }, "createdByUserId": { "type": "string", "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "publishedTemplatePackVersionId": { "type": [ "null", "string" ], "format": "uuid" }, "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] } } }, "SaasBlueprintDraftRequest": { "required": [ "templatePackKey", "templatePackName" ], "type": "object", "properties": { "templatePackKey": { "type": "string" }, "templatePackName": { "type": "string" }, "category": { "type": [ "null", "string" ] }, "shortDescription": { "type": [ "null", "string" ] }, "fullDescription": { "type": [ "null", "string" ] }, "previewImageUrl": { "type": [ "null", "string" ] }, "industry": { "type": [ "null", "string" ] }, "builderSettingsJson": { "type": [ "null", "string" ] }, "fallbackLanguage": { "type": [ "null", "string" ] }, "languages": { "type": [ "null", "array" ], "items": { "type": "string" } }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "SaasBlueprintPublication": { "type": "object", "properties": { "templatePackKey": { "type": [ "null", "string" ] }, "published": { "type": "boolean" }, "templatePackVersionId": { "type": "string", "format": "uuid" }, "packVersionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "artifactSchemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pinnedMemberCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "memberSetSha256": { "type": [ "null", "string" ] }, "manifestSha256": { "type": [ "null", "string" ] } } }, "SaasBlueprintValidationFinding": { "type": "object", "properties": { "severity": { "type": [ "null", "string" ] }, "area": { "type": [ "null", "string" ] }, "code": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "SaasBlueprintValidationReport": { "type": "object", "properties": { "templatePackKey": { "type": [ "null", "string" ] }, "isValid": { "type": "boolean" }, "errorCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "warningCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "findings": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SaasBlueprintValidationFinding" } } } }, "SubscriptionCancellationRequest": { "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "SubscriptionCancellationResult": { "type": "object", "properties": { "requested": { "type": "boolean" }, "cancelAtPeriodEnd": { "type": "boolean" } } }, "TemplateAuthoringCatalogItem": { "type": "object", "properties": { "key": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "scope": { "type": [ "null", "string" ] }, "itemType": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" } } }, "TemplateAuthoringDraftReceipt": { "type": "object", "properties": { "templateType": { "type": [ "null", "string" ] }, "templateKey": { "type": [ "null", "string" ] }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "templateVersionId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] } } }, "TemplateAuthoringDraftRequest": { "required": [ "templateType", "templateKey", "payloadJson" ], "type": "object", "properties": { "templateType": { "type": "string" }, "templateKey": { "type": "string" }, "payloadJson": { "type": "string" }, "cssVariables": { "type": [ "null", "string" ] }, "metaJson": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "seedFromVersionId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TemplateAuthoringFinding": { "type": "object", "properties": { "severity": { "type": [ "null", "string" ] }, "area": { "type": [ "null", "string" ] }, "code": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "TemplateAuthoringPublishReceipt": { "type": "object", "properties": { "templateType": { "type": [ "null", "string" ] }, "templateKey": { "type": [ "null", "string" ] }, "publishedUtc": { "type": "string", "format": "date-time" }, "payloadFingerprint": { "type": [ "null", "string" ] }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "templateVersionId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] } } }, "TemplateAuthoringSaveReceipt": { "type": "object", "properties": { "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": "string" }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "templateVersionId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] } } }, "TemplateAuthoringSaveRequest": { "required": [ "payloadJson" ], "type": "object", "properties": { "payloadJson": { "type": "string" }, "cssVariables": { "type": [ "null", "string" ] }, "metaJson": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] } } }, "TemplateAuthoringValidationReport": { "type": "object", "properties": { "templateType": { "type": [ "null", "string" ] }, "templateKey": { "type": [ "null", "string" ] }, "isValid": { "type": "boolean" }, "errorCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "warningCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "findings": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringFinding" } }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "templateVersionId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] } } }, "TemplateAuthoringVersionDetail": { "type": "object", "properties": { "payloadJson": { "type": [ "null", "string" ] }, "cssVariables": { "type": [ "null", "string" ] }, "metaJson": { "type": [ "null", "string" ] }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "templateVersionId": { "type": "string", "format": "uuid" }, "templateType": { "type": [ "null", "string" ] }, "templateKey": { "type": [ "null", "string" ] }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "payloadFingerprint": { "type": [ "null", "string" ] }, "isOwned": { "type": "boolean" }, "isEditable": { "type": "boolean" } } }, "TemplateAuthoringVersionSummary": { "type": "object", "properties": { "templateVersionId": { "type": "string", "format": "uuid" }, "templateType": { "type": [ "null", "string" ] }, "templateKey": { "type": [ "null", "string" ] }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "modifiedUtc": { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,7})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$", "type": [ "null", "string" ] }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "payloadFingerprint": { "type": [ "null", "string" ] }, "isOwned": { "type": "boolean" }, "isEditable": { "type": "boolean" } } }, "TemplateAuthoringWorkspace": { "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "selectedVersion": { "$ref": "#/components/schemas/TemplateAuthoringVersionDetail" }, "versions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringVersionSummary" } }, "blueprints": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringCatalogItem" } }, "components": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringCatalogItem" } }, "bindings": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringCatalogItem" } }, "connectors": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringCatalogItem" } }, "userTypes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringCatalogItem" } }, "shellAssets": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TemplateAuthoringCatalogItem" } } } } }, "securitySchemes": { "BuilderSession": { "type": "http", "description": "Existing Builder login/session token. App API keys and delegated TenantUser tokens are not accepted.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "BuilderBranding" }, { "name": "BuilderCommunicationSettings" }, { "name": "BuilderAccountProfile" }, { "name": "BuilderApiClients" }, { "name": "BuilderAppObservability" }, { "name": "BuilderApps" }, { "name": "BuilderAudit" }, { "name": "BuilderBackups" }, { "name": "BuilderBillingCatalog" }, { "name": "BuilderBillingCustomer" }, { "name": "BuilderBillingHistory" }, { "name": "BuilderBillingResources" }, { "name": "BuilderBuildSpec" }, { "name": "BuilderCostTelemetry" }, { "name": "BuilderDomains" }, { "name": "BuilderHarnessAdministration" }, { "name": "BuilderHarnessConsole" }, { "name": "BuilderMarketplaceAdministration" }, { "name": "BuilderMarketplaceCheckout" }, { "name": "BuilderMarketplace" }, { "name": "BuilderMarketplaceEntitlementAssignment" }, { "name": "BuilderMarketplaceInstallRequest" }, { "name": "BuilderMarketplaceLicense" }, { "name": "BuilderMarketplacePayout" }, { "name": "BuilderMarketplaceSeller" }, { "name": "BuilderMarketplaceSellerWorkspace" }, { "name": "BuilderMarketplaceUpgrade" }, { "name": "BuilderPlatformAddOnCheckout" }, { "name": "BuilderPlatformCheckout" }, { "name": "BuilderResourceAllocations" }, { "name": "BuilderRuntimeControl" }, { "name": "BuilderSecurityCenter" }, { "name": "BuilderSubscriptionCancellation" }, { "name": "BuilderTeam" }, { "name": "BuilderTemplateAdministration" }, { "name": "BuilderTemplateAuthoring" }, { "name": "BuilderTemplateHarvest" }, { "name": "BuilderUsageAlerts" }, { "name": "DeveloperProblemIndex" }, { "name": "PublisherDebugTimeline" } ] }