{ "openapi": "3.0.0", "info": { "title": "Trading Card API", "description": "Trading Card API provides comprehensive access to trading card data including cards, sets, players, teams, and related information. Built with Laravel and following JSON:API specification.", "contact": { "name": "Trading Card API Support", "url": "https://tradingcardapi.com", "email": "support@tradingcardapi.com" }, "license": { "name": "MIT", "url": "https://opensource.org/licenses/MIT" }, "version": "0.7.18" }, "servers": [ { "url": "https://api.tradingcardapi.com", "description": "Production API Server" }, { "url": "https://api.tradingcardapi.dev:8243", "description": "Development API Server" }, { "url": "http://localhost:8000", "description": "Local Development Server" } ], "paths": { "/v1/attributes": { "get": { "tags": [ "Attributes v1" ], "summary": "Get all card attributes (v1)", "description": "Retrieve a paginated list of all card attributes (autographs, variations, etc.)", "operationId": "8ec5febc0c1fe69e4bd6bdb8004f5ac8", "parameters": [ { "name": "name", "in": "query", "description": "Filter by attribute name", "required": false, "schema": { "type": "string", "example": "Autograph" } }, { "name": "limit", "in": "query", "description": "Number of attributes per page", "required": false, "schema": { "type": "integer", "default": 25, "example": 25 } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of attributes retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Attribute" } }, "included": { "type": "array", "items": { "type": "object" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Attributes v1" ], "summary": "Create a new attribute (v1)", "description": "Create a new card attribute (autograph, variation, etc.)", "operationId": "fb15304ee62a73602f1f291051e1ea9b", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "attributes" }, "attributes": { "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Autograph" }, "description": { "type": "string", "example": "Player's signature on card", "nullable": true }, "color": { "type": "string", "example": "#FF0000", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Attribute created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Attribute" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/attributes/{id}": { "get": { "tags": [ "Attributes v1" ], "summary": "Get a specific attribute (v1)", "description": "Retrieve detailed information about a specific card attribute by ID", "operationId": "6b9c4b39c0f0d9918e6574a64671c9bf", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the attribute to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Attribute retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Attribute" }, "included": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Attribute not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Attributes v1" ], "summary": "Update an attribute (v1)", "description": "Update an existing card attribute", "operationId": "11fbf4dd4e67977a5bf00b77cd6523e9", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the attribute to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "attributes" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Autograph" }, "description": { "type": "string", "example": "Player's signature on card", "nullable": true }, "color": { "type": "string", "example": "#FF0000", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Attribute updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Attribute" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Attribute not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Attributes v1" ], "summary": "Delete an attribute (v1)", "description": "Delete an existing card attribute", "operationId": "57546411183527ec6130768b713d39c8", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the attribute to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Attribute deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Attribute not found" }, "500": { "description": "Internal server error" } } } }, "/v1/brands": { "get": { "tags": [ "Brands v1" ], "summary": "Get all brands (v1)", "description": "Retrieve a list of all trading card brands", "operationId": "b5c13cd4dc464d5cc75e230a9389ac27", "parameters": [ { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of brands retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Brand" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Brands v1" ], "summary": "Create a new brand (v1)", "description": "Create a new trading card brand", "operationId": "6429aaddf9163ecf305e4f674658cf20", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "brands" }, "attributes": { "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Topps" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Brand created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Brand" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/brands/{id}": { "get": { "tags": [ "Brands v1" ], "summary": "Get a specific brand (v1)", "description": "Retrieve detailed information about a specific brand by ID", "operationId": "4817d34cd19ecc819eb226c0ecbab4ae", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the brand to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Brand retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Brand" } }, "type": "object" } } } }, "404": { "description": "Brand not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Brands v1" ], "summary": "Update a brand (v1)", "description": "Update an existing brand", "operationId": "dfb211a910831ebf0742e37f9f22db82", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the brand to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "brands" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Topps" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Brand updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Brand" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Brand not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Brands v1" ], "summary": "Delete a brand (v1)", "description": "Delete an existing brand", "operationId": "2122ec5bb25f226e85cd2781921a72ff", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the brand to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Brand deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Brand not found" }, "500": { "description": "Internal server error" } } } }, "/v1/cards": { "get": { "tags": [ "Cards v1" ], "summary": "Get all cards (v1)", "description": "Retrieve a paginated list of all trading cards in the system", "operationId": "8ca38beaebdf245e5abd2b1572fbc931", "parameters": [ { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include (set,oncard,attributes,children)", "required": false, "schema": { "type": "string", "example": "set,oncard" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 25 } } ], "responses": { "200": { "description": "List of cards retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Card" } }, "included": { "type": "array", "items": { "type": "object" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Cards v1" ], "summary": "Create a new card (v1)", "description": "Create a new trading card record", "operationId": "efa130a8b82341ef6847a5de8fa4e319", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "cards" }, "attributes": { "properties": { "number": { "description": "Card number within the set", "type": "string", "example": "23" }, "serial_number": { "type": "string", "example": "001/100", "nullable": true }, "image_uuid": { "description": "UUID reference for card image", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000", "nullable": true }, "title": { "type": "string", "example": "Rookie Card", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "type": "object" }, "relationships": { "properties": { "set": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "sets" }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } }, "type": "object" }, "oncard": { "properties": { "data": { "type": "array", "items": { "properties": { "type": { "type": "string", "enum": [ "players", "teams", "playerteams" ] }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Card created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Card" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/cards/{id}": { "get": { "tags": [ "Cards v1" ], "summary": "Get a specific card (v1)", "description": "Retrieve detailed information about a specific trading card by ID", "operationId": "456f44a8ffffdc3baa3faf7a6d244cb8", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the card to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include (set,oncard,attributes,children)", "required": false, "schema": { "type": "string", "example": "set,oncard" } } ], "responses": { "200": { "description": "Card retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Card" }, "included": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Card not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Cards v1" ], "summary": "Update a card (v1)", "description": "Update an existing trading card record", "operationId": "47862d770d6f04c49dab71da7720ad61", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the card to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "cards" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "number": { "type": "string", "example": "23" }, "serial_number": { "type": "string", "example": "001/100", "nullable": true }, "image_uuid": { "description": "UUID reference for card image", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000", "nullable": true }, "title": { "type": "string", "example": "Rookie Card", "nullable": true }, "notes": { "type": "string", "nullable": true }, "attributes": { "description": "Extra attributes for the card", "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" } }, "type": "object" } } }, "type": "object" }, "relationships": { "properties": { "set": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "sets" }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } }, "type": "object" }, "oncard": { "properties": { "data": { "type": "array", "items": { "properties": { "type": { "type": "string", "enum": [ "players", "teams", "playerteams" ] }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Card updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Card" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Card not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Cards v1" ], "summary": "Delete a card (v1)", "description": "Delete an existing trading card record", "operationId": "278451b0f3c3f00589bc9906b28ca802", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the card to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Card deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Card not found" }, "500": { "description": "Internal server error" } } } }, "/v1/card-images": { "get": { "tags": [ "Card Images" ], "summary": "List all card images", "description": "List all card images", "operationId": "2a7d4cfb9c74af20ae41018f0603a1dd", "parameters": [ { "name": "include", "in": "query", "description": "Include related resources (card)", "schema": { "type": "string", "example": "card" } } ], "responses": { "200": { "description": "List of card images" } } }, "post": { "tags": [ "Card Images" ], "summary": "Upload a new card image", "description": "Upload a new card image", "operationId": "4fccd2edbe32ff6db21fcd7bd96010e0", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "file", "data" ], "properties": { "file": { "description": "Image file (JPEG, PNG, or WebP, max 10MB, max 4000x4000px)", "type": "string", "format": "binary" }, "data": { "description": "JSON:API formatted data", "type": "string", "format": "json", "example": "{\"type\":\"card_images\",\"attributes\":{\"card_id\":\"uuid\",\"image_type\":\"front\"}}" } }, "type": "object" } } } }, "responses": { "201": { "description": "Image uploaded successfully" }, "422": { "description": "Validation error" } } } }, "/v1/card-images/{id}": { "get": { "tags": [ "Card Images" ], "summary": "Get a specific card image", "description": "Get a specific card image", "operationId": "27b3ff616feca812948f312954cba8fd", "parameters": [ { "name": "id", "in": "path", "description": "Card image UUID", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Include related resources (card)", "schema": { "type": "string", "example": "card" } } ], "responses": { "200": { "description": "Card image details" }, "404": { "description": "Card image not found" } } }, "delete": { "tags": [ "Card Images" ], "summary": "Delete a card image", "description": "Delete a card image", "operationId": "7b904c4ced4f620b7ae2a5790b1ad0a7", "parameters": [ { "name": "id", "in": "path", "description": "Card image UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Image deleted successfully" }, "404": { "description": "Card image not found" } } }, "patch": { "tags": [ "Card Images" ], "summary": "Update a card image", "description": "Update a card image", "operationId": "d1228e8f6f985626c326bbeae9d35aa4", "parameters": [ { "name": "id", "in": "path", "description": "Card image UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Image updated successfully" }, "404": { "description": "Card image not found" } } } }, "/v1/card-images/{id}/download": { "get": { "tags": [ "Card Images" ], "summary": "Download the actual image file", "description": "Download/stream the actual image file", "operationId": "04a84a53df5cdcb97e1edbb134547be8", "parameters": [ { "name": "id", "in": "path", "description": "Card image UUID", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "size", "in": "query", "description": "Image size variant. Sizes configured in config/images.php (default: small/medium/large)", "required": false, "schema": { "type": "string", "default": "original", "enum": [ "original", "small", "medium", "large" ] } } ], "responses": { "200": { "description": "Image file stream", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Card image or variant not found" } } } }, "/v1/card-images/bulk": { "post": { "tags": [ "Card Images" ], "summary": "Upload multiple card images in a batch", "description": "Accepts up to 50 images per request. Returns immediately with a batch ID for polling status.", "operationId": "6de663c5795174fd44d50a97e617fe19", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "files", "data" ], "properties": { "files[]": { "description": "Image files (max 50, each max 10MB, JPEG/PNG/WebP)", "type": "array", "items": { "type": "string", "format": "binary" } }, "data": { "description": "JSON:API formatted data with mappings", "type": "string", "format": "json", "example": "{\"type\":\"bulk_card_images\",\"attributes\":{\"mappings\":[...]}}" } }, "type": "object" } } } }, "responses": { "202": { "description": "Batch accepted for processing" }, "422": { "description": "Validation error" } } } }, "/v1/card-images/bulk/{batch_id}": { "get": { "tags": [ "Card Images" ], "summary": "Get bulk upload batch status", "description": "Returns bulk upload batch status and progress. Poll to track progress.", "operationId": "6399b2acb22ae6bd311291550e3d3f4f", "parameters": [ { "name": "batch_id", "in": "path", "description": "Batch UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Batch status" }, "404": { "description": "Batch not found" } } } }, "/v1/genres": { "get": { "tags": [ "Genres v1" ], "summary": "Get all genres (v1)", "description": "Retrieve a paginated list of all trading card genres", "operationId": "c3b85b59e35b870910a760b6eb1e00b5", "parameters": [ { "name": "limit", "in": "query", "description": "Number of genres per page", "required": false, "schema": { "type": "integer", "default": 25, "example": 25 } }, { "name": "name", "in": "query", "description": "Filter by genre name", "required": false, "schema": { "type": "string" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of genres retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Genre" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Genres v1" ], "summary": "Create a new genre (v1)", "description": "Create a new trading card genre, restoring if previously soft-deleted", "operationId": "fc0d0c44d5c6aa63bf5b7ceebf14e4d7", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "genres" }, "attributes": { "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Baseball" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Genre created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Genre" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/genres/{id}": { "get": { "tags": [ "Genres v1" ], "summary": "Get a specific genre (v1)", "description": "Retrieve detailed information about a specific genre by ID", "operationId": "5490dedf2128bdd1ff8cc97ea8400a23", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the genre to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Genre retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Genre" } }, "type": "object" } } } }, "404": { "description": "Genre not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Genres v1" ], "summary": "Update a genre (v1)", "description": "Update an existing genre record", "operationId": "061fa1f681336dd09daa65ce35b3b646", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the genre to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "genres" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Baseball" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Genre updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Genre" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Genre not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Genres v1" ], "summary": "Delete a genre (v1)", "description": "Soft delete an existing genre record", "operationId": "1c6920f7e9e1616403f8f5119bda7daf", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the genre to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Genre archived successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Genre" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Genre not found" }, "500": { "description": "Internal server error" } } } }, "/v1/genres/deleted": { "get": { "tags": [ "Genres v1", "Internal" ], "summary": "Get deleted genres (v1)", "description": "Retrieve a list of all soft-deleted genres", "operationId": "f565e84a0c93208ddb6ae3ae0cbfc31f", "responses": { "200": { "description": "List of deleted genres retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Genre" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } } }, "/v1/manufacturers": { "get": { "tags": [ "Manufacturers v1" ], "summary": "Get all manufacturers (v1)", "description": "Retrieve a list of all trading card manufacturers", "operationId": "02ad7606ce333077033623c3e12a5a7c", "parameters": [ { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of manufacturers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Manufacturer" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Manufacturers v1" ], "summary": "Create a new manufacturer (v1)", "description": "Create a new trading card manufacturer", "operationId": "1819d0360d6988a56483e681910cc26c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "manufacturers" }, "attributes": { "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Topps Company" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Manufacturer created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Manufacturer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/manufacturers/{id}": { "get": { "tags": [ "Manufacturers v1" ], "summary": "Get a specific manufacturer (v1)", "description": "Retrieve detailed information about a specific manufacturer by ID", "operationId": "ff850ede26139ea8a468e244900ae790", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the manufacturer to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Manufacturer retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Manufacturer" } }, "type": "object" } } } }, "404": { "description": "Manufacturer not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Manufacturers v1" ], "summary": "Update a manufacturer (v1)", "description": "Update an existing manufacturer", "operationId": "be93e51b230154e625b9c830d0b1d569", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the manufacturer to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "manufacturers" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Topps Company" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Manufacturer updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Manufacturer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Manufacturer not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Manufacturers v1" ], "summary": "Delete a manufacturer (v1)", "description": "Delete an existing manufacturer", "operationId": "f1ba36f8fd07a19f439b48905e44d39d", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the manufacturer to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Manufacturer deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Manufacturer not found" }, "500": { "description": "Internal server error" } } } }, "/v1/object-attributes": { "get": { "tags": [ "ObjectAttributes v1" ], "summary": "Get all object attributes (v1)", "description": "Retrieve a paginated list of all object attributes (card-specific attribute instances)", "operationId": "fc7b19c2bcfe222f1f89908019f1e5fb", "parameters": [ { "name": "limit", "in": "query", "description": "Number of object attributes per page", "required": false, "schema": { "type": "integer", "default": 25, "example": 25 } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of object attributes retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectAttribute" } }, "included": { "type": "array", "items": { "type": "object" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "ObjectAttributes v1" ], "summary": "Create a new object attribute (v1)", "description": "Create a new object attribute instance linking an attribute to a specific object (card)", "operationId": "381b1817fa6c11a076b632fb08f782b8", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "object-attributes" }, "attributes": { "required": [ "attribute_id", "attribute_value", "object_type", "object_id" ], "properties": { "attribute_id": { "description": "ID of the attribute definition", "type": "string", "format": "uuid" }, "attribute_value": { "description": "Value of the attribute for this object", "type": "string", "example": "Authenticated" }, "object_type": { "description": "Type of object this attribute is attached to", "type": "string", "example": "App\\Models\\Card" }, "object_id": { "description": "ID of the object this attribute is attached to", "type": "string", "format": "uuid" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Object attribute created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ObjectAttribute" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/object-attributes/{id}": { "get": { "tags": [ "ObjectAttributes v1" ], "summary": "Get a specific object attribute (v1)", "description": "Retrieve detailed information about a specific object attribute by ID", "operationId": "732eebf73afde0f614385eb2f2723f48", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the object attribute to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Object attribute retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ObjectAttribute" }, "included": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Object attribute not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "ObjectAttributes v1" ], "summary": "Update an object attribute (v1)", "description": "Update an existing object attribute instance", "operationId": "49c1dbcac4c9d86c0d6f4b73bfe314c0", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the object attribute to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "object-attributes" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "attribute_id": { "type": "string", "format": "uuid" }, "attribute_value": { "type": "string", "example": "Authenticated" }, "object_type": { "type": "string", "example": "App\\Models\\Card" }, "object_id": { "type": "string", "format": "uuid" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Object attribute updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ObjectAttribute" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Object attribute not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "ObjectAttributes v1" ], "summary": "Delete an object attribute (v1)", "description": "Delete an existing object attribute instance", "operationId": "a4d7e533a0f10965e57a0b9d3efbeea1", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the object attribute to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Object attribute deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Object attribute not found" }, "500": { "description": "Internal server error" } } } }, "/v1/players": { "get": { "tags": [ "Players v1" ], "summary": "Get all players (v1)", "description": "Retrieve a paginated list of all players with optional filtering", "operationId": "004e683e9cc71367abd00c0be1030180", "parameters": [ { "name": "first_name", "in": "query", "description": "Filter by player first name", "required": false, "schema": { "type": "string", "example": "Michael" } }, { "name": "last_name", "in": "query", "description": "Filter by player last name", "required": false, "schema": { "type": "string", "example": "Jordan" } }, { "name": "full_name", "in": "query", "description": "Filter by full name (searches both first and last name)", "required": false, "schema": { "type": "string", "example": "Michael Jordan" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of players retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Player" } }, "included": { "type": "array", "items": { "type": "object" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Players v1" ], "summary": "Create a new player (v1)", "description": "Create a new player record", "operationId": "f55914131a54823b5d9750edbfae138d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "players" }, "attributes": { "properties": { "first_name": { "type": "string", "example": "Michael" }, "last_name": { "type": "string", "example": "Jordan" }, "position": { "type": "string", "example": "Shooting Guard", "nullable": true }, "full_name": { "description": "Alternative to first_name/last_name", "type": "string", "example": "Michael Jordan" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Player created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Player" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/players/{id}": { "get": { "tags": [ "Players v1" ], "summary": "Get a specific player (v1)", "description": "Retrieve detailed information about a specific player by ID", "operationId": "aec93dd485cc6c179e3a836a79844a16", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the player to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Player retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Player" }, "included": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Player not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Players v1" ], "summary": "Update a player (v1)", "description": "Update an existing player record", "operationId": "d9b41090ac4d964a40faf532fdbc36c3", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the player to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "players" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "first_name": { "type": "string", "example": "Michael" }, "last_name": { "type": "string", "example": "Jordan" }, "position": { "type": "string", "example": "Shooting Guard", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Player updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Player" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Player not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Players v1" ], "summary": "Delete a player (v1)", "description": "Delete an existing player record", "operationId": "482616b1181bd0f6c767dd036c4105f4", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the player to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Player deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Player not found" }, "500": { "description": "Internal server error" } } } }, "/v1/playerteams": { "get": { "tags": [ "PlayerTeams v1" ], "summary": "Get all player-team associations (v1)", "description": "Retrieve a paginated list of player-team associations with optional filtering", "operationId": "ee1ac4dd012930b2c8d6dd69b01a3932", "parameters": [ { "name": "team_id", "in": "query", "description": "Filter by team ID", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "player_id", "in": "query", "description": "Filter by player ID", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "Number of player-teams per page", "required": false, "schema": { "type": "integer", "default": 25, "example": 25 } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include (player,team)", "required": false, "schema": { "type": "string", "example": "player,team" } } ], "responses": { "200": { "description": "List of player-team associations retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerTeam" } }, "included": { "type": "array", "items": { "type": "object" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "PlayerTeams v1" ], "summary": "Create a new player-team association (v1)", "description": "Create a new player-team association record", "operationId": "c57411107516908ce5acb40b95135b7c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "playerteams" }, "attributes": { "required": [ "player_id", "team_id" ], "properties": { "player_id": { "description": "ID of the player", "type": "string", "format": "uuid" }, "team_id": { "description": "ID of the team", "type": "string", "format": "uuid" }, "start_year": { "type": "integer", "example": 2020, "nullable": true }, "end_year": { "type": "integer", "example": 2023, "nullable": true }, "jersey_number": { "type": "string", "example": "23", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Player-team association created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PlayerTeam" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/playerteams/{id}": { "get": { "tags": [ "PlayerTeams v1" ], "summary": "Get a specific player-team association (v1)", "description": "Retrieve detailed information about a specific player-team association by ID", "operationId": "c9f2b1422dc3884bcdf5e1e85dedcc5a", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the player-team association to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include (player,team)", "required": false, "schema": { "type": "string", "example": "player,team" } } ], "responses": { "200": { "description": "Player-team association retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/PlayerTeam" }, "included": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Player-team association not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } } }, "/v1/sets": { "get": { "tags": [ "Sets v1" ], "summary": "Get all card sets (v1)", "description": "Retrieve a paginated list of all trading card sets", "operationId": "d7f2227fc3316148ca488a16c52a8395", "parameters": [ { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Number of sets per page (max 100, default 25)", "required": false, "schema": { "type": "integer", "default": 25, "maximum": 100, "example": 25 } }, { "name": "limit", "in": "query", "description": "Number of sets per page (deprecated, use per_page instead)", "required": false, "deprecated": true, "schema": { "type": "integer", "default": 25, "example": 25 } }, { "name": "order_by", "in": "query", "description": "Field to order by", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "name", "created_at", "updated_at", "card_count" ], "example": "name" } }, { "name": "sort", "in": "query", "description": "Sort direction", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] } }, { "name": "name", "in": "query", "description": "Filter by set name", "required": false, "schema": { "type": "string" } }, { "name": "genre", "in": "query", "description": "Filter by genre ID", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "List of card sets retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Set" } }, "included": { "type": "array", "items": { "type": "object" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Sets v1" ], "summary": "Create a new set (v1)", "description": "Create a new trading card set", "operationId": "b5d29d875d5effb4b734eec7f256ea3f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "sets" }, "attributes": { "required": [ "name" ], "properties": { "name": { "type": "string", "example": "1989 Topps Baseball" }, "description": { "type": "string", "nullable": true }, "total_cards": { "type": "integer", "example": 792, "nullable": true }, "genre_id": { "type": "string", "format": "uuid", "nullable": true }, "manufacturer_id": { "type": "string", "format": "uuid", "nullable": true }, "brand_id": { "type": "string", "format": "uuid", "nullable": true }, "year_id": { "type": "string", "format": "uuid", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Set created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Set" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/sets/{id}": { "get": { "tags": [ "Sets v1" ], "summary": "Get a specific set (v1)", "description": "Retrieve detailed information about a specific trading card set by ID", "operationId": "064e89a4003497d86c7de37a88f2ed81", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Set retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Set" }, "included": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Set not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Sets v1" ], "summary": "Update a set (v1)", "description": "Update an existing trading card set", "operationId": "c81c861f07431e419b3840f9d8368396", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "sets" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "1989 Topps Baseball" }, "description": { "type": "string", "nullable": true }, "total_cards": { "type": "integer", "example": 792, "nullable": true }, "genre_id": { "type": "string", "format": "uuid", "nullable": true }, "manufacturer_id": { "type": "string", "format": "uuid", "nullable": true }, "brand_id": { "type": "string", "format": "uuid", "nullable": true }, "year_id": { "type": "string", "format": "uuid", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Set updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Set" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Set not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Sets v1" ], "summary": "Delete a set (v1)", "description": "Delete an existing trading card set", "operationId": "68688782f14166f901b4aa291b6d5973", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Set deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Set not found" }, "500": { "description": "Internal server error" } } } }, "/v1/sets/{id}/checklist": { "get": { "tags": [ "Sets v1" ], "summary": "Get set checklist (v1)", "description": "Retrieve the complete checklist for a trading card set including all cards. Supports compact format for large sets to avoid response size limits. Compact format returns only id, number, and name fields, reducing response size by ~75%.", "operationId": "1b6dfaf29fb4ec07eda7542f5df3d16a", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set to get checklist for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "description": "Response format: 'full' returns all card fields, 'compact' returns only id, number, and name", "required": false, "schema": { "type": "string", "default": "full", "enum": [ "full", "compact" ], "example": "compact" } }, { "name": "page", "in": "query", "description": "Page number for pagination (starts at 1)", "required": false, "schema": { "type": "integer", "default": 1, "example": 1 } }, { "name": "per_page", "in": "query", "description": "Number of cards per page (max 100, returns all if not specified)", "required": false, "schema": { "type": "integer", "maximum": 100, "example": 50 } } ], "responses": { "200": { "description": "Set checklist retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Set" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/Card" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "404": { "description": "Set not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Sets v1" ], "summary": "Add checklist to set (v1)", "description": "Add or import a checklist to a trading card set. Can either generate empty cards or parse a detailed checklist.", "operationId": "bcf64216e17766dfdb8f1a6719476af7", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set to add checklist to", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "description": "Leave empty to generate empty cards based on total_cards, or provide checklist data to parse", "properties": { "data": { "properties": { "type": { "type": "string", "example": "checklist" }, "attributes": { "properties": { "checklist": { "description": "Raw checklist text to parse", "type": "string" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "202": { "description": "Checklist processing accepted (async operation)" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Set not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/set-sources": { "get": { "tags": [ "Set Sources v1" ], "summary": "Get all set sources (v1)", "description": "Retrieve a list of all set sources", "operationId": "8e46b85ee745c5d94555cc8e169ff704", "parameters": [ { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include (set)", "required": false, "schema": { "type": "string", "example": "set" } } ], "responses": { "200": { "description": "List of set sources retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SetSource" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Set Sources v1" ], "summary": "Create a new set source (v1)", "description": "Create a new set source tracking record", "operationId": "308a40c6c9b8c1118daf5896f2e77f5f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "set_sources" }, "attributes": { "required": [ "set_id", "source_url", "source_type" ], "properties": { "set_id": { "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "source_url": { "type": "string", "format": "url", "example": "https://example.com/checklist" }, "source_name": { "type": "string", "example": "CardboardConnection", "nullable": true }, "source_type": { "type": "string", "enum": [ "checklist", "metadata", "images" ], "example": "checklist" }, "verified_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Set source created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SetSource" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/set-sources/{id}": { "get": { "tags": [ "Set Sources v1" ], "summary": "Get a specific set source (v1)", "description": "Retrieve detailed information about a specific set source by ID", "operationId": "85bb8d9fce82173ef7cc0e7abc8291e7", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set source to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include (set)", "required": false, "schema": { "type": "string", "example": "set" } } ], "responses": { "200": { "description": "Set source retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SetSource" } }, "type": "object" } } } }, "404": { "description": "Set source not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Set Sources v1" ], "summary": "Update a set source (v1)", "description": "Update an existing set source", "operationId": "f4917ecb00022db2cbd843566c6d19bd", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set source to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "set_sources" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "source_url": { "type": "string", "format": "url" }, "source_name": { "type": "string", "nullable": true }, "source_type": { "type": "string", "enum": [ "checklist", "metadata", "images" ] }, "verified_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Set source updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SetSource" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Set source not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Set Sources v1" ], "summary": "Delete a set source (v1)", "description": "Delete an existing set source", "operationId": "d0e75e6b67e2aa265f997a698ad8dba7", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set source to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Set source deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Set source not found" }, "500": { "description": "Internal server error" } } } }, "/v1/stats/{modelType}": { "get": { "tags": [ "Statistics v1", "Internal" ], "summary": "Get statistics for a model type (v1)", "description": "Retrieve daily statistics showing creation and deletion counts for a specific model type", "operationId": "dfa571649dbcea442ed8bb6432eedf8d", "parameters": [ { "name": "modelType", "in": "path", "description": "Type of model to get statistics for (e.g., cards, sets, players)", "required": true, "schema": { "type": "string", "example": "cards" } } ], "responses": { "200": { "description": "Statistics retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "stats" }, "attributes": { "properties": { "model": { "type": "string", "example": "cards" }, "unit": { "type": "string", "example": "daily" }, "count": { "type": "integer", "example": 30 }, "stats": { "type": "array", "items": { "properties": { "date": { "type": "string", "format": "date", "example": "2024-01-15" }, "count": { "type": "integer", "example": 5 }, "total": { "type": "integer", "example": 150 } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Model type not found" }, "500": { "description": "Internal server error" } } } }, "/v1/stats/counts": { "get": { "tags": [ "Statistics v1" ], "summary": "Get current counts for all entity types", "description": "Get entity counts by status. Cached for 1 hour.", "operationId": "f5ddbc369d67b2c50c26ed32422ce1e2", "responses": { "200": { "description": "Counts retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "stats" }, "attributes": { "properties": { "counts": { "type": "array", "items": { "properties": { "entity_type": { "type": "string", "example": "set" }, "total": { "type": "integer", "example": 21616 }, "published": { "type": "integer", "example": 730 }, "draft": { "type": "integer", "example": 20886 }, "archived": { "type": "integer", "example": 0 } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } } }, "/v1/stats/snapshots": { "get": { "tags": [ "Statistics v1" ], "summary": "Get historical snapshots with optional filtering", "description": "Get historical snapshots with date/type filters.", "operationId": "e333471f011adf35b885874732ead2e4", "parameters": [ { "name": "entity_type", "in": "query", "description": "Filter by entity type", "required": false, "schema": { "type": "string", "enum": [ "set", "card", "player", "team" ] } }, { "name": "from", "in": "query", "description": "Filter snapshots from this date (YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" } }, { "name": "to", "in": "query", "description": "Filter snapshots to this date (YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-31" } }, { "name": "per_page", "in": "query", "description": "Number of results per page (default: 100, max: 500)", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1 } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "Snapshots retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "snapshots" }, "attributes": { "properties": { "snapshots": { "type": "array", "items": { "properties": { "date": { "type": "string", "format": "date", "example": "2024-01-15" }, "entity_type": { "type": "string", "example": "set" }, "total": { "type": "integer", "example": 21616 }, "published": { "type": "integer", "example": 730 }, "draft": { "type": "integer", "example": 20886 }, "archived": { "type": "integer", "example": 0 } }, "type": "object" } }, "entity_type": { "type": "string", "example": "set", "nullable": true }, "from": { "type": "string", "format": "date", "nullable": true }, "to": { "type": "string", "format": "date", "nullable": true } }, "type": "object" } }, "type": "object" }, "meta": { "properties": { "total": { "type": "integer", "example": 100 }, "per_page": { "type": "integer", "example": 100 }, "current_page": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/stats/growth": { "get": { "tags": [ "Statistics v1" ], "summary": "Get growth metrics for a specific time period", "description": "Compare current counts to previous period. Cached for 1 hour.", "operationId": "f285ec768e8e87460ea8ce956e552910", "parameters": [ { "name": "period", "in": "query", "description": "Time period for comparison", "required": false, "schema": { "type": "string", "default": "7d", "enum": [ "7d", "30d", "90d", "1y", "week", "month" ] } } ], "responses": { "200": { "description": "Growth metrics retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "growth" }, "attributes": { "properties": { "period": { "type": "string", "example": "7d" }, "metrics": { "type": "array", "items": { "properties": { "entity_type": { "type": "string", "example": "set" }, "current": { "type": "integer", "example": 21616 }, "previous": { "type": "integer", "example": 21500 }, "change": { "type": "integer", "example": 116 }, "percentage_change": { "type": "number", "format": "float", "example": 0.54 } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/teams": { "get": { "tags": [ "Teams v1" ], "summary": "Get all teams (v1)", "description": "Retrieve a paginated list of all teams with optional filtering", "operationId": "f374ab65aad02e4bfaeead9792081430", "parameters": [ { "name": "location", "in": "query", "description": "Filter by team location", "required": false, "schema": { "type": "string", "example": "Chicago" } }, { "name": "mascot", "in": "query", "description": "Filter by team mascot", "required": false, "schema": { "type": "string", "example": "Bulls" } }, { "name": "name", "in": "query", "description": "Filter by full team name (searches both location and mascot)", "required": false, "schema": { "type": "string", "example": "Chicago Bulls" } }, { "name": "genre_id", "in": "query", "description": "Filter by genre ID", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "Number of teams per page", "required": false, "schema": { "type": "integer", "default": 25, "example": 25 } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of teams retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "included": { "type": "array", "items": { "type": "object" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Teams v1" ], "summary": "Create a new team (v1)", "description": "Create a new team record", "operationId": "b900abe08fcefd441f052fe85860f6ac", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "teams" }, "attributes": { "properties": { "location": { "type": "string", "example": "Chicago" }, "mascot": { "type": "string", "example": "Bulls" }, "city": { "type": "string", "example": "Chicago", "nullable": true }, "abbreviation": { "type": "string", "example": "CHI", "nullable": true }, "name": { "description": "Alternative to location/mascot", "type": "string", "example": "Chicago Bulls" }, "genre_id": { "type": "string", "format": "uuid", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Team created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Team" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/teams/{id}": { "get": { "tags": [ "Teams v1" ], "summary": "Get a specific team (v1)", "description": "Retrieve detailed information about a specific team by ID", "operationId": "8a0d7c91b4690ce9461178c3116825b7", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the team to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Team retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Team" }, "included": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Team not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Teams v1" ], "summary": "Update a team (v1)", "description": "Update an existing team record", "operationId": "34a5d590c339eeb1ea904a19b257fb11", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the team to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "teams" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "location": { "type": "string", "example": "Chicago" }, "mascot": { "type": "string", "example": "Bulls" }, "city": { "type": "string", "example": "Chicago", "nullable": true }, "abbreviation": { "type": "string", "example": "CHI", "nullable": true }, "genre_id": { "type": "string", "format": "uuid", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Team updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Team" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Team not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Teams v1" ], "summary": "Delete a team (v1)", "description": "Delete an existing team record", "operationId": "af63613177386e048b8490a28d3347fe", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the team to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Team deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Team not found" }, "500": { "description": "Internal server error" } } } }, "/v1/years": { "get": { "tags": [ "Years v1" ], "summary": "Get all years (v1)", "description": "Retrieve a list of all years available for trading card sets", "operationId": "f1bb799712a5a7a2bf5d85fee99fb4c0", "parameters": [ { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of years retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Year" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Years v1" ], "summary": "Create a new year (v1)", "description": "Create a new year record for trading card classification", "operationId": "950f79c472b21da8a67c2742ca34fc7e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "years" }, "attributes": { "required": [ "year" ], "properties": { "year": { "type": "string", "example": "1989" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Year created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Year" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } } }, "/v1/years/{id}": { "get": { "tags": [ "Years v1" ], "summary": "Get a specific year (v1)", "description": "Retrieve detailed information about a specific year by ID", "operationId": "6397f74c26e9a18fbb3bd0e6aaad431b", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the year to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Year retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Year" } }, "type": "object" } } } }, "404": { "description": "Year not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } }, "put": { "tags": [ "Years v1" ], "summary": "Update a year (v1)", "description": "Update an existing year record", "operationId": "fad781cc0ff8e1b8c34c0e0ddf201bdc", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the year to update", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "years" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "year": { "type": "string", "example": "1989" }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Year updated successfully", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Year" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Year not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Years v1" ], "summary": "Delete a year (v1)", "description": "Delete an existing year record", "operationId": "c8b33062a0150e328b5abd21d0ad22f9", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the year to delete", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Year deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Year not found" }, "500": { "description": "Internal server error" } } } }, "/v2/sets/{id}/checklist": { "get": { "tags": [ "Sets v2" ], "summary": "Get set checklist (v2)", "description": "Retrieve the complete checklist for a trading card set. V2 returns cards as the primary data with set information in the included array. Supports compact format for large sets to avoid response size limits. Compact format returns only id, number, and name fields, reducing response size by ~75%.", "operationId": "ed5f7cec17b414116511eafd5c2a381a", "parameters": [ { "name": "id", "in": "path", "description": "UUID of the set to get checklist for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include", "in": "query", "description": "Comma-separated list of relationships to include (set,oncard,attributes)", "required": false, "schema": { "type": "string", "example": "set" } }, { "name": "format", "in": "query", "description": "Response format: 'full' returns all card fields, 'compact' returns only id, number, and name", "required": false, "schema": { "type": "string", "default": "full", "enum": [ "full", "compact" ], "example": "compact" } }, { "name": "page", "in": "query", "description": "Page number for pagination (starts at 1)", "required": false, "schema": { "type": "integer", "default": 1, "example": 1 } }, { "name": "per_page", "in": "query", "description": "Number of cards per page (max 100, returns all if not specified)", "required": false, "schema": { "type": "integer", "maximum": 100, "example": 50 } } ], "responses": { "200": { "description": "Set checklist retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Card" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/Set" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "type": "object" } } } }, "404": { "description": "Set not found" }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal server error" } } } }, "/version": { "get": { "tags": [ "Version" ], "summary": "Get API version information", "description": "Retrieve version information about the API, application, and supported versions", "operationId": "68ebbc03a53fc2b59a83dae7499e4f64", "responses": { "200": { "description": "Version information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "api_version": { "description": "Current API version", "type": "string", "example": "1.0" }, "app_version": { "description": "Application version", "type": "string", "example": "2.1.3" }, "build_date": { "description": "Build date", "type": "string", "example": "2024-01-15", "nullable": true }, "build_commit": { "description": "Git commit hash", "type": "string", "example": "abc123def", "nullable": true }, "supported_versions": { "description": "List of supported API versions", "type": "array", "items": { "type": "string" }, "example": [ "1.0", "1.1" ] }, "deprecated_versions": { "description": "List of deprecated API versions", "type": "array", "items": { "type": "string" }, "example": [ "0.9" ] }, "changelog_url": { "description": "URL to changelog", "type": "string", "example": "https://api.example.com/changelog", "nullable": true } }, "type": "object" } } } }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "Card": { "title": "Trading Card", "description": "A trading card resource following JSON:API specification", "properties": { "type": { "description": "Resource type", "type": "string", "example": "cards" }, "id": { "description": "Unique identifier", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "attributes": { "properties": { "name": { "description": "Auto-generated card name", "type": "string", "example": "Michael Jordan" }, "number": { "description": "Card number within the set", "type": "string", "example": "23" }, "serial_number": { "description": "Serial number for limited cards", "type": "string", "example": "001/100", "nullable": true }, "image_uuid": { "description": "UUID reference for card image", "type": "string", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000", "nullable": true }, "title": { "description": "Special title or designation", "type": "string", "example": "Rookie Card", "nullable": true }, "notes": { "description": "Additional notes about the card", "type": "string", "nullable": true }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time" }, "url": { "description": "API URL for this card resource", "type": "string", "format": "uri" } }, "type": "object" }, "relationships": { "properties": { "set": { "properties": { "data": { "properties": { "type": { "type": "string", "example": "sets" }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } }, "type": "object" }, "oncard": { "properties": { "data": { "type": "array", "items": { "properties": { "type": { "type": "string", "enum": [ "players", "teams", "playerteams" ] }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" }, "attributes": { "properties": { "data": { "type": "array", "items": { "properties": { "type": { "type": "string", "example": "attributes" }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" }, "images": { "properties": { "data": { "type": "array", "items": { "properties": { "type": { "type": "string", "example": "card_images" }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "Set": { "title": "Card Set", "description": "A trading card set resource", "properties": { "type": { "type": "string", "example": "sets" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "1989 Topps Baseball" }, "title": { "type": "string", "example": "Series 1", "nullable": true }, "description": { "type": "string", "nullable": true }, "card_count": { "type": "integer", "example": 792, "nullable": true }, "current_card_count": { "type": "integer", "example": 792 }, "is_parallel": { "type": "boolean", "example": false }, "is_insert": { "type": "boolean", "example": false }, "is_autograph": { "type": "boolean", "example": false }, "is_relic": { "type": "boolean", "example": false }, "is_variation": { "description": "Indicates a variation set with same card numbering but different visual treatment", "type": "boolean", "example": false }, "serial": { "type": "integer", "example": 250, "nullable": true }, "number_prefix": { "type": "string", "nullable": true }, "parent_set": { "type": "string", "format": "uuid", "nullable": true }, "genre_id": { "type": "string", "format": "uuid", "nullable": true }, "manufacturer_id": { "type": "string", "format": "uuid", "nullable": true }, "brand_id": { "type": "string", "format": "uuid", "nullable": true }, "year_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" }, "relationships": { "properties": { "sources": { "properties": { "data": { "type": "array", "items": { "properties": { "type": { "type": "string", "example": "set_sources" }, "id": { "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "Player": { "title": "Player", "description": "A player resource", "properties": { "type": { "type": "string", "example": "players" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Michael Jordan" }, "first_name": { "type": "string", "example": "Michael" }, "last_name": { "type": "string", "example": "Jordan" }, "position": { "type": "string", "example": "Shooting Guard", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "Team": { "title": "Team", "description": "A team resource", "properties": { "type": { "type": "string", "example": "teams" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Chicago Bulls" }, "city": { "type": "string", "example": "Chicago", "nullable": true }, "abbreviation": { "type": "string", "example": "CHI", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "PaginationLinks": { "title": "Pagination Links", "description": "JSON:API pagination links", "properties": { "first": { "type": "string", "format": "uri", "nullable": true }, "last": { "type": "string", "format": "uri", "nullable": true }, "prev": { "type": "string", "format": "uri", "nullable": true }, "next": { "type": "string", "format": "uri", "nullable": true } }, "type": "object" }, "PaginationMeta": { "title": "Pagination Meta", "description": "JSON:API pagination metadata", "properties": { "current_page": { "type": "integer", "example": 1 }, "from": { "type": "integer", "example": 1 }, "to": { "type": "integer", "example": 25 }, "per_page": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 100 }, "last_page": { "type": "integer", "example": 4 } }, "type": "object" }, "ErrorResponse": { "title": "Error Response", "description": "JSON:API error response format", "properties": { "errors": { "type": "array", "items": { "properties": { "id": { "description": "Unique error identifier", "type": "string" }, "status": { "description": "HTTP status code", "type": "string" }, "code": { "description": "Application-specific error code", "type": "string" }, "title": { "description": "Short error summary", "type": "string" }, "detail": { "description": "Detailed error description", "type": "string" }, "source": { "properties": { "pointer": { "description": "JSON pointer to error source", "type": "string" }, "parameter": { "description": "Parameter causing the error", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "Attribute": { "title": "Attribute", "description": "An attribute definition resource", "properties": { "type": { "type": "string", "example": "attributes" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "attribute": { "type": "string", "example": "Autograph" }, "name": { "type": "string", "example": "Autograph" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "Brand": { "title": "Brand", "description": "A brand resource", "properties": { "type": { "type": "string", "example": "brands" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Topps" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "Manufacturer": { "title": "Manufacturer", "description": "A manufacturer resource", "properties": { "type": { "type": "string", "example": "manufacturers" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Topps Company" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "Year": { "title": "Year", "description": "A year resource", "properties": { "type": { "type": "string", "example": "years" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "year": { "type": "string", "example": "1989" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "Genre": { "title": "Genre", "description": "A genre resource", "properties": { "type": { "type": "string", "example": "genres" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Baseball" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "ObjectAttribute": { "title": "Object Attribute", "description": "An object attribute instance resource linking an attribute to a specific object", "properties": { "type": { "type": "string", "example": "object-attributes" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "attribute_id": { "type": "string", "format": "uuid" }, "attribute_value": { "type": "string", "example": "Authenticated" }, "object_type": { "type": "string", "example": "App\\Models\\Card" }, "object_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "PlayerTeam": { "title": "Player Team", "description": "A player-team relationship resource", "properties": { "type": { "type": "string", "example": "playerteams" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "name": { "type": "string", "example": "Michael Jordan - Chicago Bulls" }, "player_id": { "type": "string", "format": "uuid" }, "team_id": { "type": "string", "format": "uuid" }, "start_year": { "type": "string", "example": "1984", "nullable": true }, "end_year": { "type": "string", "example": "1998", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" }, "SetSource": { "title": "Set Source", "description": "A set source tracking resource", "properties": { "type": { "type": "string", "example": "set_sources" }, "id": { "type": "string", "format": "uuid" }, "attributes": { "properties": { "source_url": { "type": "string", "format": "url", "example": "https://example.com/checklist" }, "source_name": { "type": "string", "example": "CardboardConnection", "nullable": true }, "source_type": { "type": "string", "enum": [ "checklist", "metadata", "images" ], "example": "checklist" }, "verified_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" } }, "type": "object" } }, "type": "object" } }, "securitySchemes": { "bearer": { "type": "http", "description": "Bearer token authentication. Obtain tokens via Personal Access Token generation (simple - see API-KEY-GUIDE.md) or OAuth 2.0 client credentials flow (see oauth.md). Supports scopes: read:published, read:draft, read:all-status, write, delete.", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "Attributes v1", "description": "Attributes v1" }, { "name": "Brands v1", "description": "Brands v1" }, { "name": "Cards v1", "description": "Cards v1" }, { "name": "Card Images", "description": "Card Images" }, { "name": "Genres v1", "description": "Genres v1" }, { "name": "Internal", "description": "Internal" }, { "name": "Manufacturers v1", "description": "Manufacturers v1" }, { "name": "ObjectAttributes v1", "description": "ObjectAttributes v1" }, { "name": "Players v1", "description": "Players v1" }, { "name": "PlayerTeams v1", "description": "PlayerTeams v1" }, { "name": "Sets v1", "description": "Sets v1" }, { "name": "Set Sources v1", "description": "Set Sources v1" }, { "name": "Statistics v1", "description": "Statistics v1" }, { "name": "Teams v1", "description": "Teams v1" }, { "name": "Years v1", "description": "Years v1" }, { "name": "Sets v2", "description": "Sets v2" }, { "name": "Version", "description": "Version" } ] }