{ "openapi": "3.1.0", "info": { "title": "PetroSupport Partner API", "version": "1.1.0", "description": "Fleet and response integration. Register for an isolated sandbox; production requires administrator approval." }, "servers": [ { "url": "/api/partner/v1" } ], "paths": { "/fleet/drivers": { "get": { "operationId": "fleet.drivers", "summary": "List drivers mapped by this application", "tags": [ "fleet" ], "x-required-scope": "fleet:read", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "required": false } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetDriverList" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/fleet/drivers/{external}": { "put": { "operationId": "fleet.upsert", "summary": "Create or update a driver using your external ID", "tags": [ "fleet" ], "x-required-scope": "fleet:write", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "external", "in": "path", "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,120}$" }, "required": true }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "required": true } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetDriverEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "201": { "description": "Driver mapping created", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetDriverEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetDriverWrite" } } } } } }, "/fleet/drivers/{external}/invitation": { "post": { "operationId": "fleet.invite", "summary": "Request a single-use driver setup invitation", "tags": [ "fleet" ], "x-required-scope": "fleet:write", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "external", "in": "path", "schema": { "type": "string", "maxLength": 120 }, "required": true }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "required": true } ], "responses": { "202": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverInvitationEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } } } } }, "/services": { "get": { "operationId": "services.list", "summary": "List supported services", "tags": [ "services" ], "x-required-scope": "services:read", "security": [ { "partnerBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCatalogueEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/coverage": { "get": { "operationId": "coverage.assess", "summary": "Assess available matching capacity; does not reserve a unit", "tags": [ "coverage" ], "x-required-scope": "coverage:read", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "latitude", "in": "query", "schema": { "type": "number", "minimum": -90, "maximum": 90 }, "required": true }, { "name": "longitude", "in": "query", "schema": { "type": "number", "minimum": -180, "maximum": 180 }, "required": true }, { "name": "service", "in": "query", "schema": { "type": "string", "enum": [ "medical", "security", "recovery" ] }, "required": true } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageAssessmentEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/incidents": { "get": { "operationId": "incidents.list", "summary": "List incidents created by this application", "tags": [ "incidents" ], "x-required-scope": "incidents:read", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "required": false }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "required": false } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentList" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "incidents.create", "summary": "Create an incident without automatic dispatch", "tags": [ "incidents" ], "x-required-scope": "incidents:write", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "required": true } ], "responses": { "201": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentCreate" } } } } } }, "/incidents/{incident}": { "get": { "operationId": "incidents.get", "summary": "Read incident and service task states", "tags": [ "incidents" ], "x-required-scope": "incidents:read", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "incident", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/incidents/{incident}/events": { "get": { "operationId": "events.list", "summary": "Reconcile ordered incident events", "tags": [ "events" ], "x-required-scope": "incidents:read", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "incident", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "after", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "required": false } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventList" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/incidents/{incident}/tasks/{task}/dispatch": { "post": { "operationId": "dispatch.request", "summary": "Live only: offer task to eligible providers", "tags": [ "dispatch" ], "x-required-scope": "dispatch:write", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "incident", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "task", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "required": true } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchResultEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } } } } }, "/simulations": { "post": { "operationId": "sandbox.transition", "summary": "Sandbox only: advance a simulated response stage", "tags": [ "sandbox" ], "x-required-scope": "incidents:write", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "required": true } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Simulation" } } } } } }, "/webhook-endpoints": { "get": { "operationId": "webhooks.list", "summary": "List endpoints without signing secrets", "tags": [ "webhooks" ], "x-required-scope": "webhooks:manage", "security": [ { "partnerBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookList" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "post": { "operationId": "webhooks.create", "summary": "Register an endpoint and receive signing secret", "tags": [ "webhooks" ], "x-required-scope": "webhooks:manage", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "required": true } ], "responses": { "201": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookIssuedEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } } } } }, "/webhook-endpoints/{webhook}": { "delete": { "operationId": "webhooks.disable", "summary": "Disable an owned endpoint", "tags": [ "webhooks" ], "x-required-scope": "webhooks:manage", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "webhook", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "required": true } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDisabledEnvelope" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } } } } }, "/webhook-deliveries": { "get": { "operationId": "deliveries.list", "summary": "Read delivery attempts and outcomes", "tags": [ "deliveries" ], "x-required-scope": "webhooks:manage", "security": [ { "partnerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "required": false } ], "responses": { "200": { "description": "Successful operation", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Idempotent-Replayed": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryList" } } } }, "400": { "description": "Malformed JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Invalid, expired or revoked credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient scope or invalid environment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Owned resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Idempotency or lifecycle conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate limited; inspect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Internal error; provide request ID to support", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "API access disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } } }, "components": { "schemas": { "FleetDriverWrite": { "type": "object", "properties": { "first_name": { "type": "string", "maxLength": 100 }, "last_name": { "type": "string", "maxLength": 100 }, "email": { "type": "string", "format": "email", "maxLength": 191 }, "phone": { "type": "string", "maxLength": 20 }, "status": { "type": "string", "enum": [ "active", "inactive" ] } }, "required": [ "first_name", "last_name", "email", "phone", "status" ], "additionalProperties": false }, "FleetDriver": { "type": "object", "properties": { "external_id": { "type": "string" }, "driver_id": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "sandbox", "live" ] }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "suspended", "unavailable" ] }, "account_ready": { "type": "boolean" } }, "required": [ "external_id", "driver_id", "environment", "status" ] }, "FleetDriverEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FleetDriver" } }, "required": [ "data" ] }, "FleetDriverList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FleetDriver" } }, "meta": { "$ref": "#/components/schemas/PageMeta" } }, "required": [ "data", "meta" ] }, "DriverInvitation": { "type": "object", "properties": { "external_id": { "type": "string" }, "invitation_status": { "type": "string", "enum": [ "submitted", "simulated" ] }, "email_sent": { "type": [ "boolean", "null" ], "description": "Null means delivery is not confirmed." }, "expires_in_seconds": { "type": "integer" } }, "required": [ "external_id", "invitation_status", "email_sent" ] }, "DriverInvitationEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DriverInvitation" } }, "required": [ "data" ] }, "Empty": { "type": "object", "additionalProperties": false }, "IncidentCreate": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 180, "minLength": 1 }, "priority": { "type": "string", "enum": [ "critical", "high", "normal" ] }, "requested_by": { "type": "string", "format": "uuid", "description": "Active fleet driver UUID; sandbox accepts a test UUID." }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "services": { "type": "array", "minItems": 1, "maxItems": 3, "uniqueItems": true, "items": { "type": "string", "enum": [ "medical", "security", "recovery" ] } }, "external_reference": { "type": "string", "maxLength": 120 }, "requirements": { "type": "object", "properties": { "recovery": { "type": "object", "properties": { "capacity_kg": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "equipment": { "type": "array", "maxItems": 10, "uniqueItems": true, "items": { "type": "string", "enum": [ "flatbed", "winch", "crane", "wheel_lift", "heavy_recovery" ] } } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } }, "required": [ "title", "priority", "requested_by", "latitude", "longitude", "services" ], "additionalProperties": false }, "Simulation": { "type": "object", "properties": { "incident_id": { "type": "string", "format": "uuid" }, "task_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "accepted", "en_route", "arrived", "working", "completed" ] } }, "required": [ "incident_id", "task_id", "status" ], "additionalProperties": false }, "WebhookCreate": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "events": { "type": "array", "minItems": 1, "maxItems": 20, "uniqueItems": true, "items": { "type": "string", "enum": [ "incident.created", "incident.closed", "task.offered", "task.accepted", "task.en_route", "task.arrived", "task.working", "task.completed", "task.status_changed", "incident.simulated" ] } } }, "required": [ "url", "events" ], "additionalProperties": false }, "Task": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "service": { "type": "string", "enum": [ "medical", "security", "recovery" ] }, "status": { "type": "string" } }, "required": [ "id", "service", "status" ] }, "Incident": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "sandbox", "live" ] }, "external_reference": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "priority": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "latest_sequence": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "environment", "title", "priority", "status", "tasks", "latest_sequence", "created_at" ] }, "IncidentEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Incident" } }, "required": [ "data" ] }, "IncidentList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } }, "meta": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] } }, "required": [ "data", "meta" ] }, "DataEnvelope": { "type": "object", "properties": { "data": { "type": [ "object", "array" ] }, "meta": { "type": "object" } }, "required": [ "data" ] }, "Event": { "type": "object", "properties": { "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": [ "incident.created", "incident.closed", "task.offered", "task.accepted", "task.en_route", "task.arrived", "task.working", "task.completed", "task.status_changed", "incident.simulated" ] }, "schema_version": { "type": "string", "const": "1" }, "sequence": { "type": "integer", "minimum": 1 }, "incident_id": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "sandbox", "live" ] }, "occurred_at": { "type": "string", "format": "date-time" }, "data": { "type": "object" } }, "required": [ "event_id", "event_type", "schema_version", "sequence", "incident_id", "environment", "occurred_at", "data" ] }, "EventList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "meta": { "type": "object", "properties": { "next_after": { "type": "integer" }, "latest_sequence": { "type": "integer" } }, "required": [ "next_after", "latest_sequence" ] } }, "required": [ "data", "meta" ] }, "ErrorEnvelope": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object" } }, "required": [ "code", "message", "details" ] } }, "required": [ "request_id", "error" ] }, "PageMeta": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 } }, "required": [ "page", "last_page" ] }, "ServiceCatalogue": { "type": "object", "properties": { "version": { "type": "string" }, "services": { "type": "array", "items": { "type": "string", "enum": [ "medical", "security", "recovery" ] } }, "dispatch": { "type": "string" } }, "required": [ "version", "services", "dispatch" ] }, "CoverageAssessment": { "type": "object", "properties": { "environment": { "type": "string", "enum": [ "sandbox", "live" ] }, "service": { "type": "string", "enum": [ "medical", "security", "recovery" ] }, "coverage_status": { "type": "string", "enum": [ "simulated", "matching_capacity_observed", "no_matching_capacity_observed" ] }, "candidate_count": { "type": "integer", "minimum": 0 }, "availability_confirmed": { "type": "boolean", "const": false }, "observed_at": { "type": "string", "format": "date-time" } }, "required": [ "environment", "service", "coverage_status", "candidate_count", "availability_confirmed", "observed_at" ] }, "DispatchResult": { "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid" }, "offered_count": { "type": "integer", "minimum": 0 }, "message": { "type": "string" } }, "required": [ "task_id", "offered_count", "message" ] }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "incident.created", "incident.closed", "task.offered", "task.accepted", "task.en_route", "task.arrived", "task.working", "task.completed", "task.status_changed", "incident.simulated" ] } }, "enabled": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "events", "enabled", "created_at" ] }, "WebhookIssued": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "signing_secret": { "type": "string", "minLength": 64, "maxLength": 64 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "incident.created", "incident.closed", "task.offered", "task.accepted", "task.en_route", "task.arrived", "task.working", "task.completed", "task.status_changed", "incident.simulated" ] } } }, "required": [ "id", "url", "signing_secret", "events" ] }, "WebhookDisabled": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean", "const": false } }, "required": [ "id", "enabled" ] }, "Delivery": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "webhook_id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "queued", "sending", "retry", "delivered", "failed", "cancelled" ] }, "attempts": { "type": "integer", "minimum": 0 }, "http_status": { "type": [ "integer", "null" ] }, "last_error": { "type": [ "string", "null" ] }, "next_attempt_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "webhook_id", "event_id", "status", "attempts", "http_status", "last_error", "next_attempt_at" ] }, "ServiceCatalogueEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ServiceCatalogue" } }, "required": [ "data" ] }, "CoverageAssessmentEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CoverageAssessment" } }, "required": [ "data" ] }, "DispatchResultEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DispatchResult" } }, "required": [ "data" ] }, "WebhookIssuedEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookIssued" } }, "required": [ "data" ] }, "WebhookDisabledEnvelope": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookDisabled" } }, "required": [ "data" ] }, "WebhookList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } }, "required": [ "data" ] }, "DeliveryList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Delivery" } }, "meta": { "$ref": "#/components/schemas/PageMeta" } }, "required": [ "data", "meta" ] } }, "securitySchemes": { "partnerBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "credential-uuid.secret", "description": "Scoped server credential issued through the developer console or administrator. This is not OAuth." } } } }