{ "openapi": "3.1.0", "info": { "title": "Testheon Practice API", "version": "1.1.0", "description": "Synthetic, session-isolated REST practice API for resources, authentication, ecommerce, files, and deterministic failures. It never uses WordPress data or identities." }, "servers": [ { "url": "/practice/api/v1", "description": "Current Lab origin" } ], "tags": [ { "name": "users" }, { "name": "products" }, { "name": "orders" }, { "name": "customers" }, { "name": "employees" }, { "name": "tasks" }, { "name": "tickets" }, { "name": "bookings" }, { "name": "lab" }, { "name": "files" }, { "name": "authentication" }, { "name": "store" }, { "name": "simulation" } ], "paths": { "/users": { "get": { "operationId": "listUsers", "summary": "List users", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact role filter." }, { "name": "active", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact active filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createUSR", "summary": "Create a session-scoped users record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/users/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getUSR", "summary": "Get one users record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replaceUSR", "summary": "Replace one users record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchUSR", "summary": "Patch one users record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deleteUSR", "summary": "Delete one users record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/products": { "get": { "operationId": "listProducts", "summary": "List products", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact category filter." }, { "name": "stock", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact stock filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createPRD", "summary": "Create a session-scoped products record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/products/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getPRD", "summary": "Get one products record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replacePRD", "summary": "Replace one products record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchPRD", "summary": "Patch one products record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deletePRD", "summary": "Delete one products record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/orders": { "get": { "operationId": "listOrders", "summary": "List orders", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact status filter." }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact customerId filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createORD", "summary": "Create a session-scoped orders record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/orders/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getORD", "summary": "Get one orders record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replaceORD", "summary": "Replace one orders record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchORD", "summary": "Patch one orders record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deleteORD", "summary": "Delete one orders record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/customers": { "get": { "operationId": "listCustomers", "summary": "List customers", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "city", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact city filter." }, { "name": "tier", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact tier filter." }, { "name": "active", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact active filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createCUS", "summary": "Create a session-scoped customers record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/customers/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getCUS", "summary": "Get one customers record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replaceCUS", "summary": "Replace one customers record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchCUS", "summary": "Patch one customers record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deleteCUS", "summary": "Delete one customers record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/employees": { "get": { "operationId": "listEmployees", "summary": "List employees", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "department", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact department filter." }, { "name": "location", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact location filter." }, { "name": "active", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact active filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createEMP", "summary": "Create a session-scoped employees record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/employees/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getEMP", "summary": "Get one employees record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replaceEMP", "summary": "Replace one employees record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchEMP", "summary": "Patch one employees record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deleteEMP", "summary": "Delete one employees record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/tasks": { "get": { "operationId": "listTasks", "summary": "List tasks", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact status filter." }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact priority filter." }, { "name": "assigneeId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact assigneeId filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createTSK", "summary": "Create a session-scoped tasks record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/tasks/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getTSK", "summary": "Get one tasks record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replaceTSK", "summary": "Replace one tasks record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchTSK", "summary": "Patch one tasks record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deleteTSK", "summary": "Delete one tasks record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/tickets": { "get": { "operationId": "listTickets", "summary": "List tickets", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact status filter." }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact priority filter." }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact customerId filter." }, { "name": "assigneeId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact assigneeId filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createTKT", "summary": "Create a session-scoped tickets record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/tickets/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getTKT", "summary": "Get one tickets record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replaceTKT", "summary": "Replace one tickets record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchTKT", "summary": "Patch one tickets record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deleteTKT", "summary": "Delete one tickets record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/bookings": { "get": { "operationId": "listBookings", "summary": "List bookings", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Delay" }, { "$ref": "#/components/parameters/Simulate" }, { "$ref": "#/components/parameters/Seed" }, { "$ref": "#/components/parameters/Size" }, { "name": "city", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact city filter." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact status filter." }, { "name": "roomType", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact roomType filter." }, { "name": "ratePlan", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Exact ratePlan filter." } ], "responses": { "200": { "description": "Paginated collection", "headers": { "X-Total-Count": { "schema": { "type": "integer", "minimum": 0 } }, "Link": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createBKG", "summary": "Create a session-scoped bookings record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "201": { "description": "Created with a Location header", "headers": { "Location": { "schema": { "type": "string", "format": "uri-reference" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/bookings/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "get": { "operationId": "getBKG", "summary": "Get one bookings record", "responses": { "200": { "description": "Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceEnvelope" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "put": { "operationId": "replaceBKG", "summary": "Replace one bookings record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Replaced" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "patch": { "operationId": "patchBKG", "summary": "Patch one bookings record", "requestBody": { "$ref": "#/components/requestBodies/ResourceBody" }, "responses": { "200": { "description": "Updated" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "operationId": "deleteBKG", "summary": "Delete one bookings record from this sandbox", "responses": { "204": { "description": "Deleted" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/health": { "get": { "operationId": "getHealth", "summary": "Read API, fixture, and storage health without creating a sandbox", "security": [], "responses": { "200": { "description": "Healthy" }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/openapi.json": { "get": { "operationId": "getOpenApi", "summary": "Read this OpenAPI 3.1 document", "security": [], "responses": { "200": { "description": "OpenAPI document" } } } }, "/lab/session": { "get": { "operationId": "getLabSession", "summary": "Read the current sandbox ID and aggregate statistics", "responses": { "200": { "description": "Session statistics" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "operationId": "createLabSession", "summary": "Create a cookie or header-mode sandbox", "parameters": [ { "$ref": "#/components/parameters/ExpiresIn" } ], "responses": { "201": { "description": "Created" }, "503": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/lab/reset": { "post": { "operationId": "resetLabSession", "summary": "Delete only the caller sandbox overlays and reset counters", "responses": { "200": { "description": "Reset" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/roles": { "get": { "tags": [ "authentication" ], "operationId": "getPracticeRoleMatrix", "summary": "Read the public synthetic role and permission matrix", "security": [], "responses": { "200": { "description": "Role matrix" } } } }, "/auth/mfa/status": { "get": { "tags": [ "authentication" ], "operationId": "getPracticeMfaStatus", "summary": "Read the signed-in synthetic identity MFA enrollment and role policy", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "Synthetic MFA status" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/mfa/enroll": { "post": { "tags": [ "authentication" ], "operationId": "startPracticeMfaEnrollment", "summary": "Create or restart synthetic OTP enrollment for the signed-in sandbox identity", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "Enrollment reference and public synthetic OTP/recovery values" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/mfa/enrollment/verify": { "post": { "tags": [ "authentication" ], "operationId": "verifyPracticeMfaEnrollment", "summary": "Enable a pending synthetic OTP enrollment with its public Lab code", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "MFA enrollment enabled" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/mfa/challenge": { "post": { "tags": [ "authentication" ], "operationId": "startPracticeMfaChallenge", "summary": "Validate synthetic credentials and create a bounded OTP challenge without signing in", "requestBody": { "$ref": "#/components/requestBodies/AuthCredentials" }, "responses": { "202": { "description": "Challenge ID, public synthetic OTP, role policy, and expiry" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/mfa/verify": { "post": { "tags": [ "authentication" ], "operationId": "verifyPracticeMfaChallenge", "summary": "Consume one synthetic OTP challenge and create a secure practice UI session", "responses": { "200": { "description": "Verified MFA session" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/mfa/recovery": { "post": { "tags": [ "authentication" ], "operationId": "recoverPracticeMfaChallenge", "summary": "Use the public synthetic recovery code to create an in-Lab recovery challenge", "responses": { "202": { "description": "Recovery challenge created; no external message is sent" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/login": { "post": { "tags": [ "authentication" ], "operationId": "loginPracticeUser", "summary": "Create an HttpOnly practice UI session", "requestBody": { "$ref": "#/components/requestBodies/AuthCredentials" }, "responses": { "200": { "description": "Signed in and secure session cookie set" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/logout": { "post": { "tags": [ "authentication" ], "operationId": "logoutPracticeUser", "summary": "Invalidate the current server-side practice session", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "Session invalidated" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/register": { "post": { "tags": [ "authentication" ], "operationId": "registerPracticeUser", "summary": "Register a sandbox-scoped Customer account", "responses": { "201": { "description": "Sandbox account created" }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/forgot-password": { "post": { "tags": [ "authentication" ], "operationId": "requestPracticePasswordReset", "summary": "Place a non-enumerating synthetic reset message in Practice Inbox", "responses": { "202": { "description": "Generic request accepted response" }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/inbox": { "get": { "tags": [ "authentication" ], "operationId": "getPracticeInbox", "summary": "Read reset links for this isolated sandbox; no email is sent", "responses": { "200": { "description": "Practice Inbox messages" } } } }, "/auth/reset-password": { "post": { "tags": [ "authentication" ], "operationId": "resetPracticePassword", "summary": "Consume a one-time sandbox reset or forced-change token", "responses": { "200": { "description": "Password hash replaced and prior sessions revoked" }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/lockout/reset": { "post": { "tags": [ "authentication" ], "operationId": "resetPracticeLockout", "summary": "Reset a temporary sandbox lock without enumerating accounts", "responses": { "200": { "description": "Generic reset result" } } } }, "/auth/session/expire": { "post": { "tags": [ "authentication" ], "operationId": "expirePracticeSession", "summary": "Deterministically expire the current cookie session", "security": [ { "practiceAuthCookie": [] } ], "responses": { "200": { "description": "Session marked idle-expired" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/me": { "get": { "tags": [ "authentication" ], "operationId": "getPracticeIdentity", "summary": "Read the bearer-token or session-cookie identity", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "Authenticated identity" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/token": { "post": { "tags": [ "authentication" ], "operationId": "issuePracticeTokens", "summary": "Issue a short-lived access token and refresh token", "requestBody": { "$ref": "#/components/requestBodies/AuthCredentials" }, "responses": { "200": { "description": "Bearer and refresh tokens" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/refresh": { "post": { "tags": [ "authentication" ], "operationId": "refreshPracticeToken", "summary": "Rotate a valid one-time practice refresh token", "responses": { "200": { "description": "Rotated tokens" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/api-key/profile": { "get": { "tags": [ "authentication" ], "operationId": "getPracticeApiKeyProfile", "summary": "Authenticate with the public synthetic demo API key", "security": [ { "practiceApiKey": [] } ], "responses": { "200": { "description": "API-key principal" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/auth/protected": { "get": { "tags": [ "authentication" ], "operationId": "readProtectedPracticePermission", "summary": "Exercise 401 versus role-based 403 for a requested permission", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "Permission allowed" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "post": { "tags": [ "authentication" ], "operationId": "executeProtectedPracticePermission", "summary": "Exercise a CSRF-protected role mutation", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "Permission allowed" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/catalog": { "get": { "tags": [ "store" ], "operationId": "listStoreCatalogue", "summary": "Search, filter, sort, and paginate enriched store products", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Search" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 48, "default": 12 } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "minPrice", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "maxPrice", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "rating", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 5 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "featured", "price-asc", "price-desc", "rating-desc", "name-asc" ] } }, { "name": "featured", "in": "query", "schema": { "type": "integer", "enum": [ 1 ] } } ], "responses": { "200": { "description": "Enriched catalogue and pagination metadata" }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/products/{id}": { "get": { "tags": [ "store" ], "operationId": "getStoreProduct", "summary": "Read product images, variants, stock, and fictional reviews", "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "description": "Enriched product" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/cart": { "get": { "tags": [ "store" ], "operationId": "getStoreCart", "summary": "Read the current session guest cart and totals", "responses": { "200": { "description": "Cart items, coupon, discount, and totals" } } } }, "/store/cart/items": { "post": { "tags": [ "store" ], "operationId": "addStoreCartItem", "summary": "Add a product, quantity, and variant to the session cart", "requestBody": { "$ref": "#/components/requestBodies/StoreCartItem" }, "responses": { "201": { "description": "Updated cart" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/cart/items/{id}": { "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "patch": { "tags": [ "store" ], "operationId": "updateStoreCartItem", "summary": "Update one cart quantity", "responses": { "200": { "description": "Updated cart" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } }, "delete": { "tags": [ "store" ], "operationId": "deleteStoreCartItem", "summary": "Remove a product from the session cart", "responses": { "200": { "description": "Updated cart" } } } }, "/store/cart/coupon": { "post": { "tags": [ "store" ], "operationId": "applyStoreCoupon", "summary": "Apply TESTHEON10 or exercise expired and unknown coupon errors", "responses": { "200": { "description": "Coupon applied" }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/locations": { "get": { "tags": [ "store" ], "operationId": "getStoreLocations", "summary": "Read deterministic Country → State → City options", "responses": { "200": { "description": "Location hierarchy" } } } }, "/store/scenario": { "get": { "tags": [ "store" ], "operationId": "getStoreScenario", "summary": "Inspect the pending one-shot session scenario", "responses": { "200": { "description": "Pending scenario or null" } } }, "post": { "tags": [ "store" ], "operationId": "setStoreScenario", "summary": "Arm one deterministic response for the next store GET", "responses": { "202": { "description": "Scenario armed" }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/checkout": { "post": { "tags": [ "store" ], "operationId": "createStoreCheckout", "summary": "Create an order with a signed-in role and fake test card", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "201": { "description": "Synthetic order created; no charge attempted" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/orders": { "get": { "tags": [ "store" ], "operationId": "listStoreOrders", "summary": "Read orders belonging to the signed-in practice identity", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "Authenticated order history" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/profile": { "get": { "tags": [ "store" ], "operationId": "getStoreProfile", "summary": "Read the Chunk 8 identity and its order count", "security": [ { "practiceAuthCookie": [] }, { "bearerAuth": [] } ], "responses": { "200": { "description": "Practice profile" }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/store/reset": { "post": { "tags": [ "store" ], "operationId": "resetStoreData", "summary": "Reset products, orders, cart, coupon, and scenario for this sandbox", "responses": { "200": { "description": "Store state reset" }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/files/upload": { "post": { "operationId": "uploadPracticeFiles", "summary": "Validate and store allowlisted files privately with random non-executable names and a ten-minute TTL", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "files" ], "properties": { "files": { "type": "array", "minItems": 1, "maxItems": 5, "items": { "type": "string", "format": "binary", "maxLength": 2097152 } } } } } } }, "responses": { "201": { "description": "Validated files stored in private temporary storage" }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "413": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "415": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } }, "422": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/files/download/static-pdf": { "get": { "operationId": "downloadStaticPdf", "summary": "Download the static-pdf fixture with attachment disposition", "parameters": [ { "$ref": "#/components/parameters/Delay" } ], "responses": { "200": { "description": "Attachment with a deterministic filename", "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/files/download/static-csv": { "get": { "operationId": "downloadStaticCsv", "summary": "Download the static-csv fixture with attachment disposition", "parameters": [ { "$ref": "#/components/parameters/Delay" } ], "responses": { "200": { "description": "Attachment with a deterministic filename", "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/files/download/static-txt": { "get": { "operationId": "downloadStaticTxt", "summary": "Download the static-txt fixture with attachment disposition", "parameters": [ { "$ref": "#/components/parameters/Delay" } ], "responses": { "200": { "description": "Attachment with a deterministic filename", "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/files/download/dynamic-csv": { "get": { "operationId": "downloadDynamicCsv", "summary": "Download the dynamic-csv fixture with attachment disposition", "parameters": [ { "$ref": "#/components/parameters/Delay" } ], "responses": { "200": { "description": "Attachment with a deterministic filename", "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/files/download/dynamic-pdf": { "get": { "operationId": "downloadDynamicPdf", "summary": "Download the dynamic-pdf fixture with attachment disposition", "parameters": [ { "$ref": "#/components/parameters/Delay" } ], "responses": { "200": { "description": "Attachment with a deterministic filename", "headers": { "Content-Disposition": { "schema": { "type": "string" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/sim/status/{code}": { "get": { "operationId": "simulateStatus", "summary": "Return an allowlisted deterministic HTTP error", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "integer", "enum": [ 400, 401, 403, 404, 409, 422, 429, 500, 503 ] } } ], "responses": { "default": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } }, "/sim/rate-limit": { "get": { "operationId": "simulateRateLimit", "summary": "Return 429 with Retry-After after a caller-scoped deterministic threshold", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 20, "default": 3 } } ], "responses": { "200": { "description": "Below the simulated limit" }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "error": { "code": "VALIDATION_FAILED", "message": "The request contains invalid fields.", "details": [ { "field": "email", "issue": "must be a valid email" } ] }, "requestId": "6edc0fc7be69a451" } } } } } } } }, "components": { "securitySchemes": { "labSessionHeader": { "type": "apiKey", "in": "header", "name": "X-Lab-Session" }, "labSessionCookie": { "type": "apiKey", "in": "cookie", "name": "lab_sid" }, "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "opaque practice token", "description": "Short-lived 120-second synthetic access token." }, "practiceAuthCookie": { "type": "apiKey", "in": "cookie", "name": "practice_auth", "description": "Secure HttpOnly sandbox UI session cookie." }, "practiceApiKey": { "type": "apiKey", "in": "header", "name": "X-Practice-Api-Key", "description": "Public demo key: testheon-demo-key-4803" } }, "parameters": { "ResourceId": { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{2,63}$" } }, "Page": { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, "Limit": { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, "Cursor": { "name": "cursor", "in": "query", "schema": { "type": "string", "maxLength": 500 } }, "Sort": { "name": "sort", "in": "query", "schema": { "type": "string", "example": "name,-id" } }, "Search": { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 200 } }, "Delay": { "name": "delay", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000 } }, "Simulate": { "name": "simulate", "in": "query", "schema": { "type": "integer", "enum": [ 400, 401, 403, 404, 409, 422, 429, 500, 503 ] } }, "Seed": { "name": "seed", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "Size": { "name": "size", "in": "query", "schema": { "type": "string", "enum": [ "small", "medium", "large" ] } }, "ExpiresIn": { "name": "expiresIn", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 86400 } } }, "schemas": { "ErrorEnvelope": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "array", "items": {} } } }, "requestId": { "type": "string" } } }, "Resource": { "type": "object", "required": [ "id" ], "additionalProperties": true, "properties": { "id": { "type": "string" } } }, "ResourceEnvelope": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/Resource" }, "requestId": { "type": "string" } } }, "CollectionEnvelope": { "type": "object", "required": [ "data", "meta", "requestId" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Resource" } }, "meta": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } } } }, "requestBodies": { "ResourceBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 30 } } } }, "AuthCredentials": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string", "example": "standard_user" }, "password": { "type": "string", "example": "Practice@123" }, "rememberMe": { "type": "boolean", "default": false }, "idleSeconds": { "type": "integer", "minimum": 5, "maximum": 1800, "default": 300 }, "scenario": { "type": "string", "enum": [ "expired" ] } } } } } }, "StoreCartItem": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "productId", "quantity", "variant" ], "properties": { "productId": { "type": "string" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 20 }, "variant": { "type": "string", "maxLength": 100 } } } } } } } }, "security": [ { "labSessionHeader": [] }, { "labSessionCookie": [] } ], "x-testheon-fixture-version": "1.0.0", "x-error-catalogue": { "BAD_REQUEST": 400, "SESSION_INVALID": 401, "AUTHENTICATION_FAILED": 401, "TOKEN_INVALID": 401, "PERMISSION_DENIED": 403, "CSRF_REJECTED": 403, "NOT_FOUND": 404, "DUPLICATE_RECORD": 409, "BODY_TOO_LARGE": 413, "VALIDATION_FAILED": 422, "RATE_LIMITED": 429, "STORAGE_FAILURE": 500, "CAPACITY_REACHED": 503 }, "x-cors-policy": "Same-origin by default. Explicit localhost origins may make non-credentialed requests with Content-Type and X-Lab-Session. Credentialed wildcard CORS is never emitted." }