{ "openapi": "3.1.1", "info": { "title": "BuildWithHQ Platform Account API", "description": "Billing/storage and marketplace/template add-on management. Requires a verified Builder JWT session; SQL enforces CustomerAccount ownership and action permissions. Tenant organization billing belongs to the separate app-scoped Developer API. Payment readiness and permissions still apply to every operation.", "version": "v1" }, "servers": [ { "url": "https://api.buildwithhq.com" } ], "paths": { "/v1/platform/apps/starter-templates": { "get": { "tags": [ "BuilderApps" ], "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 or installation 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/billing/catalog": { "get": { "tags": [ "BuilderBillingCatalog" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderBillingCatalogGetAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderBillingCustomerEnsureMappedAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderBillingResourcesGetAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderCostTelemetryGetAsync", "parameters": [ { "name": "periodStartUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationListAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderHarnessAdministrationGetAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderHarnessConsoleGetEvaluationsAsync", "parameters": [ { "name": "harnessPackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderHarnessConsoleGetInstallationsAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationGetAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationGetProductsAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationGetProductAsync", "parameters": [ { "name": "marketplaceProductId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationSubmitVersionAsync", "parameters": [ { "name": "marketplaceProductVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceAdministrationActivateOfferAsync", "parameters": [ { "name": "marketplaceOfferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceLicenseGetStatusAsync", "parameters": [ { "name": "marketplaceAppLicenseActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation 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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceGetRevenueAsync", "parameters": [ { "name": "currencyCode", "in": "query", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceGetArtifactsAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceGetCompositionAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceSellerWorkspaceSetRecommendedAsync", "parameters": [ { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderMarketplaceUpgradePreviewAsync", "parameters": [ { "name": "marketplaceEntitlementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "targetProductVersionId", "in": "query", "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" ], "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 or installation 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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderResourceAllocationsGetAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationListAsync", "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationValidateAsync", "parameters": [ { "name": "templatePackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderTemplateAdministrationPublishAsync", "parameters": [ { "name": "templatePackKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation 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" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderTemplateAuthoringValidateAsync", "parameters": [ { "name": "templateVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderTemplateAuthoringPublishAsync", "parameters": [ { "name": "templateVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "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" ], "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 or installation 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": { "200": { "description": "OK" }, "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" ], "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 or installation without configured readiness and permissions.", "operationId": "platformBuilderUsageAlertsGetAsync", "responses": { "200": { "description": "OK" }, "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": { "BuilderMarketplaceActionBindingRequest": { "type": "object", "properties": { "actionKey": { "type": [ "null", "string" ] }, "applianceSellerArtifactId": { "type": "string", "format": "uuid" }, "endpointKey": { "type": [ "null", "string" ] }, "requestMappingJson": { "type": [ "null", "string" ] }, "responseMappingJson": { "type": [ "null", "string" ] }, "failurePolicyJson": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceArtifactRegistrationRequest": { "type": "object", "properties": { "artifactVersionId": { "type": "string", "format": "uuid" }, "sourceSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" } } }, "BuilderMarketplaceAvailabilityRequest": { "type": "object", "properties": { "isAvailable": { "type": "boolean" } } }, "BuilderMarketplaceCheckoutRequest": { "required": [ "marketplacePriceId", "checkoutIntentId" ], "type": "object", "properties": { "marketplacePriceId": { "type": "string", "format": "uuid" }, "requestedTargetSaaSAppId": { "type": [ "null", "string" ], "format": "uuid" }, "checkoutIntentId": { "type": "string", "format": "uuid" } } }, "BuilderMarketplaceComponentRequest": { "type": "object", "properties": { "sellerArtifactId": { "type": "string", "format": "uuid" }, "componentRole": { "type": [ "null", "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": { "type": "string", "format": "uuid" } } }, "BuilderMarketplaceEntitlementsResponse": { "required": [ "entitlements" ], "type": "object", "properties": { "entitlements": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/MarketplaceBuyerEntitlement" } } } }, "BuilderMarketplaceInstallRequest": { "type": "object", "properties": { "marketplaceProductVersionId": { "type": [ "null", "string" ], "format": "uuid" } } }, "BuilderMarketplaceOfferRequest": { "type": "object", "properties": { "marketplaceProductVersionId": { "type": "string", "format": "uuid" }, "offerName": { "type": [ "null", "string" ] }, "billingModel": { "type": [ "null", "string" ] }, "billingInterval": { "type": [ "null", "string" ] }, "allowUpdates": { "type": "boolean" }, "trialDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "BuilderMarketplacePriceRequest": { "type": "object", "properties": { "currencyCode": { "type": [ "null", "string" ] }, "unitAmountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "BuilderMarketplaceProductMetadataRequest": { "type": "object", "properties": { "productName": { "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" ] } } }, "BuilderMarketplaceProductRequest": { "type": "object", "properties": { "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" ] }, "visibility": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceProductsResponse": { "required": [ "products" ], "type": "object", "properties": { "products": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/MarketplaceCatalogItem" } } } }, "BuilderMarketplaceSellerCreateRequest": { "type": "object", "properties": { "storeSlug": { "type": [ "null", "string" ] }, "storeDisplayName": { "type": [ "null", "string" ] }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceSellerRequest": { "type": "object", "properties": { "storeSlug": { "type": [ "null", "string" ] }, "storeDisplayName": { "type": [ "null", "string" ] }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceSellerTermsRequest": { "type": "object", "properties": { "termsVersion": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceSellerUpdateRequest": { "type": "object", "properties": { "storeDisplayName": { "type": [ "null", "string" ] }, "storeDescription": { "type": [ "null", "string" ] }, "supportEmail": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] }, "logoUrl": { "type": [ "null", "string" ] }, "bannerUrl": { "type": [ "null", "string" ] } } }, "BuilderMarketplaceUpgradeRequest": { "type": "object", "properties": { "expectedCurrentProductVersionId": { "type": "string", "format": "uuid" }, "targetProductVersionId": { "type": "string", "format": "uuid" } } }, "BuilderMarketplaceVersionRequest": { "type": "object", "properties": { "marketplaceProductId": { "type": "string", "format": "uuid" }, "semanticVersion": { "type": [ "null", "string" ] }, "releaseNotes": { "type": [ "null", "string" ] }, "installNotes": { "type": [ "null", "string" ] } } }, "BuilderResourceAllocationUpdate": { "type": "object", "properties": { "allocatedPrimaryGb": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "allocatedLogFileGb": { "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" }, "notes": { "type": [ "null", "string" ] }, "expectedRowVersion": { "type": [ "null", "string" ] } } }, "BuilderStarterTemplate": { "required": [ "templatePackVersionId", "templatePackKey", "templatePackName", "versionNumber", "isDefault" ], "type": "object", "properties": { "templatePackVersionId": { "type": "string", "format": "uuid" }, "templatePackKey": { "type": [ "null", "string" ] }, "templatePackName": { "type": [ "null", "string" ] }, "versionNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isDefault": { "type": "boolean" } } }, "BuilderStarterTemplatesResponse": { "required": [ "templates" ], "type": "object", "properties": { "templates": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BuilderStarterTemplate" } } } }, "BuilderTemplateArchiveRequest": { "type": "object", "properties": { "expectedTemplatePackVersionId": { "type": "string", "format": "uuid" } } }, "BuilderTemplateHarvestRequest": { "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid" }, "artifactType": { "type": [ "null", "string" ] }, "sourceKey": { "type": [ "null", "string" ] }, "templatePackKey": { "type": [ "null", "string" ] }, "targetTemplateKey": { "type": [ "null", "string" ] }, "templateName": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] } } }, "ControlPlaneErrorResponse": { "required": [ "code", "error", "correlationId" ], "type": "object", "properties": { "code": { "type": [ "null", "string" ] }, "error": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" } } }, "HarnessComponentDraftRequest": { "type": "object", "properties": { "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" } } }, "HarnessEvalCaseDraftRequest": { "type": "object", "properties": { "harnessEvalSetId": { "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" } } }, "HarnessEvalSetDraftRequest": { "type": "object", "properties": { "evalSetName": { "type": [ "null", "string" ] }, "isPublishGate": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "HarnessEvaluationQueueRequest": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" } } }, "HarnessPackDraftRequest": { "type": "object", "properties": { "harnessPackKey": { "type": [ "null", "string" ] }, "packName": { "type": [ "null", "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" } } }, "HarnessVersionDraftRequest": { "type": "object", "properties": { "changeNote": { "type": [ "null", "string" ] } } }, "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": { "type": [ "null", "string" ], "format": "uri" }, "checkoutExpiresUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "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": [ "null", "array" ], "items": { "$ref": "#/components/schemas/MarketplaceEntitlementVersionState" } }, "versionGrants": { "type": [ "null", "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": { "type": "object", "properties": { "actionType": { "type": [ "null", "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" } } }, "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": { "type": "object", "properties": { "currencyCode": { "type": [ "null", "string" ] }, "amountCents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "requestId": { "type": "string", "format": "uuid" } } }, "MarketplaceProductDetail": { "required": [ "product", "offers", "components" ], "type": "object", "properties": { "product": { "$ref": "#/components/schemas/MarketplaceProductHeader" }, "offers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/MarketplaceOfferSummary" } }, "components": { "type": [ "null", "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": { "type": "string", "format": "date-time" } } }, "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": { "type": "object", "properties": { "addOnCode": { "type": [ "null", "string" ] }, "checkoutIntentId": { "type": "string", "format": "uuid" } } }, "PlatformCheckoutRequest": { "type": "object", "properties": { "platformPlanId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "checkoutIntentId": { "type": "string", "format": "uuid" } } }, "SaasBlueprintDraftRequest": { "type": "object", "properties": { "templatePackKey": { "type": [ "null", "string" ] }, "templatePackName": { "type": [ "null", "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" } } }, "SubscriptionCancellationRequest": { "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "TemplateAuthoringDraftRequest": { "type": "object", "properties": { "templateType": { "type": [ "null", "string" ] }, "templateKey": { "type": [ "null", "string" ] }, "payloadJson": { "type": [ "null", "string" ] }, "cssVariables": { "type": [ "null", "string" ] }, "metaJson": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "seedFromVersionId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TemplateAuthoringSaveRequest": { "type": "object", "properties": { "payloadJson": { "type": [ "null", "string" ] }, "cssVariables": { "type": [ "null", "string" ] }, "metaJson": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] } } } }, "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": "BuilderApps" }, { "name": "BuilderBillingCatalog" }, { "name": "BuilderBillingCustomer" }, { "name": "BuilderBillingHistory" }, { "name": "BuilderBillingResources" }, { "name": "BuilderCostTelemetry" }, { "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": "BuilderSubscriptionCancellation" }, { "name": "BuilderTemplateAdministration" }, { "name": "BuilderTemplateAuthoring" }, { "name": "BuilderTemplateHarvest" }, { "name": "BuilderUsageAlerts" } ] }