{ "openapi": "3.1.0", "info": { "title": "ReadyCar Exchange API", "version": "0.2.0", "summary": "The transaction and orchestration API for autonomous fleet services.", "description": "POC contract for provider supply, vehicle demand, marketplace matching, SiteMap guidance, ASV verification, payment-partner coordination, and event delivery. Financial operations use an adapter and do not make ReadyCar a holder of funds.", "contact": { "name": "ReadyCar API Team", "email": "ImReady@readycar.com", "url": "https://www.readycar.com/" }, "license": { "name": "Proprietary - evaluation use only" } }, "servers": [ { "url": "https://api.readycar.com", "description": "Planned production endpoint" }, { "url": "https://{apiId}.execute-api.{region}.amazonaws.com", "description": "AWS deployment endpoint", "variables": { "apiId": { "default": "replace-me" }, "region": { "default": "us-west-2" } } } ], "tags": [ { "name": "Platform" }, { "name": "Identity" }, { "name": "Providers" }, { "name": "Facilities" }, { "name": "SiteMap" }, { "name": "SiteMap Capture" }, { "name": "SiteMap Validation" }, { "name": "Services" }, { "name": "Capacity" }, { "name": "Pricing" }, { "name": "Fleets" }, { "name": "Vehicles" }, { "name": "Telemetry" }, { "name": "Catalog" }, { "name": "Marketplace" }, { "name": "Auctions" }, { "name": "Reservations" }, { "name": "ASV" }, { "name": "Mobile" }, { "name": "ASV Mobile" }, { "name": "Payments" }, { "name": "Trust" }, { "name": "Webhooks" }, { "name": "Uploads" }, { "name": "Audit" } ], "paths": { "/health": { "get": { "operationId": "getHealth", "summary": "Service health", "tags": [ "Platform" ], "security": [], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": null } }, "/v1/me": { "get": { "operationId": "getCurrentPrincipal", "summary": "Current API principal", "tags": [ "Identity" ], "security": [ { "OAuth2": [ "readycar/profile.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/profile.read" } }, "/v1/providers": { "post": { "operationId": "createProvider", "summary": "Register a provider", "tags": [ "Providers" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/provider.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/provider.write" }, "get": { "operationId": "listProviders", "summary": "List providers", "tags": [ "Providers" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/provider.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/provider.read" } }, "/v1/providers/{provider_id}": { "get": { "operationId": "getProvider", "summary": "Get a provider", "tags": [ "Providers" ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/provider.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/provider.read" }, "patch": { "operationId": "updateProvider", "summary": "Update a provider", "tags": [ "Providers" ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/provider.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/provider.write" } }, "/v1/providers/{provider_id}/verification-documents": { "post": { "operationId": "createProviderVerificationDocument", "summary": "Register provider verification evidence", "tags": [ "Providers" ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/provider.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/provider.write" } }, "/v1/providers/{provider_id}/payment-accounts": { "post": { "operationId": "createProviderPaymentAccount", "summary": "Link a payment-partner account", "description": "Stores only a payment-partner reference. ReadyCar does not store bank credentials.", "tags": [ "Providers" ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/payment.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/payment.write" } }, "/v1/providers/{provider_id}/facilities": { "post": { "operationId": "createFacility", "summary": "Register a facility", "tags": [ "Facilities" ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/facility.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Facility" }, { "type": "array", "items": { "$ref": "#/components/schemas/Facility" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.write" } }, "/v1/facilities": { "get": { "operationId": "listFacilities", "summary": "List facilities", "tags": [ "Facilities" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/facility.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Facility" }, { "type": "array", "items": { "$ref": "#/components/schemas/Facility" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.read" }, "post": { "operationId": "createFacilityForSiteMap", "summary": "Register a facility from the SiteMap app", "description": "Mobile-friendly alias. The provider_id is supplied in the request body.", "tags": [ "SiteMap" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/facility.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Facility" }, { "type": "array", "items": { "$ref": "#/components/schemas/Facility" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.write" } }, "/v1/facilities/{facility_id}": { "get": { "operationId": "getFacility", "summary": "Get a facility", "tags": [ "Facilities" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/facility.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Facility" }, { "type": "array", "items": { "$ref": "#/components/schemas/Facility" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.read" }, "patch": { "operationId": "updateFacility", "summary": "Update a facility", "tags": [ "Facilities" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/facility.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Facility" }, { "type": "array", "items": { "$ref": "#/components/schemas/Facility" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.write" } }, "/v1/facilities/{facility_id}/conditions": { "post": { "operationId": "publishFacilityCondition", "summary": "Publish a scoped facility condition", "tags": [ "Facilities" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/facility.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.write" }, "get": { "operationId": "listFacilityConditions", "summary": "List facility conditions", "tags": [ "Facilities" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/facility.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.read" } }, "/v1/facilities/{facility_id}/activity": { "get": { "operationId": "listFacilityActivity", "summary": "List facility activity and audit events", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/audit.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/audit.read" } }, "/v1/facilities/{facility_id}/facility-resources": { "post": { "operationId": "createFacilityResource", "summary": "Create a commercial or navigational facility resource", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/facility.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityResource" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityResource" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.write" } }, "/v1/facility-resources/{facility_resource_id}": { "get": { "operationId": "getFacilityResource", "summary": "Get a facility resource", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_resource_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/facility.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityResource" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityResource" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.read" }, "patch": { "operationId": "updateFacilityResource", "summary": "Update a facility resource commercial facet", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_resource_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/facility.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityResource" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityResource" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.write" }, "delete": { "operationId": "deleteFacilityResource", "summary": "Delete a draft facility resource", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_resource_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/resource.write" ] } ], "responses": { "204": { "description": "Deleted." }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/resource.write" } }, "/v1/facility-resources/{facility_resource_id}/spatial-profiles": { "post": { "operationId": "publishSpatialProfile", "summary": "Publish an immutable spatial profile version", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_resource_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/facility.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.write" }, "get": { "operationId": "listSpatialProfiles", "summary": "List spatial profile versions", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_resource_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/facility.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/facility.read" } }, "/v1/facilities/{facility_id}/maps": { "get": { "operationId": "listFacilityMaps", "summary": "List immutable and draft facility map versions", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/map.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.read" }, "post": { "operationId": "createFacilityMap", "summary": "Create a draft facility map version", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.capture" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.capture" } }, "/v1/facility-maps/{map_id}": { "get": { "operationId": "getFacilityMap", "summary": "Get a facility map version", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/map.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.read" }, "patch": { "operationId": "updateFacilityMap", "summary": "Update a draft facility map", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.capture" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.capture" } }, "/v1/facility-maps/{map_id}/submit": { "post": { "operationId": "submitFacilityMap", "summary": "Submit a facility map for ReadyCar review", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.submit" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.submit" } }, "/v1/facility-maps/{map_id}/approve": { "post": { "operationId": "approveFacilityMap", "summary": "Approve a reviewed facility map", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.approve" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.approve" } }, "/v1/facility-maps/{map_id}/publish": { "post": { "operationId": "publishFacilityMap", "summary": "Publish an approved immutable facility map", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.publish" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.publish" } }, "/v1/facility-maps/{map_id}/suspend": { "post": { "operationId": "suspendFacilityMap", "summary": "Suspend an active facility map", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.approve" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.approve" } }, "/v1/facility-maps/{map_id}/retire": { "post": { "operationId": "retireFacilityMap", "summary": "Retire a facility map version", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.approve" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMap" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMap" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.approve" } }, "/v1/facility-maps/{map_id}/nodes": { "post": { "operationId": "createFacilityMapNode", "summary": "Create an entry, exit, checkpoint, stop, or graph node", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMapNode" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMapNode" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" } }, "/v1/facility-map-nodes/{node_id}": { "patch": { "operationId": "updateFacilityMapNode", "summary": "Update a facility map node", "tags": [ "SiteMap" ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityMapNode" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityMapNode" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" }, "delete": { "operationId": "deleteFacilityMapNode", "summary": "Delete a facility map node", "tags": [ "SiteMap" ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "responses": { "204": { "description": "Deleted." }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" } }, "/v1/facility-maps/{map_id}/routes": { "post": { "operationId": "createFacilityRoute", "summary": "Create a directed facility route edge", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityRoute" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityRoute" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" } }, "/v1/facility-routes/{route_id}": { "patch": { "operationId": "updateFacilityRoute", "summary": "Update a directed facility route edge", "tags": [ "SiteMap" ], "parameters": [ { "name": "route_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityRoute" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityRoute" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" }, "delete": { "operationId": "deleteFacilityRoute", "summary": "Delete a directed facility route edge", "tags": [ "SiteMap" ], "parameters": [ { "name": "route_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "responses": { "204": { "description": "Deleted." }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" } }, "/v1/facility-maps/{map_id}/zones": { "post": { "operationId": "createFacilityZone", "summary": "Create a property, safety, pedestrian, or exclusion zone", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityZone" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityZone" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" } }, "/v1/facility-zones/{zone_id}": { "patch": { "operationId": "updateFacilityZone", "summary": "Update a facility map zone", "tags": [ "SiteMap" ], "parameters": [ { "name": "zone_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityZone" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityZone" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" }, "delete": { "operationId": "deleteFacilityZone", "summary": "Delete a facility map zone", "tags": [ "SiteMap" ], "parameters": [ { "name": "zone_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/route.write" ] } ], "responses": { "204": { "description": "Deleted." }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/route.write" } }, "/v1/facility-maps/{map_id}/resources": { "get": { "operationId": "listFacilityMapResources", "summary": "List facility resources bound to a map version", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/map.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityResource" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityResource" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.read" }, "post": { "operationId": "createFacilityMapResource", "summary": "Create a canonical facility resource with a spatial facet", "tags": [ "SiteMap" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/resource.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/FacilityResource" }, { "type": "array", "items": { "$ref": "#/components/schemas/FacilityResource" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/resource.write" } }, "/v1/facility-resources/{facility_resource_id}/media": { "post": { "operationId": "createFacilityResourceMedia", "summary": "Attach visual localization media metadata", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_resource_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/media.upload" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/media.upload" } }, "/v1/facility-resources/{facility_resource_id}/markers": { "post": { "operationId": "createFacilityResourceMarker", "summary": "Attach a physical or visual localization marker", "tags": [ "SiteMap" ], "parameters": [ { "name": "facility_resource_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/resource.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/resource.write" } }, "/v1/facility-maps/{map_id}/capture-sessions": { "post": { "operationId": "createSiteMapCaptureSession", "summary": "Start a durable SiteMap sensor capture session", "tags": [ "SiteMap Capture" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.capture" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/SiteMapCaptureSession" }, { "type": "array", "items": { "$ref": "#/components/schemas/SiteMapCaptureSession" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.capture" } }, "/v1/capture-sessions/{capture_session_id}": { "patch": { "operationId": "updateSiteMapCaptureSession", "summary": "Pause, resume, or update a SiteMap capture session", "tags": [ "SiteMap Capture" ], "parameters": [ { "name": "capture_session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.capture" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/SiteMapCaptureSession" }, { "type": "array", "items": { "$ref": "#/components/schemas/SiteMapCaptureSession" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.capture" } }, "/v1/capture-sessions/{capture_session_id}/samples:batch": { "post": { "operationId": "uploadSiteMapCaptureSamples", "summary": "Append a compressed idempotent sensor sample batch", "tags": [ "SiteMap Capture" ], "parameters": [ { "name": "capture_session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.capture" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.capture" } }, "/v1/capture-sessions/{capture_session_id}/media": { "post": { "operationId": "createSiteMapCaptureMedia", "summary": "Attach capture media metadata or an upload reference", "tags": [ "SiteMap Capture" ], "parameters": [ { "name": "capture_session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/media.upload" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/media.upload" } }, "/v1/capture-sessions/{capture_session_id}/complete": { "post": { "operationId": "completeSiteMapCaptureSession", "summary": "Complete a SiteMap capture session", "tags": [ "SiteMap Capture" ], "parameters": [ { "name": "capture_session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.capture" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/SiteMapCaptureSession" }, { "type": "array", "items": { "$ref": "#/components/schemas/SiteMapCaptureSession" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.capture" } }, "/v1/facility-maps/{map_id}/validate": { "post": { "operationId": "validateFacilityMap", "summary": "Run authoritative facility-map validation", "tags": [ "SiteMap Validation" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.submit" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SiteMapValidationResult" } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.submit" } }, "/v1/facility-maps/{map_id}/validation-results": { "get": { "operationId": "listFacilityMapValidationResults", "summary": "List authoritative facility-map validation results", "tags": [ "SiteMap Validation" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/map.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/SiteMapValidationResult" }, { "type": "array", "items": { "$ref": "#/components/schemas/SiteMapValidationResult" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.read" } }, "/v1/facility-maps/{map_id}/provider-tests": { "post": { "operationId": "createFacilityMapProviderTest", "summary": "Record a provider test route", "tags": [ "SiteMap Validation" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/map.submit" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.submit" } }, "/v1/facility-maps/{map_id}/provider-tests/{test_id}": { "get": { "operationId": "getFacilityMapProviderTest", "summary": "Get a provider test result", "tags": [ "SiteMap Validation" ], "parameters": [ { "name": "map_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "test_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/map.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/map.read" } }, "/v1/facility-conditions/{condition_id}": { "patch": { "operationId": "updateFacilityCondition", "summary": "Update or close a live facility condition", "tags": [ "SiteMap" ], "parameters": [ { "name": "condition_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/condition.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/condition.write" }, "delete": { "operationId": "deleteFacilityCondition", "summary": "Delete a draft or invalid facility condition", "tags": [ "SiteMap" ], "parameters": [ { "name": "condition_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/condition.write" ] } ], "responses": { "204": { "description": "Deleted." }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/condition.write" } }, "/v1/facilities/{facility_id}/services": { "post": { "operationId": "createFacilityService", "summary": "Publish a facility service", "tags": [ "Services" ], "parameters": [ { "name": "facility_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/capacity.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/capacity.write" } }, "/v1/services": { "get": { "operationId": "listServices", "summary": "List services", "tags": [ "Services" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" } }, "/v1/services/{service_id}": { "get": { "operationId": "getService", "summary": "Get a service", "tags": [ "Services" ], "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" }, "patch": { "operationId": "updateService", "summary": "Update a service", "tags": [ "Services" ], "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/capacity.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/capacity.write" } }, "/v1/services/{service_id}/availability": { "post": { "operationId": "publishAvailability", "summary": "Publish standing capacity", "tags": [ "Capacity" ], "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/capacity.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/capacity.write" } }, "/v1/services/{service_id}/pricing": { "post": { "operationId": "publishPrice", "summary": "Publish a frozen service price", "tags": [ "Pricing" ], "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/pricing.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/pricing.write" } }, "/v1/services/{service_id}/price-history": { "get": { "operationId": "getPriceHistory", "summary": "List service price history", "tags": [ "Pricing" ], "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/provider.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/provider.read" } }, "/v1/providers/{provider_id}/pricing-strategies": { "post": { "operationId": "createPricingStrategy", "summary": "Create a provider-controlled pricing strategy", "description": "Competitor-derived inputs are rejected by validation.", "tags": [ "Pricing" ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/pricing.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/pricing.write" } }, "/v1/pricing-strategies/{strategy_id}": { "get": { "operationId": "getPricingStrategy", "summary": "Get a pricing strategy", "tags": [ "Pricing" ], "parameters": [ { "name": "strategy_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/provider.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/provider.read" }, "patch": { "operationId": "updatePricingStrategy", "summary": "Create the next pricing strategy version", "tags": [ "Pricing" ], "parameters": [ { "name": "strategy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/pricing.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/pricing.write" } }, "/v1/pricing-strategies/{strategy_id}/simulate": { "post": { "operationId": "simulatePricingStrategy", "summary": "Simulate a strategy using provider-owned inputs", "tags": [ "Pricing" ], "parameters": [ { "name": "strategy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/pricing.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/pricing.write" } }, "/v1/pricing-strategies/{strategy_id}/activate": { "post": { "operationId": "activatePricingStrategy", "summary": "Activate a pricing strategy", "tags": [ "Pricing" ], "parameters": [ { "name": "strategy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/pricing.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/pricing.write" } }, "/v1/pricing-strategies/{strategy_id}/pause": { "post": { "operationId": "pausePricingStrategy", "summary": "Pause a pricing strategy", "tags": [ "Pricing" ], "parameters": [ { "name": "strategy_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/pricing.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/pricing.write" } }, "/v1/fleets": { "post": { "operationId": "createFleet", "summary": "Register a fleet", "tags": [ "Fleets" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/fleet.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.write" }, "get": { "operationId": "listFleets", "summary": "List fleets", "tags": [ "Fleets" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/fleet.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.read" } }, "/v1/fleets/{fleet_id}": { "get": { "operationId": "getFleet", "summary": "Get a fleet", "tags": [ "Fleets" ], "parameters": [ { "name": "fleet_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/fleet.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.read" }, "patch": { "operationId": "updateFleet", "summary": "Update a fleet", "tags": [ "Fleets" ], "parameters": [ { "name": "fleet_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/fleet.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.write" } }, "/v1/fleets/{fleet_id}/vehicles": { "post": { "operationId": "createVehicle", "summary": "Register a vehicle", "tags": [ "Vehicles" ], "parameters": [ { "name": "fleet_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/fleet.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.write" } }, "/v1/vehicles/{vehicle_id}": { "get": { "operationId": "getVehicle", "summary": "Get a vehicle", "tags": [ "Vehicles" ], "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/fleet.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.read" }, "patch": { "operationId": "updateVehicle", "summary": "Update a vehicle", "tags": [ "Vehicles" ], "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/fleet.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.write" } }, "/v1/vehicles/{vehicle_id}/telemetry": { "post": { "operationId": "ingestVehicleTelemetry", "summary": "Ingest minimal transaction telemetry", "tags": [ "Telemetry" ], "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/telemetry.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/telemetry.write" } }, "/v1/vehicles/{vehicle_id}/diagnostics": { "post": { "operationId": "ingestVehicleDiagnostics", "summary": "Ingest vehicle diagnostics", "tags": [ "Telemetry" ], "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/telemetry.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/telemetry.write" } }, "/v1/vehicles/{vehicle_id}/service-needs": { "post": { "operationId": "createServiceNeed", "summary": "Report a predicted or detected service need", "tags": [ "Vehicles" ], "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/request.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.write" } }, "/v1/vehicles/{vehicle_id}/service-plan": { "get": { "operationId": "getVehicleServicePlan", "summary": "List the vehicle service plan", "tags": [ "Vehicles" ], "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/fleet.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/fleet.read" } }, "/v1/catalog/service-items": { "get": { "operationId": "listCatalogServiceItems", "summary": "List canonical service items", "tags": [ "Catalog" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" }, "post": { "operationId": "createCatalogServiceItem", "summary": "Create a canonical service item", "tags": [ "Catalog" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/admin.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/admin.write" } }, "/v1/catalog/service-items/{service_item_id}": { "get": { "operationId": "getCatalogServiceItem", "summary": "Get a canonical service item", "tags": [ "Catalog" ], "parameters": [ { "name": "service_item_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" } }, "/v1/catalog/parts": { "post": { "operationId": "createCatalogPart", "summary": "Create a canonical part", "tags": [ "Catalog" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/admin.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/admin.write" } }, "/v1/catalog/parts/{readycar_part_id}": { "get": { "operationId": "getCatalogPart", "summary": "Get a canonical part", "tags": [ "Catalog" ], "parameters": [ { "name": "readycar_part_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" } }, "/v1/catalog/parts/resolve": { "post": { "operationId": "resolveCatalogPart", "summary": "Resolve an external part identifier", "tags": [ "Catalog" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" } }, "/v1/catalog/compatibility/check": { "post": { "operationId": "checkCompatibility", "summary": "Check service or part compatibility", "tags": [ "Catalog" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" } }, "/v1/vehicles/{vehicle_id}/compatible-parts": { "get": { "operationId": "listCompatibleParts", "summary": "List compatible canonical parts", "tags": [ "Catalog" ], "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/catalog.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/catalog.read" } }, "/v1/service-requests": { "post": { "operationId": "createServiceRequest", "summary": "Create an instant-book, scheduled, auction, direct, or bundled request", "tags": [ "Marketplace" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/request.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.write" }, "get": { "operationId": "listServiceRequests", "summary": "List service requests", "tags": [ "Marketplace" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/request.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.read" } }, "/v1/service-requests/{request_id}": { "get": { "operationId": "getServiceRequest", "summary": "Get a service request", "tags": [ "Marketplace" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/request.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.read" } }, "/v1/service-requests/{request_id}/cancel": { "post": { "operationId": "cancelServiceRequest", "summary": "Cancel a service request", "tags": [ "Marketplace" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/request.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.write" } }, "/v1/service-requests/{request_id}/offers": { "get": { "operationId": "listServiceRequestOffers", "summary": "Rank qualified offers by total operational cost", "tags": [ "Marketplace" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/request.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.read" } }, "/v1/service-requests/{request_id}/award": { "post": { "operationId": "awardServiceRequest", "summary": "Award an offer and create a reservation", "tags": [ "Marketplace" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/request.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.write" } }, "/v1/marketplace/quote-search": { "post": { "operationId": "searchMarketplaceQuotes", "summary": "Preview ranked standing offers without creating a request", "description": "Compatibility alias for early integrations. New integrations should create a service request and retrieve its offers.", "tags": [ "Marketplace" ], "deprecated": true, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/request.read" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/request.read" } }, "/v1/provider-auctions": { "get": { "operationId": "listProviderAuctions", "summary": "List provider-visible open requests", "tags": [ "Auctions" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/bid.write" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/bid.write" } }, "/v1/provider-auctions/{request_id}": { "get": { "operationId": "getProviderAuction", "summary": "Get a provider-visible request", "tags": [ "Auctions" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/bid.write" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/bid.write" } }, "/v1/provider-auctions/{request_id}/bids": { "post": { "operationId": "createBid", "summary": "Submit a sealed bid with a soft capacity commitment", "tags": [ "Auctions" ], "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/bid.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/bid.write" } }, "/v1/bids/{bid_id}": { "patch": { "operationId": "updateBid", "summary": "Replace a bid before its expiry", "tags": [ "Auctions" ], "parameters": [ { "name": "bid_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/bid.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/bid.write" } }, "/v1/bids/{bid_id}/withdraw": { "post": { "operationId": "withdrawBid", "summary": "Withdraw a bid", "tags": [ "Auctions" ], "parameters": [ { "name": "bid_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/bid.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/bid.write" } }, "/v1/reservations": { "get": { "operationId": "listReservations", "summary": "List reservations", "tags": [ "Reservations" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/reservation.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.read" } }, "/v1/reservations/{reservation_id}": { "get": { "operationId": "getReservation", "summary": "Get a reservation", "tags": [ "Reservations" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/reservation.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.read" } }, "/v1/reservations/{reservation_id}/confirm": { "post": { "operationId": "confirmReservation", "summary": "Confirm exclusive capacity after award", "tags": [ "Reservations" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/vehicle-status": { "post": { "operationId": "reportVehicleStatus", "summary": "Report typed navigation and vehicle progress", "tags": [ "Reservations" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/telemetry.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/telemetry.write" } }, "/v1/reservations/{reservation_id}/arrival-authorization": { "post": { "operationId": "authorizeArrival", "summary": "Authorize arrival and release a pinned guidance package", "tags": [ "SiteMap" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/guidance-package": { "get": { "operationId": "getGuidancePackage", "summary": "Retrieve the released guidance package idempotently", "tags": [ "SiteMap" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/reservation.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.read" } }, "/v1/reservations/{reservation_id}/service-started": { "post": { "operationId": "startService", "summary": "Start fulfillment", "tags": [ "Reservations" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/service-completed": { "post": { "operationId": "completeService", "summary": "Report fulfillment completion and begin verification", "tags": [ "Reservations" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/exceptions": { "post": { "operationId": "createReservationException", "summary": "Record a fulfillment exception", "tags": [ "Reservations" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/fulfillment-manifest": { "post": { "operationId": "createFulfillmentManifest", "summary": "Create an immutable exact-item fulfillment manifest", "tags": [ "ASV" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/verify-delivered-item": { "post": { "operationId": "verifyDeliveredItem", "summary": "Verify a delivered service or serialized item", "tags": [ "ASV" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/morning-release-status": { "post": { "operationId": "reportMorningReleaseStatus", "summary": "Report overnight release readiness or delay", "tags": [ "Reservations" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.fulfill" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.fulfill" } }, "/v1/reservations/{reservation_id}/verification-cases": { "post": { "operationId": "createVerificationCase", "summary": "Open an ASV verification case", "tags": [ "ASV" ], "parameters": [ { "name": "reservation_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/verification.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/verification.write" } }, "/v1/verification-cases/{verification_case_id}": { "get": { "operationId": "getVerificationCase", "summary": "Get an ASV verification case", "tags": [ "ASV" ], "parameters": [ { "name": "verification_case_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/verification.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/verification.read" } }, "/v1/verification-cases/{verification_case_id}/evidence": { "post": { "operationId": "createVerificationEvidence", "summary": "Attach evidence metadata", "tags": [ "ASV" ], "parameters": [ { "name": "verification_case_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/verification.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/verification.write" } }, "/v1/verification-cases/{verification_case_id}/decision": { "post": { "operationId": "decideVerificationCase", "summary": "Record an automated or human verification outcome", "tags": [ "ASV" ], "parameters": [ { "name": "verification_case_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/verification.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationDecision" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/verification.write" } }, "/v1/mobile/device-registrations": { "post": { "operationId": "registerMobileDevice", "summary": "Register a SiteMap or ASV mobile device and push token", "tags": [ "Mobile" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/profile.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/profile.write" } }, "/v1/auth/token/refresh": { "post": { "operationId": "refreshMobileToken", "summary": "Exchange a rotating mobile refresh token", "description": "Compatibility endpoint for the iOS apps. The preferred production path is the Cognito OAuth 2.0 token endpoint returned by the deployment stack.", "tags": [ "Mobile" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": null } }, "/v1/auth/logout": { "post": { "operationId": "logoutMobileSession", "summary": "End the local mobile API session", "tags": [ "Mobile" ], "security": [ { "OAuth2": [ "readycar/profile.read" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/profile.read" } }, "/v1/asv/orders": { "get": { "operationId": "listAsvOrders", "summary": "List technician-visible ASV service orders", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "facility_id", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/asv.order.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AsvOrder" } } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.order.read" } }, "/v1/asv/orders/{order_id}": { "get": { "operationId": "getAsvOrder", "summary": "Get an ASV service order with vehicle and protocol projection", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/asv.order.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AsvOrder" } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.order.read" } }, "/v1/asv/orders/{order_id}/timeline": { "get": { "operationId": "getAsvOrderTimeline", "summary": "Get the immutable ASV order timeline", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/asv.order.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.order.read" } }, "/v1/asv/protocols/{protocol_id}/versions/{version}": { "get": { "operationId": "getAsvProtocolVersion", "summary": "Get an immutable, cacheable ASV verification protocol", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "protocol_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/asv.protocol.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AsvProtocol" } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.protocol.read" } }, "/v1/asv/orders/{order_id}/capture-sessions": { "post": { "operationId": "createAsvCaptureSession", "summary": "Create an offline-authorized ASV capture session", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/asv.capture.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/AsvCaptureSession" }, { "type": "array", "items": { "$ref": "#/components/schemas/AsvCaptureSession" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.capture.write" } }, "/v1/asv/capture-sessions/{session_id}": { "patch": { "operationId": "updateAsvCaptureSession", "summary": "Persist ASV step progress and capture state", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/asv.capture.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/AsvCaptureSession" }, { "type": "array", "items": { "$ref": "#/components/schemas/AsvCaptureSession" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.capture.write" } }, "/v1/asv/capture-sessions/{session_id}/evidence/upload-intents": { "post": { "operationId": "createAsvEvidenceUploadIntent", "summary": "Create evidence metadata and a short-lived object upload URL", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/asv.evidence.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/AsvEvidence" }, { "type": "array", "items": { "$ref": "#/components/schemas/AsvEvidence" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.evidence.write" } }, "/v1/asv/evidence/{evidence_id}/complete-upload": { "post": { "operationId": "completeAsvEvidenceUpload", "summary": "Confirm an evidence upload by SHA-256 and byte count", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "evidence_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/asv.evidence.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/AsvEvidence" }, { "type": "array", "items": { "$ref": "#/components/schemas/AsvEvidence" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.evidence.write" } }, "/v1/asv/capture-sessions/{session_id}/submit": { "post": { "operationId": "submitAsvCaptureSession", "summary": "Submit a complete evidence set for verification", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/asv.capture.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/AsvCaptureSession" }, { "type": "array", "items": { "$ref": "#/components/schemas/AsvCaptureSession" } } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.capture.write" } }, "/v1/asv/orders/{order_id}/verification-result": { "get": { "operationId": "getAsvVerificationResult", "summary": "Get the latest ASV verification result", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/asv.result.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AsvVerificationResult" } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.result.read" } }, "/v1/asv/orders/{order_id}/evidence-requests": { "get": { "operationId": "listAsvEvidenceRequests", "summary": "List requests for additional or replacement evidence", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/asv.order.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.order.read" } }, "/v1/asv/certificates/{certificate_id}": { "get": { "operationId": "getAsvCertificate", "summary": "Get an immutable ASV verification certificate", "tags": [ "ASV Mobile" ], "parameters": [ { "name": "certificate_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/asv.result.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/asv.result.read" } }, "/v1/payments/authorizations": { "post": { "operationId": "authorizePayment", "summary": "Create a payment-partner authorization reference", "description": "POC adapter only. Funds remain with the configured licensed payment partner.", "tags": [ "Payments" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/payment.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/payment.write" } }, "/v1/payments/{payment_id}": { "get": { "operationId": "getPayment", "summary": "Get payment state", "tags": [ "Payments" ], "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/payment.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/payment.read" } }, "/v1/payments/{payment_id}/capture": { "post": { "operationId": "capturePayment", "summary": "Capture an authorized payment through the partner adapter", "tags": [ "Payments" ], "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/payment.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/payment.write" } }, "/v1/payments/{payment_id}/refund": { "post": { "operationId": "refundPayment", "summary": "Refund a captured payment through the partner adapter", "tags": [ "Payments" ], "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/payment.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/payment.write" } }, "/v1/disputes": { "post": { "operationId": "createDispute", "summary": "Open a transaction dispute", "tags": [ "Trust" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.read" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.read" } }, "/v1/disputes/{dispute_id}": { "get": { "operationId": "getDispute", "summary": "Get a dispute", "tags": [ "Trust" ], "parameters": [ { "name": "dispute_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/reservation.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.read" } }, "/v1/ratings": { "post": { "operationId": "createRating", "summary": "Create a facility and service-item rating", "tags": [ "Trust" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/reservation.read" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/reservation.read" } }, "/v1/webhook-endpoints": { "post": { "operationId": "createWebhookEndpoint", "summary": "Register a signed webhook endpoint", "tags": [ "Webhooks" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/webhook.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/webhook.write" }, "get": { "operationId": "listWebhookEndpoints", "summary": "List webhook endpoints", "tags": [ "Webhooks" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/webhook.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/webhook.read" } }, "/v1/webhook-endpoints/{webhook_endpoint_id}": { "patch": { "operationId": "updateWebhookEndpoint", "summary": "Rotate or update a webhook endpoint", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook_endpoint_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "Optional optimistic-lock record version.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/webhook.write" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/webhook.write" }, "delete": { "operationId": "deleteWebhookEndpoint", "summary": "Delete a webhook endpoint", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook_endpoint_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/webhook.write" ] } ], "responses": { "204": { "description": "Deleted." }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/webhook.write" } }, "/v1/uploads": { "post": { "operationId": "createUploadUrl", "summary": "Create a short-lived evidence upload URL", "tags": [ "Uploads" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/verification.write" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/verification.write" } }, "/v1/uploads/multipart": { "post": { "operationId": "initiateMultipartUpload", "summary": "Initiate a resumable SiteMap or ASV media upload", "tags": [ "Uploads" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/media.upload" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "201": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/media.upload" } }, "/v1/uploads/multipart/{upload_id}/parts": { "post": { "operationId": "createMultipartUploadPartUrl", "summary": "Create a signed URL for one multipart upload part", "tags": [ "Uploads" ], "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/media.upload" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/media.upload" } }, "/v1/uploads/multipart/{upload_id}/complete": { "post": { "operationId": "completeMultipartUpload", "summary": "Complete a multipart upload with ordered part ETags", "tags": [ "Uploads" ], "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/media.upload" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceInput" } } } }, "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/media.upload" } }, "/v1/uploads/multipart/{upload_id}": { "delete": { "operationId": "abortMultipartUpload", "summary": "Abort an incomplete multipart upload", "tags": [ "Uploads" ], "parameters": [ { "name": "upload_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "object_key", "in": "query", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "security": [ { "OAuth2": [ "readycar/media.upload" ] } ], "responses": { "204": { "description": "Deleted." }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/media.upload" } }, "/v1/audit-events": { "get": { "operationId": "listAuditEvents", "summary": "List the tenant audit trail", "tags": [ "Audit" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "readycar/audit.read" ] } ], "responses": { "200": { "description": "Successful response.", "headers": { "ETag": { "schema": { "type": "string" } }, "Location": { "schema": { "type": "string" } }, "X-Request-Id": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, { "type": "object", "additionalProperties": true } ] } }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/Problem" }, "401": { "$ref": "#/components/responses/Problem" }, "403": { "$ref": "#/components/responses/Problem" }, "404": { "$ref": "#/components/responses/Problem" }, "409": { "$ref": "#/components/responses/Problem" }, "412": { "$ref": "#/components/responses/Problem" }, "422": { "$ref": "#/components/responses/Problem" }, "500": { "$ref": "#/components/responses/Problem" } }, "x-readycar-required-scope": "readycar/audit.read" } } }, "components": { "securitySchemes": { "OAuth2": { "type": "oauth2", "description": "Amazon Cognito access tokens with route scopes. Server integrations use client credentials; SiteMap and ASV use Authorization Code with PKCE.", "flows": { "clientCredentials": { "tokenUrl": "https://auth.readycar.com/oauth2/token", "scopes": { "readycar/admin.write": "Access admin.write operations.", "readycar/asv.capture.write": "Access asv.capture.write operations.", "readycar/asv.evidence.write": "Access asv.evidence.write operations.", "readycar/asv.order.read": "Access asv.order.read operations.", "readycar/asv.protocol.read": "Access asv.protocol.read operations.", "readycar/asv.result.read": "Access asv.result.read operations.", "readycar/audit.read": "Access audit.read operations.", "readycar/bid.write": "Access bid.write operations.", "readycar/capacity.write": "Access capacity.write operations.", "readycar/catalog.read": "Access catalog.read operations.", "readycar/condition.write": "Access condition.write operations.", "readycar/facility.read": "Access facility.read operations.", "readycar/facility.write": "Access facility.write operations.", "readycar/fleet.read": "Access fleet.read operations.", "readycar/fleet.write": "Access fleet.write operations.", "readycar/map.approve": "Access map.approve operations.", "readycar/map.capture": "Access map.capture operations.", "readycar/map.publish": "Access map.publish operations.", "readycar/map.read": "Access map.read operations.", "readycar/map.submit": "Access map.submit operations.", "readycar/media.upload": "Access media.upload operations.", "readycar/payment.read": "Access payment.read operations.", "readycar/payment.write": "Access payment.write operations.", "readycar/pricing.write": "Access pricing.write operations.", "readycar/profile.read": "Access profile.read operations.", "readycar/profile.write": "Access profile.write operations.", "readycar/provider.read": "Access provider.read operations.", "readycar/provider.write": "Access provider.write operations.", "readycar/request.read": "Access request.read operations.", "readycar/request.write": "Access request.write operations.", "readycar/reservation.fulfill": "Access reservation.fulfill operations.", "readycar/reservation.read": "Access reservation.read operations.", "readycar/resource.write": "Access resource.write operations.", "readycar/route.write": "Access route.write operations.", "readycar/telemetry.write": "Access telemetry.write operations.", "readycar/verification.read": "Access verification.read operations.", "readycar/verification.write": "Access verification.write operations.", "readycar/webhook.read": "Access webhook.read operations.", "readycar/webhook.write": "Access webhook.write operations." } }, "authorizationCode": { "authorizationUrl": "https://auth.readycar.com/oauth2/authorize", "tokenUrl": "https://auth.readycar.com/oauth2/token", "scopes": { "readycar/admin.write": "Access admin.write operations.", "readycar/asv.capture.write": "Access asv.capture.write operations.", "readycar/asv.evidence.write": "Access asv.evidence.write operations.", "readycar/asv.order.read": "Access asv.order.read operations.", "readycar/asv.protocol.read": "Access asv.protocol.read operations.", "readycar/asv.result.read": "Access asv.result.read operations.", "readycar/audit.read": "Access audit.read operations.", "readycar/bid.write": "Access bid.write operations.", "readycar/capacity.write": "Access capacity.write operations.", "readycar/catalog.read": "Access catalog.read operations.", "readycar/condition.write": "Access condition.write operations.", "readycar/facility.read": "Access facility.read operations.", "readycar/facility.write": "Access facility.write operations.", "readycar/fleet.read": "Access fleet.read operations.", "readycar/fleet.write": "Access fleet.write operations.", "readycar/map.approve": "Access map.approve operations.", "readycar/map.capture": "Access map.capture operations.", "readycar/map.publish": "Access map.publish operations.", "readycar/map.read": "Access map.read operations.", "readycar/map.submit": "Access map.submit operations.", "readycar/media.upload": "Access media.upload operations.", "readycar/payment.read": "Access payment.read operations.", "readycar/payment.write": "Access payment.write operations.", "readycar/pricing.write": "Access pricing.write operations.", "readycar/profile.read": "Access profile.read operations.", "readycar/profile.write": "Access profile.write operations.", "readycar/provider.read": "Access provider.read operations.", "readycar/provider.write": "Access provider.write operations.", "readycar/request.read": "Access request.read operations.", "readycar/request.write": "Access request.write operations.", "readycar/reservation.fulfill": "Access reservation.fulfill operations.", "readycar/reservation.read": "Access reservation.read operations.", "readycar/resource.write": "Access resource.write operations.", "readycar/route.write": "Access route.write operations.", "readycar/telemetry.write": "Access telemetry.write operations.", "readycar/verification.read": "Access verification.read operations.", "readycar/verification.write": "Access verification.write operations.", "readycar/webhook.read": "Access webhook.read operations.", "readycar/webhook.write": "Access webhook.write operations." } } } } }, "parameters": { "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Unique key (8-128 characters) retained for 24 hours. Reusing a key with a different request returns 409.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } }, "schemas": { "Problem": { "type": "object", "required": [ "type", "title", "status", "detail", "request_id" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "request_id": { "type": "string" } }, "additionalProperties": true }, "Money": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "number", "minimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "examples": [ "USD" ] }, "unit": { "type": "string" } } }, "GeoPoint": { "type": "object", "required": [ "latitude", "longitude" ], "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "altitude_m": { "type": "number" }, "heading_degrees": { "type": "number", "minimum": 0, "maximum": 360 } } }, "Resource": { "type": "object", "required": [ "id", "entity_type", "organization_id", "created_at", "updated_at", "version" ], "properties": { "id": { "type": "string" }, "entity_type": { "type": "string" }, "organization_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "minimum": 1 } }, "additionalProperties": true }, "ResourceInput": { "type": "object", "minProperties": 1, "additionalProperties": true }, "Provider": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "provider_id", "legal_name", "display_name" ], "properties": { "provider_id": { "type": "string" }, "legal_name": { "type": "string" }, "display_name": { "type": "string" }, "provider_status": { "enum": [ "pending", "verified", "suspended" ] }, "service_categories": { "type": "array", "items": { "type": "string" } }, "operating_regions": { "type": "array", "items": { "type": "string" } } } } ] }, "Facility": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "facility_id", "provider_id", "display_name", "location" ], "properties": { "facility_id": { "type": "string" }, "provider_id": { "type": "string" }, "display_name": { "type": "string" }, "location": { "$ref": "#/components/schemas/GeoPoint" }, "autonomous_access": { "type": "object", "properties": { "supported": { "type": "boolean", "readOnly": true }, "human_handoff_required": { "type": "boolean" } } } } } ] }, "FacilityResource": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "facility_resource_id", "facility_id", "resource_class", "resource_type", "spatial_status" ], "properties": { "facility_resource_id": { "type": "string" }, "facility_id": { "type": "string" }, "resource_class": { "enum": [ "SELLABLE", "NAVIGATIONAL" ] }, "resource_type": { "type": "string" }, "spatial_status": { "enum": [ "UNMAPPED", "MAPPED_DRAFT", "MAPPED_ACTIVE", "MAPPED_STALE" ] }, "commercial": { "type": "object", "additionalProperties": true } } } ] }, "SpatialProfile": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "facility_resource_id", "facility_map_version", "final_pose" ], "properties": { "facility_resource_id": { "type": "string" }, "facility_map_version": { "type": "integer", "minimum": 1 }, "final_pose": { "$ref": "#/components/schemas/GeoPoint" }, "vehicle_envelope": { "type": "object", "additionalProperties": true }, "approach": { "type": "object", "additionalProperties": true }, "immutable": { "const": true } } } ] }, "ServiceRequest": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "request_id", "vehicle_id", "service_items", "service_window", "fulfillment_mode", "status" ], "properties": { "request_id": { "type": "string" }, "vehicle_id": { "type": "string" }, "fleet_id": { "type": "string" }, "service_items": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "service_item_id" ], "properties": { "service_item_id": { "type": "string" }, "quantity": { "type": "object", "additionalProperties": true }, "required_part_ids": { "type": "array", "items": { "type": "string" } } } } }, "service_window": { "type": "object", "required": [ "earliest_start", "latest_completion" ], "properties": { "earliest_start": { "type": "string", "format": "date-time" }, "latest_completion": { "type": "string", "format": "date-time" } } }, "fulfillment_mode": { "enum": [ "INSTANT_BOOK", "SCHEDULED", "REVERSE_AUCTION", "DIRECT_AWARD", "BUNDLED", "MULTI_STOP" ] }, "status": { "enum": [ "DRAFT", "OPEN", "AWARDED", "CANCELLED", "EXPIRED", "NO_BID" ] }, "commercial_constraints": { "type": "object", "additionalProperties": true } } } ] }, "Bid": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "bid_id", "request_id", "provider_id", "facility_id", "price", "availability" ], "properties": { "bid_id": { "type": "string" }, "request_id": { "type": "string" }, "provider_id": { "type": "string" }, "facility_id": { "type": "string" }, "facility_resource_id": { "type": "string" }, "price": { "type": "object", "additionalProperties": true }, "availability": { "type": "object", "additionalProperties": true }, "cost_terms": { "type": "object", "additionalProperties": { "type": "number" } }, "soft_commitment": { "type": "boolean" } } } ] }, "Reservation": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "reservation_id", "request_id", "bid_id", "status" ], "properties": { "reservation_id": { "type": "string" }, "request_id": { "type": "string" }, "bid_id": { "type": "string" }, "facility_resource_id": { "type": [ "string", "null" ] }, "facility_map_version": { "type": [ "integer", "null" ] }, "status": { "type": "string" }, "guidance_package": { "type": [ "object", "null" ], "additionalProperties": true }, "settlement_eligible": { "type": "boolean" } } } ] }, "VerificationDecision": { "type": "object", "required": [ "outcome" ], "properties": { "outcome": { "enum": [ "VERIFIED", "VERIFIED_AUDIT_ELIGIBLE", "VERIFIED_WITH_VARIANCE", "MORE_EVIDENCE_REQUIRED", "MANUAL_REVIEW", "MISMATCH", "FAILED", "DISPUTED" ] }, "confidence": { "type": "number", "minimum": 0, "maximum": 1, "description": "Model signal only; not represented as a calibrated probability unless the protocol has been validated." }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "decided_by": { "enum": [ "automated", "human" ] } } }, "PlatformEvent": { "type": "object", "required": [ "event_id", "event_type", "created_at", "organization_id", "correlation_id", "schema_version", "data" ], "properties": { "event_id": { "type": "string" }, "event_type": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "organization_id": { "type": "string" }, "actor_id": { "type": "string" }, "correlation_id": { "type": "string" }, "schema_version": { "const": "1.0" }, "data": { "type": "object", "additionalProperties": true } } }, "FacilityMap": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "map_id", "facility_id", "map_version", "state", "coordinate_reference_system" ], "properties": { "map_id": { "type": "string" }, "facility_id": { "type": "string" }, "map_version": { "type": "integer", "minimum": 1 }, "state": { "enum": [ "DRAFT", "SUBMITTED", "IN_REVIEW", "CHANGES_REQUESTED", "APPROVED", "ACTIVE", "SUSPENDED", "RETIRED" ] }, "capture_level": { "enum": [ "BASIC", "ADVANCED", "CERTIFIED" ] }, "coordinate_reference_system": { "type": "string", "examples": [ "EPSG:4326" ] }, "based_on_version": { "type": [ "integer", "null" ] }, "immutable": { "type": "boolean" } } } ] }, "FacilityMapNode": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "node_id", "map_id", "node_type", "position" ], "properties": { "node_id": { "type": "string" }, "map_id": { "type": "string" }, "node_type": { "enum": [ "PUBLIC_ROAD_TRANSITION", "ENTRY", "EXIT", "CHECKPOINT", "INTERSECTION", "STOP_POINT", "STAGING_POINT", "QUEUE_POINT", "SERVICE_RESOURCE", "SAFE_STOP_POINT" ] }, "position": { "$ref": "#/components/schemas/GeoPoint" }, "reference_only": { "type": "boolean" } } } ] }, "FacilityRoute": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "route_id", "map_id", "from_node_id", "to_node_id", "geometry" ], "properties": { "route_id": { "type": "string" }, "map_id": { "type": "string" }, "from_node_id": { "type": "string" }, "to_node_id": { "type": "string" }, "geometry": { "type": "array", "minItems": 2, "items": { "$ref": "#/components/schemas/GeoPoint" } }, "maximum_speed_kph": { "type": "number", "minimum": 0 }, "width_meters": { "type": "number", "exclusiveMinimum": 0 }, "direction": { "enum": [ "FORWARD", "REVERSE", "BIDIRECTIONAL" ] }, "safety_flags": { "type": "array", "items": { "type": "string" } } } } ] }, "FacilityZone": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "zone_id", "map_id", "zone_type", "geometry" ], "properties": { "zone_id": { "type": "string" }, "map_id": { "type": "string" }, "zone_type": { "enum": [ "PROPERTY_BOUNDARY", "PEDESTRIAN", "EXCLUSION", "SPEED", "CLEARANCE", "SAFE_STOP" ] }, "geometry": { "type": "array", "minItems": 3, "items": { "$ref": "#/components/schemas/GeoPoint" } }, "restrictions": { "type": "object", "additionalProperties": true } } } ] }, "SiteMapCaptureSession": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "capture_session_id", "map_id", "status" ], "properties": { "capture_session_id": { "type": "string" }, "map_id": { "type": "string" }, "status": { "enum": [ "ACTIVE", "PAUSED", "COMPLETED", "ABANDONED" ] }, "capture_mode": { "enum": [ "WALKING", "SLOW_DRIVING", "SIMULATED" ] }, "device_readiness": { "type": "object", "additionalProperties": true } } } ] }, "SiteMapValidationResult": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "validation_result_id", "map_id", "ready", "blocking_issue_count", "issues" ], "properties": { "validation_result_id": { "type": "string" }, "map_id": { "type": "string" }, "ready": { "type": "boolean" }, "blocking_issue_count": { "type": "integer", "minimum": 0 }, "issues": { "type": "array", "items": { "type": "object", "required": [ "rule_id", "severity", "reason" ], "properties": { "rule_id": { "type": "string" }, "severity": { "enum": [ "BLOCKING", "WARNING", "INFO" ] }, "reason": { "type": "string" }, "affected_object_ids": { "type": "array", "items": { "type": "string" } } } } } } } ] }, "AsvOrder": { "type": "object", "required": [ "id", "revision", "status", "vehicle", "service", "protocol_reference", "permissions", "server_updated_at" ], "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "minimum": 1 }, "status": { "enum": [ "ASSIGNED", "READY", "CAPTURE_IN_PROGRESS", "EVIDENCE_READY", "SUBMITTING", "VERIFYING", "ADDITIONAL_EVIDENCE_REQUIRED", "MANUAL_REVIEW", "VERIFIED", "FAILED", "CANCELLED", "EXPIRED" ] }, "vehicle": { "type": "object", "additionalProperties": true }, "service": { "type": "object", "additionalProperties": true }, "facility": { "type": [ "object", "null" ], "additionalProperties": true }, "service_window": { "type": [ "object", "null" ], "additionalProperties": true }, "protocol_reference": { "type": "object", "required": [ "id", "version" ], "properties": { "id": { "type": "string" }, "version": { "type": "integer" } } }, "expected_parts": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "permissions": { "type": "object", "additionalProperties": { "type": "boolean" } }, "server_updated_at": { "type": "string", "format": "date-time" } } }, "AsvProtocol": { "type": "object", "required": [ "id", "version", "display_name", "service_type", "minimum_app_version", "steps", "submission_policy" ], "properties": { "id": { "type": "string" }, "version": { "type": "integer", "minimum": 1 }, "display_name": { "type": "string" }, "service_type": { "enum": [ "tire_replacement", "exterior_wash", "interior_cleaning", "ev_charging", "oil_service", "sensor_cleaning" ] }, "minimum_app_version": { "type": "string" }, "steps": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "id", "type", "title", "instruction", "is_required", "accessibility_text" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "instruction": { "type": "string" }, "is_required": { "type": "boolean" }, "accessibility_text": { "type": "string" }, "choices": { "type": "array", "items": { "type": "string" } }, "condition": { "type": "object", "additionalProperties": true } } } }, "submission_policy": { "type": "object", "additionalProperties": true } } }, "AsvCaptureSession": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "session_id", "order_id", "protocol_id", "protocol_version", "state", "authorization_expires_at" ], "properties": { "session_id": { "type": "string" }, "order_id": { "type": "string" }, "protocol_id": { "type": "string" }, "protocol_version": { "type": "integer" }, "state": { "enum": [ "CREATED", "ACTIVE", "PAUSED", "OFFLINE_PENDING", "UPLOAD_IN_PROGRESS", "UPLOAD_COMPLETE", "SUBMITTED", "ABANDONED", "INVALIDATED" ] }, "current_step_id": { "type": [ "string", "null" ] }, "authorization_expires_at": { "type": "string", "format": "date-time" } } } ] }, "AsvEvidence": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "evidence_id", "session_id", "order_id", "protocol_step_id", "media_type", "sha256", "byte_count", "upload_state" ], "properties": { "evidence_id": { "type": "string" }, "session_id": { "type": "string" }, "order_id": { "type": "string" }, "protocol_step_id": { "type": "string" }, "media_type": { "enum": [ "image", "video", "document", "measurement" ] }, "sha256": { "type": "string", "pattern": "^[a-fA-F0-9]{64}$" }, "byte_count": { "type": "integer", "minimum": 1 }, "upload_state": { "enum": [ "LOCAL_DRAFT", "LOCAL_VALIDATED", "QUEUED", "UPLOADING", "UPLOADED", "SERVER_ACCEPTED", "SERVER_REJECTED", "SUPERSEDED" ] }, "object_key": { "type": "string" } } } ] }, "AsvVerificationResult": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "type": "object", "required": [ "order_id", "status", "issues" ], "properties": { "order_id": { "type": "string" }, "status": { "enum": [ "PROCESSING", "VERIFIED", "MORE_EVIDENCE", "MANUAL_REVIEW", "FAILED" ] }, "confidence": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1 }, "issues": { "type": "array", "items": { "type": "string" } }, "certificate_id": { "type": [ "string", "null" ] } } } ] } }, "responses": { "Problem": { "description": "RFC 9457 problem detail.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "x-readycar-design-decisions": { "objective": "lowest_total_operational_cost", "resource_model": "FacilityResource has commercial and spatial facets", "capacity_commitment": "soft until award, exclusive after award", "overnight_model": "service-request fulfillment mode; no parallel lifecycle", "pricing_guardrail": "no competitor-derived inputs" } }