{ "openapi": "3.2.0", "info": { "title": "Simple API Mode", "description": "A simple API, no auth protection so you can add and delete what you want in a multi-user mode.", "version": "1.0.0" }, "servers": [ { "url": "https://apichallenges.com", "description": "cloud hosted version" }, { "url": "http://localhost:4567", "description": "local execution" } ], "paths": { "/simpleapi/items": { "get": { "summary": "return all the instances of item", "description": "return all the instances of item", "parameters": [ { "name": "_sortBy", "in": "query", "description": "Sort collection results by a field. Use +field or field for ascending order, and -field for descending order. Multiple fields can be combined with commas, e.g. +field,-other.", "required": false, "schema": { "type": "string" }, "example": "+id" } ], "responses": { "200": { "description": "All the items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items" } }, "application/xml": { "schema": { "type": "array", "description": "items", "items": { "type": "object", "description": "item", "properties": { "id": { "type": "integer", "format": "int32", "description": "Field is an ID and should not be amended or set.", "example": 31 }, "type": { "type": "string", "description": "Value must be an Enum (cd, dvd, book, blu-ray) value. Value is mandatory.", "example": "cd" }, "isbn13": { "type": "string", "description": "Value is mandatory. Value must match the regex [0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}. Maximum length allowed is 17.", "example": "123-4-56-789012-3" }, "price": { "type": "number", "description": "Value must be a Float of min 0.000000 and max 50000.000000. Value is mandatory.", "example": 97.99 }, "numberinstock": { "type": "integer", "format": "int32", "description": "Value must be an Integer of min 0 and max 100.", "example": 0 } }, "required": [ "id", "isbn13", "numberinstock", "price", "type" ], "title": "item", "xml": { "name": "item", "wrapped": true } }, "title": "items", "xml": { "name": "items", "wrapped": true } } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "array", "description": "items", "items": { "type": "object", "description": "item", "properties": { "id": { "type": "integer", "format": "int32", "description": "Field is an ID and should not be amended or set.", "example": 31 }, "type": { "type": "string", "description": "Value must be an Enum (cd, dvd, book, blu-ray) value. Value is mandatory.", "example": "cd" }, "isbn13": { "type": "string", "description": "Value is mandatory. Value must match the regex [0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}. Maximum length allowed is 17.", "example": "123-4-56-789012-3" }, "price": { "type": "number", "description": "Value must be a Float of min 0.000000 and max 50000.000000. Value is mandatory.", "example": 97.99 }, "numberinstock": { "type": "integer", "format": "int32", "description": "Value must be an Integer of min 0 and max 100.", "example": 0 } }, "required": [ "id", "isbn13", "numberinstock", "price", "type" ], "title": "item", "xml": { "name": "item", "wrapped": true } }, "title": "items", "xml": { "name": "items", "wrapped": true } } } } } } }, "post": { "summary": "we should be able to create item without a ID using the field values in the body of the message. A maximum of 100 items is allowed.", "description": "we should be able to create item without a ID using the field values in the body of the message. A maximum of 100 items is allowed.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/create_item" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/create_item" } } }, "required": true }, "responses": { "201": { "description": "Created a item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } } }, "400": { "description": "Error when creating a item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "422": { "description": "Validation error when creating a item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "409": { "description": "Conflict when creating a item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "415": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } } } }, "options": { "summary": "show all Options for endpoint of /simpleapi/items", "description": "show all Options for endpoint of /simpleapi/items", "responses": { "200": { "description": "the endpoint verb options" } } }, "head": { "summary": "headers for all the instances of item", "description": "headers for all the instances of item", "responses": { "200": { "description": "OK" } } }, "query": { "summary": "query all the instances of item using application/x-www-form-urlencoded, application/jsonpath, application/vnd.thingifier.query+json query content", "description": "query all the instances of item using application/x-www-form-urlencoded, application/jsonpath, application/vnd.thingifier.query+json query content", "parameters": [ { "name": "_sortBy", "in": "query", "description": "Sort collection results by a field. Use +field or field for ascending order, and -field for descending order. Multiple fields can be combined with commas, e.g. +field,-other.", "required": false, "schema": { "type": "string" }, "example": "+id" } ], "responses": { "200": { "description": "All the matching items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items" } }, "application/xml": { "schema": { "type": "array", "description": "items", "items": { "type": "object", "description": "item", "properties": { "id": { "type": "integer", "format": "int32", "description": "Field is an ID and should not be amended or set.", "example": 52 }, "type": { "type": "string", "description": "Value must be an Enum (cd, dvd, book, blu-ray) value. Value is mandatory.", "example": "cd" }, "isbn13": { "type": "string", "description": "Value is mandatory. Value must match the regex [0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}. Maximum length allowed is 17.", "example": "123-4-56-789012-3" }, "price": { "type": "number", "description": "Value must be a Float of min 0.000000 and max 50000.000000. Value is mandatory.", "example": 97.99 }, "numberinstock": { "type": "integer", "format": "int32", "description": "Value must be an Integer of min 0 and max 100.", "example": 0 } }, "required": [ "id", "isbn13", "numberinstock", "price", "type" ], "title": "item", "xml": { "name": "item", "wrapped": true } }, "title": "items", "xml": { "name": "items", "wrapped": true } } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "array", "description": "items", "items": { "type": "object", "description": "item", "properties": { "id": { "type": "integer", "format": "int32", "description": "Field is an ID and should not be amended or set.", "example": 52 }, "type": { "type": "string", "description": "Value must be an Enum (cd, dvd, book, blu-ray) value. Value is mandatory.", "example": "cd" }, "isbn13": { "type": "string", "description": "Value is mandatory. Value must match the regex [0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}. Maximum length allowed is 17.", "example": "123-4-56-789012-3" }, "price": { "type": "number", "description": "Value must be a Float of min 0.000000 and max 50000.000000. Value is mandatory.", "example": 97.99 }, "numberinstock": { "type": "integer", "format": "int32", "description": "Value must be an Integer of min 0 and max 100.", "example": 0 } }, "required": [ "id", "isbn13", "numberinstock", "price", "type" ], "title": "item", "xml": { "name": "item", "wrapped": true } }, "title": "items", "xml": { "name": "items", "wrapped": true } } } } }, "400": { "description": "Error processing request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "413": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "415": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "422": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } } }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, "application/jsonpath": { "schema": { "type": "string" } }, "application/vnd.thingifier.query+json": { "schema": { "type": "object", "properties": { "filter": { "type": "object" }, "sort": { "type": "array", "items": { "type": "object" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 } } } } } } } }, "/simpleapi/items/{id}": { "get": { "summary": "return a specific instances of item using a id", "description": "return a specific instances of item using a id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 87 } ], "responses": { "200": { "description": "A specific item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } } }, "404": { "description": "Could not find a specific item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } } } }, "put": { "summary": "amend a specific instances of item using a id with a body containing the fields to amend", "description": "amend a specific instances of item using a id with a body containing the fields to amend", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 5 } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } }, "required": true }, "responses": { "400": { "description": "Error processing request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "201": { "description": "OK, Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "415": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "422": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "409": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } } } }, "post": { "summary": "amend a specific instances of item using a id with a body containing the fields to amend", "description": "amend a specific instances of item using a id with a body containing the fields to amend", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 26 } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } }, "required": true }, "responses": { "200": { "description": "Amended the specific item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } } }, "404": { "description": "Could not find a specific item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "422": { "description": "Validation error when amending a item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "409": { "description": "Conflict when amending a item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "400": { "description": "Error processing request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "415": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } } } }, "delete": { "summary": "delete a specific instances of item using a id", "description": "delete a specific instances of item using a id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 17 } ], "responses": { "204": { "description": "Deleted a specific item" }, "404": { "description": "Could not find a specific item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } } } }, "options": { "summary": "show all Options for endpoint of /simpleapi/items/:id", "description": "show all Options for endpoint of /simpleapi/items/:id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 70 } ], "responses": { "200": { "description": "OK", "headers": { "Accept-Patch": { "description": "application/json, application/merge-patch+json, application/json-patch+json", "schema": { "type": "string" } } } } } }, "head": { "summary": "headers for a specific instances of item using a id", "description": "headers for a specific instances of item using a id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 25 } ], "responses": { "200": { "description": "Headers for a specific item" }, "404": { "description": "Could not find a specific item" } } }, "patch": { "summary": "patch a specific instance of item with a body containing the patch details", "description": "patch a specific instance of item with a body containing the patch details", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 77 } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/item" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/item" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/item" } } } }, "400": { "description": "Error processing request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "415": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "422": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } }, "409": { "description": "Standard Status Code Meaning", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } }, "text/csv": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } }, "text/html": { "schema": { "type": "string" } }, "application/x-ndjson": { "schema": { "type": "string" } }, "application/jsonl": { "schema": { "type": "string" } }, "application/json-seq": { "schema": { "type": "string" } }, "text/tab-separated-values": { "schema": { "type": "string" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ThingifierError" } } } } } } }, "/simpleapi/randomisbn": { "get": { "summary": "return a random ISBN that can be used for testing purposes with the Simple API.", "description": "return a random ISBN that can be used for testing purposes with the Simple API.", "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "item": { "type": "object", "description": "item", "properties": { "id": { "type": "integer", "format": "int32", "description": "Field is an ID and should not be amended or set.", "example": 58 }, "type": { "type": "string", "description": "Value must be an Enum (cd, dvd, book, blu-ray) value. Value is mandatory.", "example": "cd" }, "isbn13": { "type": "string", "description": "Value is mandatory. Value must match the regex [0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}. Maximum length allowed is 17.", "example": "123-4-56-789012-3", "maxLength": 17, "pattern": "[0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}" }, "price": { "type": "number", "description": "Value must be a Float of min 0.000000 and max 50000.000000. Value is mandatory.", "example": 97.99, "maximum": 50000.0, "minimum": 0.0 }, "numberinstock": { "type": "integer", "format": "int32", "description": "Value must be an Integer of min 0 and max 100.", "example": 0, "maximum": 100, "minimum": 0 } }, "title": "item", "xml": { "name": "item", "wrapped": true } }, "create_item": { "type": "object", "description": "item", "properties": { "type": { "type": "string", "description": "Value must be an Enum (cd, dvd, book, blu-ray) value. Value is mandatory.", "example": "cd" }, "isbn13": { "type": "string", "description": "Value is mandatory. Value must match the regex [0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}. Maximum length allowed is 17.", "example": "123-4-56-789012-3", "maxLength": 17, "pattern": "[0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}" }, "price": { "type": "number", "description": "Value must be a Float of min 0.000000 and max 50000.000000. Value is mandatory.", "example": 97.99, "maximum": 50000.0, "minimum": 0.0 }, "numberinstock": { "type": "integer", "format": "int32", "description": "Value must be an Integer of min 0 and max 100.", "example": 0, "maximum": 100, "minimum": 0 } }, "required": [ "isbn13", "price", "type" ], "title": "create item", "xml": { "name": "item", "wrapped": true } }, "items": { "type": "object", "description": "items", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "item", "properties": { "id": { "type": "integer", "format": "int32", "description": "Field is an ID and should not be amended or set.", "example": 98 }, "type": { "type": "string", "description": "Value must be an Enum (cd, dvd, book, blu-ray) value. Value is mandatory.", "example": "cd" }, "isbn13": { "type": "string", "description": "Value is mandatory. Value must match the regex [0-9]{3}[-]?[0-9]{1}[-]?[0-9]{2}[-]?[0-9]{6}[-]?[0-9]{1}. Maximum length allowed is 17.", "example": "123-4-56-789012-3" }, "price": { "type": "number", "description": "Value must be a Float of min 0.000000 and max 50000.000000. Value is mandatory.", "example": 97.99 }, "numberinstock": { "type": "integer", "format": "int32", "description": "Value must be an Integer of min 0 and max 100.", "example": 0 } }, "required": [ "id", "isbn13", "numberinstock", "price", "type" ], "title": "item", "xml": { "name": "item", "wrapped": true } } } }, "required": [ "items" ], "title": "items" }, "ThingifierError": { "type": "object", "description": "Standard Thingifier error response", "properties": { "errorMessages": { "type": "array", "items": { "type": "string" } } }, "required": [ "errorMessages" ], "title": "ThingifierError" } } } }