{ "openapi": "3.1.0", "info": { "title": "Itefy API", "version": "1.0.0", "description": "Unified REST API for Itefy equipment management.\n\nAuthenticate external integrations with an API key: `Authorization: Bearer itf_live__`. Keys are issued per account from the portal (Business and Enterprise plans). Itefy's own web and mobile apps authenticate first-party via session/token and are not plan-gated.\n\nResponses use a `{ \"data\": ..., \"meta\": {...} }` envelope; errors use `{ \"error\": { code, message, status, request_id, fields } }` with a stable machine-readable `code`." }, "servers": [ { "url": "/", "description": "Current host" }, { "url": "https://api.itefy.com", "description": "Production" } ], "tags": [ { "name": "items", "description": "Equipment items." }, { "name": "locations", "description": "Storage / usage locations." }, { "name": "contacts", "description": "People and companies (customers, suppliers, relations)." }, { "name": "users", "description": "Account members (read-only)." }, { "name": "reservations", "description": "Bookings of items for a future period." }, { "name": "checkouts", "description": "Items checked out for use, and their check-in." }, { "name": "issues", "description": "Reported problems / maintenance tasks on items." }, { "name": "meta", "description": "Service metadata and identity." } ], "paths": { "/v1/ping": { "get": { "tags": [ "meta" ], "operationId": "get_v1_ping", "summary": "Health check", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "security": [] } }, "/v1/whoami": { "get": { "tags": [ "meta" ], "operationId": "get_v1_whoami", "summary": "Identity of the authenticated caller", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/auth/login": { "post": { "tags": [ "meta" ], "operationId": "post_v1_auth_login", "summary": "Create a auth", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "security": [] } }, "/v1/auth/refresh": { "post": { "tags": [ "meta" ], "operationId": "post_v1_auth_refresh", "summary": "Create a auth", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "security": [] } }, "/v1/auth/logout": { "post": { "tags": [ "meta" ], "operationId": "post_v1_auth_logout", "summary": "Create a auth", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "security": [] } }, "/v1/accounts": { "get": { "tags": [ "meta" ], "operationId": "get_v1_accounts", "summary": "List accounts", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/session": { "get": { "tags": [ "meta" ], "operationId": "get_v1_session", "summary": "List session", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/items": { "get": { "tags": [ "items" ], "operationId": "get_v1_items", "summary": "List items", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "tags": [ "items" ], "operationId": "post_v1_items", "summary": "Create a item", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemInput" } } } } } }, "/v1/items/lookup": { "get": { "tags": [ "items" ], "operationId": "get_v1_items_lookup", "summary": "List items", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "display", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/items/{id}": { "get": { "tags": [ "items" ], "operationId": "get_v1_items_id", "summary": "Get a item", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "patch": { "tags": [ "items" ], "operationId": "patch_v1_items_id", "summary": "Update a item", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemInput" } } } } }, "delete": { "tags": [ "items" ], "operationId": "delete_v1_items_id", "summary": "Delete a item", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/items/{id}/condition": { "post": { "tags": [ "items" ], "operationId": "post_v1_items_id_condition", "summary": "Create a item", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemInput" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/items/{id}/location": { "post": { "tags": [ "items" ], "operationId": "post_v1_items_id_location", "summary": "Create a item", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemInput" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/items/{id}/inventory": { "post": { "tags": [ "items" ], "operationId": "post_v1_items_id_inventory", "summary": "Create a item", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemInput" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/items/{id}/pictures": { "get": { "tags": [ "items" ], "operationId": "get_v1_items_id_pictures", "summary": "Get a item", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/items/{id}/files": { "post": { "tags": [ "items" ], "operationId": "post_v1_items_id_files", "summary": "Create a item", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemInput" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/locations": { "get": { "tags": [ "locations" ], "operationId": "get_v1_locations", "summary": "List locations", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "tags": [ "locations" ], "operationId": "post_v1_locations", "summary": "Create a location", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationInput" } } } } } }, "/v1/locations/{id}": { "get": { "tags": [ "locations" ], "operationId": "get_v1_locations_id", "summary": "Get a location", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "patch": { "tags": [ "locations" ], "operationId": "patch_v1_locations_id", "summary": "Update a location", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationInput" } } } } }, "delete": { "tags": [ "locations" ], "operationId": "delete_v1_locations_id", "summary": "Delete a location", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/contacts": { "get": { "tags": [ "contacts" ], "operationId": "get_v1_contacts", "summary": "List contacts", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "tags": [ "contacts" ], "operationId": "post_v1_contacts", "summary": "Create a contact", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInput" } } } } } }, "/v1/contacts/{id}": { "get": { "tags": [ "contacts" ], "operationId": "get_v1_contacts_id", "summary": "Get a contact", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "patch": { "tags": [ "contacts" ], "operationId": "patch_v1_contacts_id", "summary": "Update a contact", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInput" } } } } }, "delete": { "tags": [ "contacts" ], "operationId": "delete_v1_contacts_id", "summary": "Delete a contact", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/directory/users": { "get": { "tags": [ "meta" ], "operationId": "get_v1_directory_users", "summary": "List directory", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/users": { "get": { "tags": [ "users" ], "operationId": "get_v1_users", "summary": "List users", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/users/{id}": { "get": { "tags": [ "users" ], "operationId": "get_v1_users_id", "summary": "Get a user", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/reservations": { "get": { "tags": [ "reservations" ], "operationId": "get_v1_reservations", "summary": "List reservations", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "classification", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "tags": [ "reservations" ], "operationId": "post_v1_reservations", "summary": "Create a reservation", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationInput" } } } } } }, "/v1/reservations/{id}": { "get": { "tags": [ "reservations" ], "operationId": "get_v1_reservations_id", "summary": "Get a reservation", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "patch": { "tags": [ "reservations" ], "operationId": "patch_v1_reservations_id", "summary": "Update a reservation", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationInput" } } } } }, "delete": { "tags": [ "reservations" ], "operationId": "delete_v1_reservations_id", "summary": "Delete a reservation", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/reservations/{id}/complete": { "post": { "tags": [ "reservations" ], "operationId": "post_v1_reservations_id_complete", "summary": "Create a reservation", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationInput" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/checkouts": { "get": { "tags": [ "checkouts" ], "operationId": "get_v1_checkouts", "summary": "List checkouts", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "tags": [ "checkouts" ], "operationId": "post_v1_checkouts", "summary": "Check items out", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutInput" } } } } } }, "/v1/checkouts/{id}": { "get": { "tags": [ "checkouts" ], "operationId": "get_v1_checkouts_id", "summary": "Get a checkout", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/checkouts/{id}/checkin": { "post": { "tags": [ "checkouts" ], "operationId": "post_v1_checkouts_id_checkin", "summary": "Check items back in", "responses": { "200": { "description": "Updated checkout.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckinInput" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/events": { "get": { "tags": [ "meta" ], "operationId": "get_v1_events", "summary": "List events", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "post": { "tags": [ "meta" ], "operationId": "post_v1_events", "summary": "Create a events", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventInput" } } } } } }, "/v1/events/{id}": { "get": { "tags": [ "meta" ], "operationId": "get_v1_events_id", "summary": "Get a events", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "delete": { "tags": [ "meta" ], "operationId": "delete_v1_events_id", "summary": "Delete a events", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/comments": { "get": { "tags": [ "meta" ], "operationId": "get_v1_comments", "summary": "List comments", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "post": { "tags": [ "meta" ], "operationId": "post_v1_comments", "summary": "Create a comments", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/comments/{id}": { "delete": { "tags": [ "meta" ], "operationId": "delete_v1_comments_id", "summary": "Delete a comments", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/push/vapid-public-key": { "get": { "tags": [ "meta" ], "operationId": "get_v1_push_vapid_public_key", "summary": "List push", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/push/subscribe": { "post": { "tags": [ "meta" ], "operationId": "post_v1_push_subscribe", "summary": "Create a push", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "delete": { "tags": [ "meta" ], "operationId": "delete_v1_push_subscribe", "summary": "Delete a push", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/push/test": { "post": { "tags": [ "meta" ], "operationId": "post_v1_push_test", "summary": "Create a push", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/notifications": { "get": { "tags": [ "meta" ], "operationId": "get_v1_notifications", "summary": "List notifications", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/notifications/status": { "get": { "tags": [ "meta" ], "operationId": "get_v1_notifications_status", "summary": "List notifications", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/notifications/read-all": { "post": { "tags": [ "meta" ], "operationId": "post_v1_notifications_read_all", "summary": "Create a notifications", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/notifications/{id}/read": { "post": { "tags": [ "meta" ], "operationId": "post_v1_notifications_id_read", "summary": "Create a notifications", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/notifications/{id}": { "delete": { "tags": [ "meta" ], "operationId": "delete_v1_notifications_id", "summary": "Delete a notifications", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] }, "/v1/issues": { "get": { "tags": [ "issues" ], "operationId": "get_v1_issues", "summary": "List issues", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "$ref": "#/components/schemas/MetaPaginated" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max items to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Number of items to skip." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string" } } ] }, "post": { "tags": [ "issues" ], "operationId": "post_v1_issues", "summary": "Create a issue", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueInput" } } } } } }, "/v1/issues/{id}": { "get": { "tags": [ "issues" ], "operationId": "get_v1_issues_id", "summary": "Get a issue", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "patch": { "tags": [ "issues" ], "operationId": "patch_v1_issues_id", "summary": "Update a issue", "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueInput" } } } } }, "delete": { "tags": [ "issues" ], "operationId": "delete_v1_issues_id", "summary": "Delete a issue", "responses": { "204": { "description": "Deleted; no content." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } } } }, "/v1/issues/{id}/status": { "post": { "tags": [ "issues" ], "operationId": "post_v1_issues_id_status", "summary": "Create a issue", "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueInput" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ] } }, "components": { "securitySchemes": { "bearerApiKey": { "type": "http", "scheme": "bearer", "description": "API key as a bearer token: itf_live__." } }, "responses": { "BadRequest": { "description": "Malformed request (e.g. invalid JSON).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Missing or invalid credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Authenticated but not permitted, or plan lacks API access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ValidationFailed": { "description": "One or more fields are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "RateLimited": { "description": "Rate limit exceeded; see Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "validation_failed" }, "message": { "type": "string" }, "status": { "type": "integer", "example": 422 }, "request_id": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } } }, "required": [ "code", "message", "status" ] } } }, "Meta": { "type": "object", "properties": { "request_id": { "type": "string" } } }, "MetaPaginated": { "type": "object", "properties": { "request_id": { "type": "string" }, "pagination": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "next_offset": { "type": [ "integer", "null" ] } } } } }, "ItemInput": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 3 }, "unique_id": { "type": "string" }, "type_id": { "type": "integer" }, "location_id": { "type": "integer" }, "ppr_id": { "type": "integer" }, "condition": { "type": "string", "enum": [ "operative", "inoperative", "discarded" ] }, "acquisition_date": { "type": "string", "format": "date" }, "deprecation_date": { "type": "string", "format": "date" }, "acquisition_value": { "type": "number" }, "salvage_value": { "type": "number" }, "inventory_threshold": { "type": "integer" }, "description": { "type": "string" } } }, "LocationInput": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "ContactInput": { "type": "object", "required": [ "ctype", "country_code_alpha2" ], "properties": { "ctype": { "type": "string", "enum": [ "company", "individual" ] }, "country_code_alpha2": { "type": "string", "minLength": 2, "maxLength": 2 }, "name": { "type": "string", "description": "Required when ctype=company." }, "firstname": { "type": "string", "description": "Required when ctype=individual." }, "lastname": { "type": "string", "description": "Required when ctype=individual." }, "is_customer": { "type": "boolean" }, "is_supplier": { "type": "boolean" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "website": { "type": "string" }, "comments": { "type": "string" } } }, "ReservationInput": { "type": "object", "required": [ "name", "start", "end", "iid" ], "properties": { "name": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "iid": { "type": "array", "items": { "type": "integer" }, "minItems": 1 }, "location": { "type": "integer" }, "obo": { "type": "integer", "description": "On-behalf-of user id." }, "description": { "type": "string" }, "classification": { "type": "string", "enum": [ "usage", "maintenance", "inspection", "transport", "repair", "other" ], "description": "Kind of reservation; defaults to \"usage\"." }, "issue_id": { "type": "integer", "description": "Issue this reservation was scheduled from (create only)." }, "repetition": { "type": "string", "enum": [ "none", "daily", "weekly", "monthly", "yearly" ] }, "repeat_end": { "type": "string", "enum": [ "no_repeat_end", "date_repeat_end", "times_repeat_end" ] } } }, "EventInput": { "type": "object", "required": [ "name", "iid", "time_start", "time_end" ], "properties": { "name": { "type": "string" }, "iid": { "type": "array", "items": { "type": "integer" }, "minItems": 1 }, "time_start": { "type": "string", "format": "date-time" }, "time_end": { "type": "string", "format": "date-time" }, "obo": { "type": "integer", "description": "On-behalf-of user id." }, "location": { "type": "integer" }, "description": { "type": "string" }, "classification": { "type": "string", "enum": [ "maintenance", "inspection", "transport", "repair", "other" ], "description": "Kind of event; defaults to \"maintenance\", or inherits from the linked reservation." }, "reservation_id": { "type": "integer", "description": "Reservation occurrence this event completes." } } }, "CheckoutInput": { "type": "object", "required": [ "name", "iid", "due_time" ], "properties": { "name": { "type": "string" }, "iid": { "type": "array", "items": { "type": "integer" }, "minItems": 1 }, "due_time": { "type": "string", "format": "date-time", "description": "Must be >= 5 minutes from now." }, "obo": { "type": "integer" }, "location": { "type": "integer" }, "description": { "type": "string" }, "reservation_id": { "type": "integer" } } }, "CheckinInput": { "type": "object", "properties": { "iid": { "type": "array", "items": { "type": "integer" }, "description": "Items to check in. Omit to check in all items still out." }, "remarks": { "type": "string" } } }, "IssueInput": { "type": "object", "required": [ "name", "deadline", "iid" ], "properties": { "name": { "type": "string" }, "deadline": { "type": "string", "format": "date-time" }, "iid": { "type": "array", "items": { "type": "integer" }, "minItems": 1 }, "ppr": { "type": "integer", "description": "Primary person responsible (user id)." }, "location": { "type": "integer" }, "description": { "type": "string" }, "uid": { "type": "array", "items": { "type": "integer" }, "description": "Participant user ids." }, "autochange_condition": { "type": "boolean" } } } } }, "security": [ { "bearerApiKey": [] } ] }