{
"openapi": "3.1.2",
"info": {
"title": "Inventory",
"version": "0.0.1"
},
"servers": [
{
"url": "http://localhost/api"
}
],
"security": [
{
"oauth2": []
}
],
"paths": {
"/user": {
"get": {
"responses": {
"200": {
"description": "`User`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/author/{author}": {
"get": {
"operationId": "author.show",
"summary": "Display the specified resource",
"tags": [
"Author"
],
"parameters": [
{
"name": "author",
"in": "path",
"required": true,
"description": "The author ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `translations`.",
"schema": {
"type": "string",
"examples": [
"translations"
]
}
}
],
"responses": {
"200": {
"description": "`AuthorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "author.update",
"summary": "Update the specified resource in storage",
"tags": [
"Author"
],
"parameters": [
{
"name": "author",
"in": "path",
"required": true,
"description": "The author ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAuthorRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AuthorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "author.update_187",
"summary": "Update the specified resource in storage",
"tags": [
"Author"
],
"parameters": [
{
"name": "author",
"in": "path",
"required": true,
"description": "The author ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAuthorRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AuthorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "author.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Author"
],
"parameters": [
{
"name": "author",
"in": "path",
"required": true,
"description": "The author ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/author": {
"get": {
"operationId": "author.index",
"summary": "Display a listing of the resource",
"tags": [
"Author"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `translations`.",
"schema": {
"type": "string",
"examples": [
"translations"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `AuthorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "author.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Author"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreAuthorRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AuthorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/author-translation/{authorTranslation}": {
"get": {
"operationId": "author-translation.show",
"summary": "Display the specified resource",
"tags": [
"AuthorTranslation"
],
"parameters": [
{
"name": "authorTranslation",
"in": "path",
"required": true,
"description": "The author translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `author`, `language`, `context`.",
"schema": {
"type": "string",
"examples": [
"author,language,context"
]
}
}
],
"responses": {
"200": {
"description": "`AuthorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "author-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"AuthorTranslation"
],
"parameters": [
{
"name": "authorTranslation",
"in": "path",
"required": true,
"description": "The author translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAuthorTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AuthorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "authorTranslation.update_189",
"summary": "Update the specified resource in storage",
"tags": [
"AuthorTranslation"
],
"parameters": [
{
"name": "authorTranslation",
"in": "path",
"required": true,
"description": "The author translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAuthorTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AuthorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "author-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"AuthorTranslation"
],
"parameters": [
{
"name": "authorTranslation",
"in": "path",
"required": true,
"description": "The author translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/author-translation": {
"get": {
"operationId": "author-translation.index",
"summary": "Display a listing of the resource",
"tags": [
"AuthorTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `author`, `language`, `context`.",
"schema": {
"type": "string",
"examples": [
"author,language,context"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `AuthorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorTranslationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "author-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"AuthorTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreAuthorTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AuthorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AuthorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/available-image/{availableImage}/download": {
"get": {
"operationId": "available-image.download",
"summary": "Download the file to the caller",
"tags": [
"AvailableImage"
],
"parameters": [
{
"name": "availableImage",
"in": "path",
"required": true,
"description": "The available image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/available-image/{availableImage}/view": {
"get": {
"operationId": "available-image.view",
"summary": "Returns the image file for direct viewing (e.g., for use in ![]()
src attribute)",
"tags": [
"AvailableImage"
],
"parameters": [
{
"name": "availableImage",
"in": "path",
"required": true,
"description": "The available image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/available-image/{availableImage}": {
"get": {
"operationId": "available-image.show",
"summary": "Display the specified resource",
"tags": [
"AvailableImage"
],
"parameters": [
{
"name": "availableImage",
"in": "path",
"required": true,
"description": "The available image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`AvailableImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AvailableImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"delete": {
"operationId": "available-image.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"AvailableImage"
],
"parameters": [
{
"name": "availableImage",
"in": "path",
"required": true,
"description": "The available image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "available-image.update",
"summary": "Update the specified resource in storage",
"tags": [
"AvailableImage"
],
"parameters": [
{
"name": "availableImage",
"in": "path",
"required": true,
"description": "The available image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAvailableImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AvailableImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AvailableImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "availableImage.update_304",
"summary": "Update the specified resource in storage",
"tags": [
"AvailableImage"
],
"parameters": [
{
"name": "availableImage",
"in": "path",
"required": true,
"description": "The available image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAvailableImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AvailableImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AvailableImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/available-image": {
"get": {
"operationId": "available-image.index",
"summary": "Display a listing of the resource",
"tags": [
"AvailableImage"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "No related resources available for inclusion on this endpoint.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `AvailableImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableImageResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection/type/{type}": {
"get": {
"operationId": "collection.byType",
"summary": "Get collections by type",
"tags": [
"Collection"
],
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"collection",
"exhibition",
"gallery",
"theme",
"exhibition trail",
"itinerary",
"location",
"subtheme",
"region"
]
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `context`, `translations`, `partners`, `items`, `attachedItems`, `collectionImages`, `collectionMedia`, `contributors`.",
"schema": {
"type": "string",
"examples": [
"language,context,translations"
]
}
}
],
"responses": {
"200": {
"description": "Array of `CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection/{collection}": {
"get": {
"operationId": "collection.show",
"summary": "Display the specified collection",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `context`, `translations`, `partners`, `items`, `attachedItems`, `collectionImages`, `collectionMedia`, `contributors`.",
"schema": {
"type": "string",
"examples": [
"language,context,translations"
]
}
}
],
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "collection.update",
"summary": "Update the specified collection in storage",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "collection.update_262",
"summary": "Update the specified collection in storage",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "collection.destroy",
"summary": "Remove the specified collection from storage",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection": {
"get": {
"operationId": "collection.index",
"summary": "Display a listing of the collections",
"tags": [
"Collection"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `context`, `translations`, `partners`, `items`, `attachedItems`, `collectionImages`, `collectionMedia`, `contributors`.",
"schema": {
"type": "string",
"examples": [
"language,context,translations"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "collection.store",
"summary": "Store a newly created collection in storage",
"tags": [
"Collection"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCollectionRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection/{collection}/attach-item": {
"post": {
"operationId": "collection.attachItem",
"summary": "Attach an item to a collection via many-to-many relationship",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachItemCollectionRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection/{collection}/attach-items": {
"post": {
"operationId": "collection.attachItems",
"summary": "Attach multiple items to a collection",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachItemsCollectionRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection/{collection}/detach-item": {
"delete": {
"operationId": "collection.detachItem",
"summary": "Detach an item from a collection",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "item_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `context`, `translations`, `partners`, `items`, `attachedItems`, `collectionImages`, `collectionMedia`, `contributors`.",
"schema": {
"type": "string",
"examples": [
"language,context,translations"
]
}
}
],
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection/{collection}/detach-items": {
"delete": {
"operationId": "collection.detachItems",
"summary": "Detach multiple items from a collection",
"tags": [
"Collection"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "item_ids[]",
"in": "query",
"required": true,
"schema": {
"type": "array",
"format": "uuid",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `context`, `translations`, `partners`, `items`, `attachedItems`, `collectionImages`, `collectionMedia`, `contributors`.",
"schema": {
"type": "string",
"examples": [
"language,context,translations"
]
}
}
],
"responses": {
"200": {
"description": "`CollectionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection-translation/{collectionTranslation}": {
"get": {
"operationId": "collection-translation.show",
"summary": "Display the specified collection translation",
"tags": [
"Collection Translations",
"CollectionTranslation"
],
"parameters": [
{
"name": "collectionTranslation",
"in": "path",
"required": true,
"description": "The collection translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "No related resources available for inclusion on this endpoint.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`CollectionTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionTranslationResource"
},
{
"type": "object",
"required": [
"collection",
"language",
"context"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "collection-translation.update",
"summary": "Update the specified collection translation",
"tags": [
"Collection Translations",
"CollectionTranslation"
],
"parameters": [
{
"name": "collectionTranslation",
"in": "path",
"required": true,
"description": "The collection translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionTranslationResource"
},
{
"type": "object",
"required": [
"collection",
"language",
"context"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "collectionTranslation.update_260",
"summary": "Update the specified collection translation",
"tags": [
"Collection Translations",
"CollectionTranslation"
],
"parameters": [
{
"name": "collectionTranslation",
"in": "path",
"required": true,
"description": "The collection translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionTranslationResource"
},
{
"type": "object",
"required": [
"collection",
"language",
"context"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "collection-translation.destroy",
"summary": "Remove the specified collection translation",
"tags": [
"Collection Translations",
"CollectionTranslation"
],
"parameters": [
{
"name": "collectionTranslation",
"in": "path",
"required": true,
"description": "The collection translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-translation": {
"get": {
"operationId": "collection-translation.index",
"summary": "Display a listing of collection translations",
"tags": [
"Collection Translations",
"CollectionTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "collection_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "language_id",
"in": "query",
"schema": {
"type": "string",
"minLength": 3,
"maxLength": 3
}
},
{
"name": "context_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "default_context",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `CollectionTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionTranslationResource"
},
{
"type": "object",
"required": [
"collection",
"language",
"context"
]
}
]
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "collection-translation.store",
"summary": "Store a newly created collection translation",
"tags": [
"Collection Translations",
"CollectionTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCollectionTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CollectionTranslationResource"
},
{
"type": "object",
"required": [
"collection",
"language",
"context"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection/{collection}/images": {
"get": {
"operationId": "collection.images.index",
"summary": "Display a listing of collection images for a specific collection",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `collection`.",
"schema": {
"type": "string",
"examples": [
"collection"
]
}
}
],
"responses": {
"200": {
"description": "Array of `CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionImageResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "collection.images.store",
"summary": "Store a newly created collection image",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCollectionImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection-image/{collectionImage}/download": {
"get": {
"operationId": "collection-image.download",
"summary": "Returns the image, with its copyright burned in, as a download",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-image/{collectionImage}/view": {
"get": {
"operationId": "collection-image.view",
"summary": "Returns the image, with its copyright burned in, for direct viewing (e.g., for use in ![]()
src attribute): the bytes /pub serves",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-image/{collectionImage}": {
"get": {
"operationId": "collection-image.show",
"summary": "Display the specified collection image",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `collection`.",
"schema": {
"type": "string",
"examples": [
"collection"
]
}
}
],
"responses": {
"200": {
"description": "`CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "collection-image.update",
"summary": "Update the specified collection image",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "collectionImage.update_240",
"summary": "Update the specified collection image",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "collection-image.destroy",
"summary": "Remove the specified collection image",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection/{collection}/attach-image": {
"post": {
"operationId": "collection.attachImage",
"summary": "Attach an available image to a collection",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachFromAvailableCollectionImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection-image/{collectionImage}/move-up": {
"patch": {
"operationId": "collection-image.moveUp",
"summary": "Move collection image up in display order",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-image/{collectionImage}/move-down": {
"patch": {
"operationId": "collection-image.moveDown",
"summary": "Move collection image down in display order",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`CollectionImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-image/{collectionImage}/tighten-ordering": {
"patch": {
"operationId": "collection-image.tightenOrdering",
"summary": "Tighten ordering for all images of the collection",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-image/{collectionImage}/detach": {
"post": {
"operationId": "collection-image.detach",
"summary": "Detach a collection image and convert it back to available image",
"tags": [
"CollectionImage"
],
"parameters": [
{
"name": "collectionImage",
"in": "path",
"required": true,
"description": "The collection image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection/{collection}/media": {
"get": {
"operationId": "collection.media.index",
"summary": "Display a listing of collection media for a specific collection",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Array of `CollectionMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionMediaResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "collection.media.store",
"summary": "Store a newly created collection media",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collection",
"in": "path",
"required": true,
"description": "The collection ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCollectionMediaRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/collection-media/{collectionMedia}": {
"get": {
"operationId": "collection-media.show",
"summary": "Display the specified collection media",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collectionMedia",
"in": "path",
"required": true,
"description": "The collection media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`CollectionMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "collection-media.update",
"summary": "Update the specified collection media",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collectionMedia",
"in": "path",
"required": true,
"description": "The collection media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionMediaRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "collectionMedia.update_245",
"summary": "Update the specified collection media",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collectionMedia",
"in": "path",
"required": true,
"description": "The collection media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCollectionMediaRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CollectionMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "collection-media.destroy",
"summary": "Remove the specified collection media",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collectionMedia",
"in": "path",
"required": true,
"description": "The collection media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-media/{collectionMedia}/move-up": {
"patch": {
"operationId": "collection-media.moveUp",
"summary": "Move collection media up in display order",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collectionMedia",
"in": "path",
"required": true,
"description": "The collection media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`CollectionMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/collection-media/{collectionMedia}/move-down": {
"patch": {
"operationId": "collection-media.moveDown",
"summary": "Move collection media down in display order",
"tags": [
"CollectionMedia"
],
"parameters": [
{
"name": "collectionMedia",
"in": "path",
"required": true,
"description": "The collection media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`CollectionMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CollectionMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/context/default": {
"get": {
"operationId": "context.getDefault",
"summary": "Get the default context",
"tags": [
"Context"
],
"responses": {
"200": {
"description": "`ContextResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContextResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
""
]
}
]
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"delete": {
"operationId": "context.clearDefault",
"summary": "Clear the default flag from any context",
"tags": [
"Context"
],
"responses": {
"200": {
"description": "`MessageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MessageResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/context/{context}": {
"get": {
"operationId": "context.show",
"summary": "Display the specified resource",
"tags": [
"Context"
],
"parameters": [
{
"name": "context",
"in": "path",
"required": true,
"description": "The context ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "No related resources available for inclusion on this endpoint.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`ContextResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContextResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "context.update",
"summary": "Update the specified resource in storage",
"tags": [
"Context"
],
"parameters": [
{
"name": "context",
"in": "path",
"required": true,
"description": "The context ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContextRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContextResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContextResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "context.update_159",
"summary": "Update the specified resource in storage",
"tags": [
"Context"
],
"parameters": [
{
"name": "context",
"in": "path",
"required": true,
"description": "The context ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContextRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContextResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContextResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "context.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Context"
],
"parameters": [
{
"name": "context",
"in": "path",
"required": true,
"description": "The context ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/context": {
"get": {
"operationId": "context.index",
"summary": "Display a listing of the resource",
"tags": [
"Context"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "No related resources available for inclusion on this endpoint.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ContextResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "context.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Context"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreContextRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContextResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContextResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/context/{context}/default": {
"patch": {
"operationId": "context.setDefault",
"summary": "Set or unset a context as the default one",
"tags": [
"Context"
],
"parameters": [
{
"name": "context",
"in": "path",
"required": true,
"description": "The context ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultContextRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContextResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContextResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/contributor/{contributor}": {
"get": {
"operationId": "contributor.show",
"summary": "Display the specified resource",
"tags": [
"Contributor"
],
"parameters": [
{
"name": "contributor",
"in": "path",
"required": true,
"description": "The contributor ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `collection`, `translations`, `contributorImages`.",
"schema": {
"type": "string",
"examples": [
"collection,translations,contributorImages"
]
}
}
],
"responses": {
"200": {
"description": "`ContributorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "contributor.update",
"summary": "Update the specified resource in storage",
"tags": [
"Contributor"
],
"parameters": [
{
"name": "contributor",
"in": "path",
"required": true,
"description": "The contributor ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContributorRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "contributor.update_249",
"summary": "Update the specified resource in storage",
"tags": [
"Contributor"
],
"parameters": [
{
"name": "contributor",
"in": "path",
"required": true,
"description": "The contributor ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContributorRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "contributor.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Contributor"
],
"parameters": [
{
"name": "contributor",
"in": "path",
"required": true,
"description": "The contributor ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor": {
"get": {
"operationId": "contributor.index",
"summary": "Display a listing of the resource",
"tags": [
"Contributor"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `collection`, `translations`, `contributorImages`.",
"schema": {
"type": "string",
"examples": [
"collection,translations,contributorImages"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ContributorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContributorResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "contributor.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Contributor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreContributorRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/contributor-image/{contributorImage}/download": {
"get": {
"operationId": "contributor-image.download",
"summary": "Returns the image, with its copyright burned in, as a download",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-image/{contributorImage}/view": {
"get": {
"operationId": "contributor-image.view",
"summary": "Returns the image, with its copyright burned in, for direct viewing: the bytes /pub serves",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-image/{contributorImage}": {
"get": {
"operationId": "contributor-image.show",
"summary": "Display the specified resource",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `contributor`.",
"schema": {
"type": "string",
"examples": [
"contributor"
]
}
}
],
"responses": {
"200": {
"description": "`ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "contributor-image.update",
"summary": "Update the specified resource in storage",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContributorImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "contributorImage.update_253",
"summary": "Update the specified resource in storage",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContributorImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "contributor-image.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-image": {
"get": {
"operationId": "contributor-image.index",
"summary": "Display a listing of the resource",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `contributor`.",
"schema": {
"type": "string",
"examples": [
"contributor"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "contributor-image.store",
"summary": "Store a newly created resource in storage",
"tags": [
"ContributorImage"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreContributorImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/contributor/{contributor}/attach-image": {
"post": {
"operationId": "contributor.attachImage",
"summary": "Attach an available image to a contributor",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributor",
"in": "path",
"required": true,
"description": "The contributor ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachFromAvailableContributorImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/contributor-image/{contributorImage}/move-up": {
"patch": {
"operationId": "contributor-image.moveUp",
"summary": "Move contributor image up in display order",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-image/{contributorImage}/move-down": {
"patch": {
"operationId": "contributor-image.moveDown",
"summary": "Move contributor image down in display order",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ContributorImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-image/{contributorImage}/tighten-ordering": {
"patch": {
"operationId": "contributor-image.tightenOrdering",
"summary": "Tighten ordering for all images of the contributor",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-image/{contributorImage}/detach": {
"post": {
"operationId": "contributor-image.detach",
"summary": "Detach a contributor image and convert it back to available image",
"tags": [
"ContributorImage"
],
"parameters": [
{
"name": "contributorImage",
"in": "path",
"required": true,
"description": "The contributor image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-translation/{contributorTranslation}": {
"get": {
"operationId": "contributor-translation.show",
"summary": "Display the specified resource",
"tags": [
"ContributorTranslation"
],
"parameters": [
{
"name": "contributorTranslation",
"in": "path",
"required": true,
"description": "The contributor translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `contributor`, `language`, `context`.",
"schema": {
"type": "string",
"examples": [
"contributor,language,context"
]
}
}
],
"responses": {
"200": {
"description": "`ContributorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "contributor-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"ContributorTranslation"
],
"parameters": [
{
"name": "contributorTranslation",
"in": "path",
"required": true,
"description": "The contributor translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContributorTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "contributorTranslation.update_251",
"summary": "Update the specified resource in storage",
"tags": [
"ContributorTranslation"
],
"parameters": [
{
"name": "contributorTranslation",
"in": "path",
"required": true,
"description": "The contributor translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContributorTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "contributor-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"ContributorTranslation"
],
"parameters": [
{
"name": "contributorTranslation",
"in": "path",
"required": true,
"description": "The contributor translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/contributor-translation": {
"get": {
"operationId": "contributor-translation.index",
"summary": "Display a listing of the resource",
"tags": [
"ContributorTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `contributor`, `language`, `context`.",
"schema": {
"type": "string",
"examples": [
"contributor,language,context"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ContributorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContributorTranslationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "contributor-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"ContributorTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreContributorTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ContributorTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ContributorTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/country/{country}": {
"get": {
"operationId": "country.show",
"summary": "Display the specified resource",
"tags": [
"Country"
],
"parameters": [
{
"name": "country",
"in": "path",
"required": true,
"description": "The country ID",
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `items`, `partners`, `translations`.",
"schema": {
"type": "string",
"examples": [
"items,partners,translations"
]
}
}
],
"responses": {
"200": {
"description": "`CountryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "country.update",
"summary": "Update the specified resource in storage",
"tags": [
"Country"
],
"parameters": [
{
"name": "country",
"in": "path",
"required": true,
"description": "The country ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CountryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "country.update_177",
"summary": "Update the specified resource in storage",
"tags": [
"Country"
],
"parameters": [
{
"name": "country",
"in": "path",
"required": true,
"description": "The country ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CountryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "country.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Country"
],
"parameters": [
{
"name": "country",
"in": "path",
"required": true,
"description": "The country ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/country": {
"get": {
"operationId": "country.index",
"summary": "Display a listing of the resource",
"tags": [
"Country"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `items`, `partners`, `translations`.",
"schema": {
"type": "string",
"examples": [
"items,partners,translations"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `CountryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "country.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Country"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCountryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CountryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/country-translation/{countryTranslation}": {
"get": {
"operationId": "country-translation.show",
"summary": "Display the specified resource",
"tags": [
"CountryTranslation"
],
"parameters": [
{
"name": "countryTranslation",
"in": "path",
"required": true,
"description": "The country translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `country`, `language`.",
"schema": {
"type": "string",
"examples": [
"country,language"
]
}
}
],
"responses": {
"200": {
"description": "`CountryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "country-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"CountryTranslation"
],
"parameters": [
{
"name": "countryTranslation",
"in": "path",
"required": true,
"description": "The country translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CountryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "countryTranslation.update_179",
"summary": "Update the specified resource in storage",
"tags": [
"CountryTranslation"
],
"parameters": [
{
"name": "countryTranslation",
"in": "path",
"required": true,
"description": "The country translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCountryTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CountryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "country-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"CountryTranslation"
],
"parameters": [
{
"name": "countryTranslation",
"in": "path",
"required": true,
"description": "The country translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/country-translation": {
"get": {
"operationId": "country-translation.index",
"summary": "Display a listing of the resource",
"tags": [
"CountryTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `country`, `language`.",
"schema": {
"type": "string",
"examples": [
"country,language"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `CountryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryTranslationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "country-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"CountryTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCountryTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CountryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CountryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/dynasty/{dynasty}": {
"get": {
"operationId": "dynasty.show",
"summary": "Display the specified resource",
"tags": [
"Dynasty"
],
"parameters": [
{
"name": "dynasty",
"in": "path",
"required": true,
"description": "The dynasty ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `translations`, `items`.",
"schema": {
"type": "string",
"examples": [
"translations,items"
]
}
}
],
"responses": {
"200": {
"description": "`DynastyResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "dynasty.update",
"summary": "Update the specified resource in storage",
"tags": [
"Dynasty"
],
"parameters": [
{
"name": "dynasty",
"in": "path",
"required": true,
"description": "The dynasty ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDynastyRequest"
}
}
}
},
"responses": {
"200": {
"description": "`DynastyResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "dynasty.update_183",
"summary": "Update the specified resource in storage",
"tags": [
"Dynasty"
],
"parameters": [
{
"name": "dynasty",
"in": "path",
"required": true,
"description": "The dynasty ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDynastyRequest"
}
}
}
},
"responses": {
"200": {
"description": "`DynastyResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "dynasty.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Dynasty"
],
"parameters": [
{
"name": "dynasty",
"in": "path",
"required": true,
"description": "The dynasty ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/dynasty": {
"get": {
"operationId": "dynasty.index",
"summary": "Display a listing of the resource",
"tags": [
"Dynasty"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `translations`, `items`.",
"schema": {
"type": "string",
"examples": [
"translations,items"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `DynastyResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynastyResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "dynasty.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Dynasty"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreDynastyRequest"
}
}
}
},
"responses": {
"200": {
"description": "`DynastyResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/dynasty-translation/{dynastyTranslation}": {
"get": {
"operationId": "dynasty-translation.show",
"summary": "Display the specified resource",
"tags": [
"DynastyTranslation"
],
"parameters": [
{
"name": "dynastyTranslation",
"in": "path",
"required": true,
"description": "The dynasty translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `dynasty`, `language`, `author`, `textCopyEditor`, `translator`, `translationCopyEditor`.",
"schema": {
"type": "string",
"examples": [
"dynasty,language,author"
]
}
}
],
"responses": {
"200": {
"description": "`DynastyTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "dynasty-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"DynastyTranslation"
],
"parameters": [
{
"name": "dynastyTranslation",
"in": "path",
"required": true,
"description": "The dynasty translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDynastyTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`DynastyTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "dynastyTranslation.update_185",
"summary": "Update the specified resource in storage",
"tags": [
"DynastyTranslation"
],
"parameters": [
{
"name": "dynastyTranslation",
"in": "path",
"required": true,
"description": "The dynasty translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDynastyTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`DynastyTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "dynasty-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"DynastyTranslation"
],
"parameters": [
{
"name": "dynastyTranslation",
"in": "path",
"required": true,
"description": "The dynasty translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/dynasty-translation": {
"get": {
"operationId": "dynasty-translation.index",
"summary": "Display a listing of the resource",
"tags": [
"DynastyTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `dynasty`, `language`, `author`, `textCopyEditor`, `translator`, `translationCopyEditor`.",
"schema": {
"type": "string",
"examples": [
"dynasty,language,author"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `DynastyTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynastyTranslationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "dynasty-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"DynastyTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreDynastyTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`DynastyTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DynastyTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/glossary/{glossary}": {
"get": {
"operationId": "glossary.show",
"summary": "Display the specified resource",
"tags": [
"Glossary"
],
"parameters": [
{
"name": "glossary",
"in": "path",
"required": true,
"description": "The glossary ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `translations`, `spellings`, `synonyms`.",
"schema": {
"type": "string",
"examples": [
"translations,spellings,synonyms"
]
}
}
],
"responses": {
"200": {
"description": "`GlossaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "glossary.update",
"summary": "Update the specified resource in storage",
"tags": [
"Glossary"
],
"parameters": [
{
"name": "glossary",
"in": "path",
"required": true,
"description": "The glossary ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGlossaryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "glossary.update_167",
"summary": "Update the specified resource in storage",
"tags": [
"Glossary"
],
"parameters": [
{
"name": "glossary",
"in": "path",
"required": true,
"description": "The glossary ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGlossaryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "glossary.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Glossary"
],
"parameters": [
{
"name": "glossary",
"in": "path",
"required": true,
"description": "The glossary ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/glossary": {
"get": {
"operationId": "glossary.index",
"summary": "Display a listing of the resource",
"tags": [
"Glossary"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `translations`, `spellings`, `synonyms`.",
"schema": {
"type": "string",
"examples": [
"translations,spellings,synonyms"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `GlossaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlossaryResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "glossary.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Glossary"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreGlossaryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/glossary/{glossary}/attach-synonym": {
"post": {
"operationId": "glossary.attachSynonym",
"summary": "Attach a synonym to the glossary entry",
"tags": [
"Glossary"
],
"parameters": [
{
"name": "glossary",
"in": "path",
"required": true,
"description": "The glossary ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachGlossarySynonymRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GlossaryResource"
},
{
"type": "object",
"required": [
"synonyms"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/glossary/{glossary}/detach-synonym": {
"delete": {
"operationId": "glossary.detachSynonym",
"summary": "Detach a synonym from the glossary entry",
"tags": [
"Glossary"
],
"parameters": [
{
"name": "glossary",
"in": "path",
"required": true,
"description": "The glossary ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "synonym_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`GlossaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GlossaryResource"
},
{
"type": "object",
"required": [
"synonyms"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/glossary-spelling/{glossarySpelling}": {
"get": {
"operationId": "glossary-spelling.show",
"summary": "Display the specified resource",
"tags": [
"GlossarySpelling"
],
"parameters": [
{
"name": "glossarySpelling",
"in": "path",
"required": true,
"description": "The glossary spelling ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `glossary`, `language`, `itemTranslations`.",
"schema": {
"type": "string",
"examples": [
"glossary,language,itemTranslations"
]
}
}
],
"responses": {
"200": {
"description": "`GlossarySpellingResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossarySpellingResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "glossary-spelling.update",
"summary": "Update the specified resource in storage",
"tags": [
"GlossarySpelling"
],
"parameters": [
{
"name": "glossarySpelling",
"in": "path",
"required": true,
"description": "The glossary spelling ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGlossarySpellingRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossarySpellingResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossarySpellingResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "glossarySpelling.update_171",
"summary": "Update the specified resource in storage",
"tags": [
"GlossarySpelling"
],
"parameters": [
{
"name": "glossarySpelling",
"in": "path",
"required": true,
"description": "The glossary spelling ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGlossarySpellingRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossarySpellingResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossarySpellingResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "glossary-spelling.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"GlossarySpelling"
],
"parameters": [
{
"name": "glossarySpelling",
"in": "path",
"required": true,
"description": "The glossary spelling ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/glossary-spelling": {
"get": {
"operationId": "glossary-spelling.index",
"summary": "Display a listing of the resource",
"tags": [
"GlossarySpelling"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `glossary`, `language`, `itemTranslations`.",
"schema": {
"type": "string",
"examples": [
"glossary,language,itemTranslations"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `GlossarySpellingResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlossarySpellingResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "glossary-spelling.store",
"summary": "Store a newly created resource in storage",
"tags": [
"GlossarySpelling"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreGlossarySpellingRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossarySpellingResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossarySpellingResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/glossary-translation/{glossaryTranslation}": {
"get": {
"operationId": "glossary-translation.show",
"summary": "Display the specified resource",
"tags": [
"GlossaryTranslation"
],
"parameters": [
{
"name": "glossaryTranslation",
"in": "path",
"required": true,
"description": "The glossary translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `glossary`, `language`.",
"schema": {
"type": "string",
"examples": [
"glossary,language"
]
}
}
],
"responses": {
"200": {
"description": "`GlossaryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "glossary-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"GlossaryTranslation"
],
"parameters": [
{
"name": "glossaryTranslation",
"in": "path",
"required": true,
"description": "The glossary translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGlossaryTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossaryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "glossaryTranslation.update_169",
"summary": "Update the specified resource in storage",
"tags": [
"GlossaryTranslation"
],
"parameters": [
{
"name": "glossaryTranslation",
"in": "path",
"required": true,
"description": "The glossary translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGlossaryTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossaryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "glossary-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"GlossaryTranslation"
],
"parameters": [
{
"name": "glossaryTranslation",
"in": "path",
"required": true,
"description": "The glossary translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/glossary-translation": {
"get": {
"operationId": "glossary-translation.index",
"summary": "Display a listing of the resource",
"tags": [
"GlossaryTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `glossary`, `language`.",
"schema": {
"type": "string",
"examples": [
"glossary,language"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `GlossaryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlossaryTranslationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "glossary-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"GlossaryTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreGlossaryTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`GlossaryTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GlossaryTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/image-upload/{id}/status": {
"get": {
"operationId": "image-upload.status",
"description": "Returns the processing status. If processing is complete, returns the AvailableImage details.\nIf the ImageUpload no longer exists, check if an AvailableImage exists with the same ID.",
"summary": "Get the processing status of an image upload",
"tags": [
"ImageUpload"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"available_image": {
"anyOf": [
{
"$ref": "#/components/schemas/AvailableImageResource"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"available_image"
]
}
}
}
},
"200": {
"description": "`ImageUploadStatusResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImageUploadStatusResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/image-upload/{imageUpload}": {
"get": {
"operationId": "image-upload.show",
"summary": "Display the specified resource",
"tags": [
"ImageUpload"
],
"parameters": [
{
"name": "imageUpload",
"in": "path",
"required": true,
"description": "The image upload ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ImageUploadResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImageUploadResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"delete": {
"operationId": "image-upload.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"ImageUpload"
],
"parameters": [
{
"name": "imageUpload",
"in": "path",
"required": true,
"description": "The image upload ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/image-upload": {
"get": {
"operationId": "image-upload.index",
"summary": "Display a listing of the resource",
"tags": [
"ImageUpload"
],
"responses": {
"200": {
"description": "Array of `ImageUploadResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageUploadResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "image-upload.store",
"summary": "Store a newly created resource in storage",
"tags": [
"ImageUpload"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/StoreImageUploadRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ImageUploadResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImageUploadResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/info": {
"get": {
"operationId": "info.index",
"description": "Returns basic application information including:\n- Application name and version\n- Health check status for key services\n- Timestamp of the response",
"summary": "Get application information including version and health status",
"tags": [
"Info"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/health": {
"get": {
"operationId": "info.health",
"description": "Lightweight endpoint for health monitoring that returns\nonly the essential health status information.",
"summary": "Get only the health check status",
"tags": [
"Info"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/version": {
"get": {
"operationId": "info.version",
"description": "Simple endpoint that returns just the version information\nfor deployment tracking and API compatibility checks.",
"summary": "Get application version information only",
"tags": [
"Info"
],
"responses": {
"200": {
"description": "`VersionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VersionResource"
}
},
"required": [
"data"
]
}
}
}
}
}
}
},
"/item/for-tag/{tag}": {
"get": {
"operationId": "item.forTag",
"summary": "Get items for a specific tag",
"tags": [
"Item"
],
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"description": "The tag ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "Array of `ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/with-all-tags": {
"post": {
"operationId": "item.withAllTags",
"summary": "Get items that have ALL of the specified tags (AND condition)",
"tags": [
"Item"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WithAllTagsItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "Array of `ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/with-any-tags": {
"post": {
"operationId": "item.withAnyTags",
"summary": "Get items that have ANY of the specified tags (OR condition)",
"tags": [
"Item"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WithAnyTagsItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "Array of `ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/type/{type}": {
"get": {
"operationId": "item.byType",
"summary": "Get items by type",
"tags": [
"Item"
],
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"object",
"monument",
"detail",
"picture"
]
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "Array of `ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/parents": {
"get": {
"operationId": "item.parents",
"summary": "Get parent items (items with no parent)",
"tags": [
"Item"
],
"parameters": [
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "Array of `ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/children": {
"get": {
"operationId": "item.children",
"summary": "Get child items (items with a parent)",
"tags": [
"Item"
],
"parameters": [
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "Array of `ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}": {
"get": {
"operationId": "item.show",
"summary": "Display the specified resource",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "item.update",
"summary": "Update the specified resource in storage",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "item.update_221",
"summary": "Update the specified resource in storage",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "item.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item": {
"get": {
"operationId": "item.index",
"summary": "Display a listing of the resource",
"tags": [
"Item"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "item.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Item"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}/attach-tag": {
"post": {
"operationId": "item.attachTag",
"summary": "Attach a single tag to an item",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachTagItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}/attach-tags": {
"post": {
"operationId": "item.attachTags",
"summary": "Attach multiple tags to an item",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachTagsItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}/tags": {
"patch": {
"operationId": "item.updateTags",
"summary": "Update the tags associated with an item.\nThis endpoint handles attaching and/or detaching tags from an item using a single operation.\nDesigned for granular tag management, allowing callers to perform specific tag attach/detach\noperations without requiring a full item update",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "- The item to update tags for",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTagsItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}/detach-tag": {
"delete": {
"operationId": "item.detachTag",
"summary": "Detach a single tag from an item",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "tag_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}/detach-tags": {
"delete": {
"operationId": "item.detachTags",
"summary": "Detach multiple tags from an item",
"tags": [
"Item"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "tag_ids[]",
"in": "query",
"schema": {
"type": "array",
"format": "uuid",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"schema": {
"type": "string",
"examples": [
"partner,country,project"
]
}
}
],
"responses": {
"200": {
"description": "`ItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item-item-link-translation/{itemItemLinkTranslation}": {
"get": {
"operationId": "item-item-link-translation.show",
"summary": "Display the specified item-item link translation",
"tags": [
"Item Item Link Translations",
"ItemItemLinkTranslation"
],
"parameters": [
{
"name": "itemItemLinkTranslation",
"in": "path",
"required": true,
"description": "The item item link translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `itemItemLink`, `language`.",
"schema": {
"type": "string",
"examples": [
"itemItemLink,language"
]
}
}
],
"responses": {
"200": {
"description": "`ItemItemLinkTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemItemLinkTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "item-item-link-translation.update",
"summary": "Update the specified item-item link translation",
"tags": [
"Item Item Link Translations",
"ItemItemLinkTranslation"
],
"parameters": [
{
"name": "itemItemLinkTranslation",
"in": "path",
"required": true,
"description": "The item item link translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemItemLinkTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemItemLinkTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ItemItemLinkTranslationResource"
},
{
"type": "object",
"required": [
"item_item_link",
"language"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "itemItemLinkTranslation.update_238",
"summary": "Update the specified item-item link translation",
"tags": [
"Item Item Link Translations",
"ItemItemLinkTranslation"
],
"parameters": [
{
"name": "itemItemLinkTranslation",
"in": "path",
"required": true,
"description": "The item item link translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemItemLinkTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemItemLinkTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ItemItemLinkTranslationResource"
},
{
"type": "object",
"required": [
"item_item_link",
"language"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "item-item-link-translation.destroy",
"summary": "Remove the specified item-item link translation",
"tags": [
"Item Item Link Translations",
"ItemItemLinkTranslation"
],
"parameters": [
{
"name": "itemItemLinkTranslation",
"in": "path",
"required": true,
"description": "The item item link translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-item-link-translation": {
"get": {
"operationId": "item-item-link-translation.index",
"summary": "Display a listing of item-item link translations",
"tags": [
"Item Item Link Translations",
"ItemItemLinkTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "item_item_link_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "language_id",
"in": "query",
"schema": {
"type": "string",
"minLength": 3,
"maxLength": 3
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ItemItemLinkTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ItemItemLinkTranslationResource"
},
{
"type": "object",
"required": [
"item_item_link",
"language"
]
}
]
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "item-item-link-translation.store",
"summary": "Store a newly created item-item link translation",
"tags": [
"Item Item Link Translations",
"ItemItemLinkTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreItemItemLinkTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemItemLinkTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ItemItemLinkTranslationResource"
},
{
"type": "object",
"required": [
"item_item_link",
"language"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item-translation/{itemTranslation}": {
"get": {
"operationId": "item-translation.show",
"summary": "Display the specified item translation",
"tags": [
"Item Translations",
"ItemTranslation"
],
"parameters": [
{
"name": "itemTranslation",
"in": "path",
"required": true,
"description": "The item translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `item`, `language`, `context`, `author`, `textCopyEditor`, `translator`, `translationCopyEditor`, `credits`.",
"schema": {
"type": "string",
"examples": [
"item,language,context"
]
}
}
],
"responses": {
"200": {
"description": "`ItemTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "item-translation.update",
"summary": "Update the specified item translation",
"tags": [
"Item Translations",
"ItemTranslation"
],
"parameters": [
{
"name": "itemTranslation",
"in": "path",
"required": true,
"description": "The item translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ItemTranslationResource"
},
{
"type": "object",
"required": [
"item",
"language",
"context",
"author",
"text_copy_editor",
"translator",
"translation_copy_editor"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "itemTranslation.update_258",
"summary": "Update the specified item translation",
"tags": [
"Item Translations",
"ItemTranslation"
],
"parameters": [
{
"name": "itemTranslation",
"in": "path",
"required": true,
"description": "The item translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ItemTranslationResource"
},
{
"type": "object",
"required": [
"item",
"language",
"context",
"author",
"text_copy_editor",
"translator",
"translation_copy_editor"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "item-translation.destroy",
"summary": "Remove the specified item translation",
"tags": [
"Item Translations",
"ItemTranslation"
],
"parameters": [
{
"name": "itemTranslation",
"in": "path",
"required": true,
"description": "The item translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-translation": {
"get": {
"operationId": "item-translation.index",
"summary": "Display a listing of item translations",
"tags": [
"Item Translations",
"ItemTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "item_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "language_id",
"in": "query",
"schema": {
"type": "string",
"minLength": 3,
"maxLength": 3
}
},
{
"name": "context_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "default_context",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ItemTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ItemTranslationResource"
},
{
"type": "object",
"required": [
"item",
"language",
"context",
"author",
"text_copy_editor",
"translator",
"translation_copy_editor"
]
}
]
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "item-translation.store",
"summary": "Store a newly created item translation",
"tags": [
"Item Translations",
"ItemTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreItemTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ItemTranslationResource"
},
{
"type": "object",
"required": [
"item",
"language",
"context",
"author",
"text_copy_editor",
"translator",
"translation_copy_editor"
]
}
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}/documents": {
"get": {
"operationId": "item.documents.index",
"summary": "Display a listing of item documents for a specific item",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Array of `ItemDocumentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemDocumentResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "item.documents.store",
"summary": "Store a newly created item document",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreItemDocumentRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemDocumentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemDocumentResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item-document/{itemDocument}/download": {
"get": {
"operationId": "item-document.download",
"summary": "Returns the document file for download",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "itemDocument",
"in": "path",
"required": true,
"description": "The item document ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-document/{itemDocument}": {
"get": {
"operationId": "item-document.show",
"summary": "Display the specified item document",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "itemDocument",
"in": "path",
"required": true,
"description": "The item document ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemDocumentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemDocumentResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "item-document.update",
"summary": "Update the specified item document",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "itemDocument",
"in": "path",
"required": true,
"description": "The item document ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemDocumentRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemDocumentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemDocumentResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "itemDocument.update_232",
"summary": "Update the specified item document",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "itemDocument",
"in": "path",
"required": true,
"description": "The item document ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemDocumentRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemDocumentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemDocumentResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "item-document.destroy",
"summary": "Remove the specified item document",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "itemDocument",
"in": "path",
"required": true,
"description": "The item document ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-document/{itemDocument}/move-up": {
"patch": {
"operationId": "item-document.moveUp",
"summary": "Move item document up in display order",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "itemDocument",
"in": "path",
"required": true,
"description": "The item document ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemDocumentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemDocumentResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-document/{itemDocument}/move-down": {
"patch": {
"operationId": "item-document.moveDown",
"summary": "Move item document down in display order",
"tags": [
"ItemDocument"
],
"parameters": [
{
"name": "itemDocument",
"in": "path",
"required": true,
"description": "The item document ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemDocumentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemDocumentResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item/{item}/images": {
"get": {
"operationId": "item.images.index",
"summary": "Display a listing of item images for a specific item",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `item`.",
"schema": {
"type": "string",
"examples": [
"item"
]
}
}
],
"responses": {
"200": {
"description": "Array of `ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemImageResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "item.images.store",
"summary": "Store a newly created item image",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreItemImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item-image/{itemImage}/download": {
"get": {
"operationId": "item-image.download",
"summary": "Returns the image, with its copyright burned in, as a download",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-image/{itemImage}/view": {
"get": {
"operationId": "item-image.view",
"summary": "Returns the image, with its copyright burned in, for direct viewing (e.g., for use in ![]()
src attribute): the bytes /pub serves",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-image/{itemImage}": {
"get": {
"operationId": "item-image.show",
"summary": "Display the specified item image",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `item`.",
"schema": {
"type": "string",
"examples": [
"item"
]
}
}
],
"responses": {
"200": {
"description": "`ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "item-image.update",
"summary": "Update the specified item image",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "itemImage.update_223",
"summary": "Update the specified item image",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "item-image.destroy",
"summary": "Remove the specified item image",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item/{item}/attach-image": {
"post": {
"operationId": "item.attachImage",
"summary": "Attach an available image to an item",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachFromAvailableItemImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item-image/{itemImage}/move-up": {
"patch": {
"operationId": "item-image.moveUp",
"summary": "Move item image up in display order",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-image/{itemImage}/move-down": {
"patch": {
"operationId": "item-image.moveDown",
"summary": "Move item image down in display order",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-image/{itemImage}/tighten-ordering": {
"patch": {
"operationId": "item-image.tightenOrdering",
"summary": "Tighten ordering for all images of the item",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-image/{itemImage}/detach": {
"post": {
"operationId": "item-image.detach",
"summary": "Detach an item image and convert it back to available image",
"tags": [
"ItemImage"
],
"parameters": [
{
"name": "itemImage",
"in": "path",
"required": true,
"description": "The item image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-item-link/{itemItemLink}": {
"get": {
"operationId": "item-item-link.show",
"summary": "Display the specified resource",
"tags": [
"ItemItemLink"
],
"parameters": [
{
"name": "itemItemLink",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`ItemItemLinkResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemItemLinkResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "item-item-link.update",
"summary": "Update the specified resource in storage",
"tags": [
"ItemItemLink"
],
"parameters": [
{
"name": "itemItemLink",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemItemLinkRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemItemLinkResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemItemLinkResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "itemItemLink.update_236",
"summary": "Update the specified resource in storage",
"tags": [
"ItemItemLink"
],
"parameters": [
{
"name": "itemItemLink",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemItemLinkRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemItemLinkResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemItemLinkResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "item-item-link.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"ItemItemLink"
],
"parameters": [
{
"name": "itemItemLink",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-item-link": {
"get": {
"operationId": "item-item-link.index",
"summary": "Display a listing of the resource",
"tags": [
"ItemItemLink"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "source_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "target_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "context_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "item_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ItemItemLinkResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemItemLinkResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "item-item-link.store",
"summary": "Store a newly created resource in storage",
"tags": [
"ItemItemLink"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreItemItemLinkRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemItemLinkResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemItemLinkResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item/{item}/media": {
"get": {
"operationId": "item.media.index",
"summary": "Display a listing of item media for a specific item",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Array of `ItemMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemMediaResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"post": {
"operationId": "item.media.store",
"summary": "Store a newly created item media",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreItemMediaRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/item-media/{itemMedia}": {
"get": {
"operationId": "item-media.show",
"summary": "Display the specified item media",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "itemMedia",
"in": "path",
"required": true,
"description": "The item media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "item-media.update",
"summary": "Update the specified item media",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "itemMedia",
"in": "path",
"required": true,
"description": "The item media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemMediaRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "itemMedia.update_228",
"summary": "Update the specified item media",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "itemMedia",
"in": "path",
"required": true,
"description": "The item media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemMediaRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ItemMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "item-media.destroy",
"summary": "Remove the specified item media",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "itemMedia",
"in": "path",
"required": true,
"description": "The item media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-media/{itemMedia}/move-up": {
"patch": {
"operationId": "item-media.moveUp",
"summary": "Move item media up in display order",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "itemMedia",
"in": "path",
"required": true,
"description": "The item media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/item-media/{itemMedia}/move-down": {
"patch": {
"operationId": "item-media.moveDown",
"summary": "Move item media down in display order",
"tags": [
"ItemMedia"
],
"parameters": [
{
"name": "itemMedia",
"in": "path",
"required": true,
"description": "The item media ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`ItemMediaResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ItemMediaResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/language/default": {
"get": {
"operationId": "language.getDefault",
"summary": "Get the default Language",
"tags": [
"Language"
],
"responses": {
"200": {
"description": "`LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
""
]
}
]
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"delete": {
"operationId": "language.clearDefault",
"summary": "Clear the default flag from any language",
"tags": [
"Language"
],
"responses": {
"200": {
"description": "`MessageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MessageResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/language/english": {
"get": {
"operationId": "language.getEnglish",
"summary": "Get the english Language",
"tags": [
"Language"
],
"responses": {
"200": {
"description": "`LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
""
]
}
]
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/language/{language}": {
"get": {
"operationId": "language.show",
"summary": "Display the specified resource",
"tags": [
"Language"
],
"parameters": [
{
"name": "language",
"in": "path",
"required": true,
"description": "The language ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "language.update",
"summary": "Update the specified resource in storage",
"tags": [
"Language"
],
"parameters": [
{
"name": "language",
"in": "path",
"required": true,
"description": "The language ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLanguageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "language.update_163",
"summary": "Update the specified resource in storage",
"tags": [
"Language"
],
"parameters": [
{
"name": "language",
"in": "path",
"required": true,
"description": "The language ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLanguageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "language.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Language"
],
"parameters": [
{
"name": "language",
"in": "path",
"required": true,
"description": "The language ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/language": {
"get": {
"operationId": "language.index",
"summary": "Display a listing of the resource",
"tags": [
"Language"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Paginated set of `LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "language.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Language"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreLanguageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/language/{language}/default": {
"patch": {
"operationId": "language.setDefault",
"summary": "Set or unset a Language as the default one",
"tags": [
"Language"
],
"parameters": [
{
"name": "language",
"in": "path",
"required": true,
"description": "The language ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultLanguageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LanguageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/language-translation/{languageTranslation}": {
"get": {
"operationId": "language-translation.show",
"summary": "Display the specified resource",
"tags": [
"LanguageTranslation"
],
"parameters": [
{
"name": "languageTranslation",
"in": "path",
"required": true,
"description": "The language translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `displayLanguage`.",
"schema": {
"type": "string",
"examples": [
"language,displayLanguage"
]
}
}
],
"responses": {
"200": {
"description": "`LanguageTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "language-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"LanguageTranslation"
],
"parameters": [
{
"name": "languageTranslation",
"in": "path",
"required": true,
"description": "The language translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLanguageTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LanguageTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "languageTranslation.update_165",
"summary": "Update the specified resource in storage",
"tags": [
"LanguageTranslation"
],
"parameters": [
{
"name": "languageTranslation",
"in": "path",
"required": true,
"description": "The language translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLanguageTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LanguageTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "language-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"LanguageTranslation"
],
"parameters": [
{
"name": "languageTranslation",
"in": "path",
"required": true,
"description": "The language translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/language-translation": {
"get": {
"operationId": "language-translation.index",
"summary": "Display a listing of the resource",
"tags": [
"LanguageTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `displayLanguage`.",
"schema": {
"type": "string",
"examples": [
"language,displayLanguage"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `LanguageTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageTranslationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "language-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"LanguageTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreLanguageTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LanguageTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LanguageTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/markdown/to-html": {
"post": {
"operationId": "markdown.toHtml",
"description": "Converts Markdown formatted text to HTML for display purposes.\nThe input is validated to ensure it contains safe Markdown content.",
"summary": "Convert Markdown to HTML",
"tags": [
"Markdown\n\nAPI endpoints for Markdown processing and conversion",
"Markdown"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"markdown": {
"type": "string"
}
},
"required": [
"markdown"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "integer",
"const": 200
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
},
"security": []
}
},
"/markdown/from-html": {
"post": {
"operationId": "markdown.fromHtml",
"description": "Converts HTML content to Markdown format with controlled tag support.\nOnly allowed HTML tags will be processed, others will be stripped.",
"summary": "Convert HTML to Markdown",
"tags": [
"Markdown\n\nAPI endpoints for Markdown processing and conversion",
"Markdown"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"html": {
"type": "string",
"maxLength": 65535
}
},
"required": [
"html"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "integer",
"const": 200
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/markdown/validate": {
"post": {
"operationId": "markdown.validate",
"description": "Validates Markdown content without converting it, useful for form validation.",
"summary": "Validate Markdown content",
"tags": [
"Markdown\n\nAPI endpoints for Markdown processing and conversion",
"Markdown"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"markdown": {
"type": "string"
}
},
"required": [
"markdown"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "integer",
"const": 200
}
}
}
}
}
}
},
"/markdown/preview": {
"post": {
"operationId": "markdown.preview",
"description": "Generates an HTML preview of Markdown content for display purposes.\nThis is essentially the same as markdownToHtml but with a different semantic meaning.",
"summary": "Preview Markdown content",
"tags": [
"Markdown\n\nAPI endpoints for Markdown processing and conversion",
"Markdown"
],
"responses": {
"422": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": [
"string",
"boolean"
]
},
"message": {
"type": "string"
},
"data": {
"type": "string"
},
"error": {
"type": "string"
},
"errors": {
"type": "string"
}
},
"required": [
"success",
"message",
"data",
"error",
"errors"
]
}
}
}
},
"200": {
"description": "`ConversionResource`",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConversionResource"
}
}
}
}
}
}
},
"/markdown/is-markdown": {
"post": {
"operationId": "markdown.isMarkdown",
"description": "Analyzes content to determine if it appears to contain Markdown formatting.\nUseful for automatic detection of content type.",
"summary": "Check if content is Markdown",
"tags": [
"Markdown\n\nAPI endpoints for Markdown processing and conversion",
"Markdown"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string"
}
},
"required": [
"content"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "integer",
"const": 200
}
}
}
}
}
}
},
"/markdown/allowed-elements": {
"get": {
"operationId": "markdown.allowedElements",
"description": "Returns the list of HTML tags that are supported for HTML-to-Markdown conversion.",
"summary": "Get allowed HTML tags",
"tags": [
"Markdown\n\nAPI endpoints for Markdown processing and conversion",
"Markdown"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "integer",
"const": 200
}
}
}
}
}
}
},
"/partner/{partner}": {
"get": {
"operationId": "partner.show",
"summary": "Display the specified resource",
"tags": [
"Partner"
],
"parameters": [
{
"name": "partner",
"in": "path",
"required": true,
"description": "The partner ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `country`, `items`, `pictures`, `project`, `monumentItem`, `translations`, `partnerImages`, `partnerLogos`, `collections`.",
"schema": {
"type": "string",
"examples": [
"country,items,pictures"
]
}
}
],
"responses": {
"200": {
"description": "`PartnerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "partner.update",
"summary": "Update the specified resource in storage",
"tags": [
"Partner"
],
"parameters": [
{
"name": "partner",
"in": "path",
"required": true,
"description": "The partner ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "partner.update_201",
"summary": "Update the specified resource in storage",
"tags": [
"Partner"
],
"parameters": [
{
"name": "partner",
"in": "path",
"required": true,
"description": "The partner ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "partner.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Partner"
],
"parameters": [
{
"name": "partner",
"in": "path",
"required": true,
"description": "The partner ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner": {
"get": {
"operationId": "partner.index",
"summary": "Display a listing of the resource",
"tags": [
"Partner"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `country`, `items`, `pictures`, `project`, `monumentItem`, `translations`, `partnerImages`, `partnerLogos`, `collections`.",
"schema": {
"type": "string",
"examples": [
"country,items,pictures"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `PartnerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "partner.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Partner"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePartnerRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/partner-image/{partnerImage}/download": {
"get": {
"operationId": "partner-image.download",
"summary": "Returns the image, with its copyright burned in, as a download",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-image/{partnerImage}/view": {
"get": {
"operationId": "partner-image.view",
"summary": "Returns the image, with its copyright burned in, for direct viewing (e.g., for use in ![]()
src attribute): the bytes /pub serves",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-image/{partnerImage}": {
"get": {
"operationId": "partner-image.show",
"summary": "Display the specified resource",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`.",
"schema": {
"type": "string",
"examples": [
"partner"
]
}
}
],
"responses": {
"200": {
"description": "`PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "partner-image.update",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "partnerImage.update_205",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "partner-image.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-image": {
"get": {
"operationId": "partner-image.index",
"summary": "Display a listing of the resource",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`.",
"schema": {
"type": "string",
"examples": [
"partner"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "partner-image.store",
"summary": "Store a newly created resource in storage",
"tags": [
"PartnerImage"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePartnerImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/partner/{partner}/attach-image": {
"post": {
"operationId": "partner.attachImage",
"summary": "Attach an available image to a partner",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partner",
"in": "path",
"required": true,
"description": "The partner ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachFromAvailablePartnerImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/partner-image/{partnerImage}/move-up": {
"patch": {
"operationId": "partner-image.moveUp",
"summary": "Move partner image up in display order",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-image/{partnerImage}/move-down": {
"patch": {
"operationId": "partner-image.moveDown",
"summary": "Move partner image down in display order",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`PartnerImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-image/{partnerImage}/tighten-ordering": {
"patch": {
"operationId": "partner-image.tightenOrdering",
"summary": "Tighten ordering for all images of the partner",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-image/{partnerImage}/detach": {
"post": {
"operationId": "partner-image.detach",
"summary": "Detach a partner image and convert it back to available image",
"tags": [
"PartnerImage"
],
"parameters": [
{
"name": "partnerImage",
"in": "path",
"required": true,
"description": "The partner image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-logo/{partnerLogo}/download": {
"get": {
"operationId": "partner-logo.download",
"summary": "Returns the file to the caller",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-logo/{partnerLogo}/view": {
"get": {
"operationId": "partner-logo.view",
"summary": "Returns the logo file for direct viewing (e.g., for use in ![]()
src attribute)",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-logo/{partnerLogo}": {
"get": {
"operationId": "partner-logo.show",
"summary": "Display the specified resource",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`.",
"schema": {
"type": "string",
"examples": [
"partner"
]
}
}
],
"responses": {
"200": {
"description": "`PartnerLogoResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerLogoResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "partner-logo.update",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerLogoRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerLogoResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerLogoResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "partnerLogo.update_210",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerLogoRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerLogoResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerLogoResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "partner-logo.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-logo": {
"get": {
"operationId": "partner-logo.index",
"summary": "Display a listing of the resource",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`.",
"schema": {
"type": "string",
"examples": [
"partner"
]
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Paginated set of `PartnerLogoResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerLogoResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "partner-logo.store",
"summary": "Store a newly created resource in storage",
"tags": [
"PartnerLogo"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePartnerLogoRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerLogoResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerLogoResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/partner-logo/{partnerLogo}/move-up": {
"patch": {
"operationId": "partner-logo.moveUp",
"summary": "Move partner logo up in display order",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`PartnerLogoResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerLogoResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-logo/{partnerLogo}/move-down": {
"patch": {
"operationId": "partner-logo.moveDown",
"summary": "Move partner logo down in display order",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`PartnerLogoResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerLogoResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-logo/{partnerLogo}/tighten-ordering": {
"patch": {
"operationId": "partner-logo.tightenOrdering",
"summary": "Tighten ordering for all logos of the partner",
"tags": [
"PartnerLogo"
],
"parameters": [
{
"name": "partnerLogo",
"in": "path",
"required": true,
"description": "The partner logo ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation/{partnerTranslation}": {
"get": {
"operationId": "partner-translation.show",
"summary": "Display the specified resource",
"tags": [
"PartnerTranslation"
],
"parameters": [
{
"name": "partnerTranslation",
"in": "path",
"required": true,
"description": "The partner translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `language`, `context`, `partnerTranslationImages`.",
"schema": {
"type": "string",
"examples": [
"partner,language,context"
]
}
}
],
"responses": {
"200": {
"description": "`PartnerTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "partner-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerTranslation"
],
"parameters": [
{
"name": "partnerTranslation",
"in": "path",
"required": true,
"description": "The partner translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "partnerTranslation.update_203",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerTranslation"
],
"parameters": [
{
"name": "partnerTranslation",
"in": "path",
"required": true,
"description": "The partner translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "partner-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"PartnerTranslation"
],
"parameters": [
{
"name": "partnerTranslation",
"in": "path",
"required": true,
"description": "The partner translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation": {
"get": {
"operationId": "partner-translation.index",
"summary": "Display a listing of the resource",
"tags": [
"PartnerTranslation"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `language`, `context`, `partnerTranslationImages`.",
"schema": {
"type": "string",
"examples": [
"partner,language,context"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `PartnerTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerTranslationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "partner-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"PartnerTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePartnerTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/partner-translation-image/{partnerTranslationImage}/download": {
"get": {
"operationId": "partner-translation-image.download",
"summary": "Returns the image, with its copyright burned in, as a download",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation-image/{partnerTranslationImage}/view": {
"get": {
"operationId": "partner-translation-image.view",
"summary": "Returns the image, with its copyright burned in, for direct viewing (e.g., for use in ![]()
src attribute): the bytes /pub serves",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation-image/{partnerTranslationImage}": {
"get": {
"operationId": "partner-translation-image.show",
"summary": "Display the specified resource",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partnerTranslation`.",
"schema": {
"type": "string",
"examples": [
"partnerTranslation"
]
}
}
],
"responses": {
"200": {
"description": "`PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "partner-translation-image.update",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerTranslationImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "partnerTranslationImage.update_215",
"summary": "Update the specified resource in storage",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePartnerTranslationImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "partner-translation-image.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation-image": {
"get": {
"operationId": "partner-translation-image.index",
"summary": "Display a listing of the resource",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `partnerTranslation`.",
"schema": {
"type": "string",
"examples": [
"partnerTranslation"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "partner-translation-image.store",
"summary": "Store a newly created resource in storage",
"tags": [
"PartnerTranslationImage"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePartnerTranslationImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/partner-translation/{partnerTranslation}/attach-image": {
"post": {
"operationId": "partner-translation.attachImage",
"summary": "Attach an available image to a partner translation",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslation",
"in": "path",
"required": true,
"description": "The partner translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachFromAvailablePartnerTranslationImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/partner-translation-image/{partnerTranslationImage}/move-up": {
"patch": {
"operationId": "partner-translation-image.moveUp",
"summary": "Move partner translation image up in display order",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation-image/{partnerTranslationImage}/move-down": {
"patch": {
"operationId": "partner-translation-image.moveDown",
"summary": "Move partner translation image down in display order",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`PartnerTranslationImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation-image/{partnerTranslationImage}/tighten-ordering": {
"patch": {
"operationId": "partner-translation-image.tightenOrdering",
"summary": "Tighten ordering for all images of the partner translation",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/partner-translation-image/{partnerTranslationImage}/detach": {
"post": {
"operationId": "partner-translation-image.detach",
"summary": "Detach a partner translation image and convert it back to available image",
"tags": [
"PartnerTranslationImage"
],
"parameters": [
{
"name": "partnerTranslationImage",
"in": "path",
"required": true,
"description": "The partner translation image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`OperationSuccessResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OperationSuccessResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/project/enabled": {
"get": {
"operationId": "project.enabled",
"summary": "Get all visible projects.\nThe project becomes \"visible\" when all conditions are matched:\n- is_enabled is true\n- is_launched is true\n- current date >= launch_date",
"tags": [
"Project"
],
"responses": {
"200": {
"description": "Array of `ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/project/{project}": {
"get": {
"operationId": "project.show",
"summary": "Display the specified resource",
"tags": [
"Project"
],
"parameters": [
{
"name": "project",
"in": "path",
"required": true,
"description": "The project ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `context`, `language`.",
"schema": {
"type": "string",
"examples": [
"context,language"
]
}
}
],
"responses": {
"200": {
"description": "`ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "project.update",
"summary": "Update the specified resource in storage",
"tags": [
"Project"
],
"parameters": [
{
"name": "project",
"in": "path",
"required": true,
"description": "The project ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "project.update_175",
"summary": "Update the specified resource in storage",
"tags": [
"Project"
],
"parameters": [
{
"name": "project",
"in": "path",
"required": true,
"description": "The project ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProjectRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "project.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Project"
],
"parameters": [
{
"name": "project",
"in": "path",
"required": true,
"description": "The project ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/project": {
"get": {
"operationId": "project.index",
"summary": "Display a listing of the resource",
"tags": [
"Project"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `context`, `language`.",
"schema": {
"type": "string",
"examples": [
"context,language"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "project.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Project"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreProjectRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/project/{project}/launched": {
"patch": {
"operationId": "project.setLaunched",
"summary": "Toggle Launched/not-launched on a project.\nImportant: It is independant from the `launch_date` value. It is an idicator showing that\nthe project is to be considered 'laucnhed' as soon as the launch date it reached",
"tags": [
"Project"
],
"parameters": [
{
"name": "project",
"in": "path",
"required": true,
"description": "The project ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetLaunchedProjectRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/project/{project}/enabled": {
"patch": {
"operationId": "project.setEnabled",
"summary": "Toggle Enable/disable on a project",
"tags": [
"Project"
],
"parameters": [
{
"name": "project",
"in": "path",
"required": true,
"description": "The project ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetEnabledProjectRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProjectResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/tag/for-item/{item}": {
"get": {
"operationId": "tag.forItem",
"summary": "Get tags for a specific item",
"tags": [
"Tag"
],
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"description": "The item ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TagResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/tag/{tag}": {
"get": {
"operationId": "tag.show",
"summary": "Display the specified resource",
"tags": [
"Tag"
],
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"description": "The tag ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`TagResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TagResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "tag.update",
"summary": "Update the specified resource in storage",
"tags": [
"Tag"
],
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"description": "The tag ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTagRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TagResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TagResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "tag.update_181",
"summary": "Update the specified resource in storage",
"tags": [
"Tag"
],
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"description": "The tag ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTagRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TagResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TagResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "tag.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Tag"
],
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"description": "The tag ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/tag": {
"get": {
"operationId": "tag.index",
"summary": "Display a listing of the resource",
"tags": [
"Tag"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TagResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "tag.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Tag"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTagRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TagResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TagResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/timeline/{timeline}": {
"get": {
"operationId": "timeline.show",
"summary": "Display the specified resource",
"tags": [
"Timeline"
],
"parameters": [
{
"name": "timeline",
"in": "path",
"required": true,
"description": "The timeline ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `country`, `collection`, `events`.",
"schema": {
"type": "string",
"examples": [
"country,collection,events"
]
}
}
],
"responses": {
"200": {
"description": "`TimelineResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "timeline.update",
"summary": "Update the specified resource in storage",
"tags": [
"Timeline"
],
"parameters": [
{
"name": "timeline",
"in": "path",
"required": true,
"description": "The timeline ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTimelineRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "timeline.update_191",
"summary": "Update the specified resource in storage",
"tags": [
"Timeline"
],
"parameters": [
{
"name": "timeline",
"in": "path",
"required": true,
"description": "The timeline ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTimelineRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "timeline.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"Timeline"
],
"parameters": [
{
"name": "timeline",
"in": "path",
"required": true,
"description": "The timeline ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/timeline": {
"get": {
"operationId": "timeline.index",
"summary": "Display a listing of the resource",
"tags": [
"Timeline"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `country`, `collection`, `events`.",
"schema": {
"type": "string",
"examples": [
"country,collection,events"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TimelineResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "timeline.store",
"summary": "Store a newly created resource in storage",
"tags": [
"Timeline"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTimelineRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/timeline-event/{timelineEvent}": {
"get": {
"operationId": "timeline-event.show",
"summary": "Display the specified resource",
"tags": [
"TimelineEvent"
],
"parameters": [
{
"name": "timelineEvent",
"in": "path",
"required": true,
"description": "The timeline event ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `timeline`, `translations`, `images`, `items`.",
"schema": {
"type": "string",
"examples": [
"timeline,translations,images"
]
}
}
],
"responses": {
"200": {
"description": "`TimelineEventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"patch": {
"operationId": "timeline-event.update",
"summary": "Update the specified resource in storage",
"tags": [
"TimelineEvent"
],
"parameters": [
{
"name": "timelineEvent",
"in": "path",
"required": true,
"description": "The timeline event ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTimelineEventRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "timelineEvent.update_193",
"summary": "Update the specified resource in storage",
"tags": [
"TimelineEvent"
],
"parameters": [
{
"name": "timelineEvent",
"in": "path",
"required": true,
"description": "The timeline event ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTimelineEventRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "timeline-event.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"TimelineEvent"
],
"parameters": [
{
"name": "timelineEvent",
"in": "path",
"required": true,
"description": "The timeline event ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/timeline-event": {
"get": {
"operationId": "timeline-event.index",
"summary": "Display a listing of the resource",
"tags": [
"TimelineEvent"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of related resources to include. Valid values: `timeline`, `translations`, `images`, `items`.",
"schema": {
"type": "string",
"examples": [
"timeline,translations,images"
]
}
}
],
"responses": {
"200": {
"description": "Paginated set of `TimelineEventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEventResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"post": {
"operationId": "timeline-event.store",
"summary": "Store a newly created resource in storage",
"tags": [
"TimelineEvent"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTimelineEventRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/timeline-event-image/{timelineEventImage}": {
"get": {
"operationId": "timeline-event-image.show",
"summary": "Display the specified resource",
"tags": [
"TimelineEventImage"
],
"parameters": [
{
"name": "timelineEventImage",
"in": "path",
"required": true,
"description": "The timeline event image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`TimelineEventImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "timeline-event-image.update",
"summary": "Update the specified resource in storage",
"tags": [
"TimelineEventImage"
],
"parameters": [
{
"name": "timelineEventImage",
"in": "path",
"required": true,
"description": "The timeline event image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"alt_text": {
"type": [
"string",
"null"
],
"maxLength": 255
}
}
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"put": {
"operationId": "timelineEventImage.update_197",
"summary": "Update the specified resource in storage",
"tags": [
"TimelineEventImage"
],
"parameters": [
{
"name": "timelineEventImage",
"in": "path",
"required": true,
"description": "The timeline event image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"alt_text": {
"type": [
"string",
"null"
],
"maxLength": 255
}
}
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"delete": {
"operationId": "timeline-event-image.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"TimelineEventImage"
],
"parameters": [
{
"name": "timelineEventImage",
"in": "path",
"required": true,
"description": "The timeline event image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/timeline-event-image/{timelineEventImage}/move-up": {
"patch": {
"operationId": "timeline-event-image.moveUp",
"summary": "Move the image up in display order",
"tags": [
"TimelineEventImage"
],
"parameters": [
{
"name": "timelineEventImage",
"in": "path",
"required": true,
"description": "The timeline event image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`TimelineEventImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/timeline-event-image/{timelineEventImage}/move-down": {
"patch": {
"operationId": "timeline-event-image.moveDown",
"summary": "Move the image down in display order",
"tags": [
"TimelineEventImage"
],
"parameters": [
{
"name": "timelineEventImage",
"in": "path",
"required": true,
"description": "The timeline event image ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`TimelineEventImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/timeline-event-translation/{timelineEventTranslation}": {
"get": {
"operationId": "timeline-event-translation.show",
"summary": "Display the specified resource",
"tags": [
"TimelineEventTranslation"
],
"parameters": [
{
"name": "timelineEventTranslation",
"in": "path",
"required": true,
"description": "The timeline event translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "`TimelineEventTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "timeline-event-translation.update",
"summary": "Update the specified resource in storage",
"tags": [
"TimelineEventTranslation"
],
"parameters": [
{
"name": "timelineEventTranslation",
"in": "path",
"required": true,
"description": "The timeline event translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTimelineEventTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"put": {
"operationId": "timelineEventTranslation.update_195",
"summary": "Update the specified resource in storage",
"tags": [
"TimelineEventTranslation"
],
"parameters": [
{
"name": "timelineEventTranslation",
"in": "path",
"required": true,
"description": "The timeline event translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTimelineEventTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
},
"delete": {
"operationId": "timeline-event-translation.destroy",
"summary": "Remove the specified resource from storage",
"tags": [
"TimelineEventTranslation"
],
"parameters": [
{
"name": "timelineEventTranslation",
"in": "path",
"required": true,
"description": "The timeline event translation ID",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/timeline-event-translation": {
"post": {
"operationId": "timeline-event-translation.store",
"summary": "Store a newly created resource in storage",
"tags": [
"TimelineEventTranslation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTimelineEventTranslationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TimelineEventTranslationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TimelineEventTranslationResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
},
"/user/permissions": {
"get": {
"operationId": "user.permissions",
"description": "Returns a list of permission names that the authenticated user has.\nThis is a read-only endpoint for UI clients to determine what features\nto show to the user.",
"summary": "Get the authenticated user's permissions",
"tags": [
"UserPermissions"
],
"responses": {
"200": {
"description": "`UserPermissionsResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserPermissionsResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"$ref": "#/components/responses/AuthorizationException"
}
}
}
}
},
"components": {
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "http://localhost/oauth/authorize",
"tokenUrl": "http://localhost/oauth/token",
"refreshUrl": "http://localhost/oauth/token",
"scopes": {
"mcp:use": "Browse the inventory through its MCP server (read-only)",
"api:read": "Read inventory data through the REST API",
"api:write": "Create, change and delete inventory data through the REST API"
}
}
}
}
},
"schemas": {
"ArtistResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"name": {
"type": "string",
"description": "The name of the artist"
},
"place_of_birth": {
"type": [
"string",
"null"
],
"description": "The place of birth of the artist"
},
"place_of_death": {
"type": [
"string",
"null"
],
"description": "The place of death of the artist"
},
"date_of_birth": {
"type": [
"string",
"null"
],
"description": "The date of birth of the artist"
},
"date_of_death": {
"type": [
"string",
"null"
],
"description": "The date of death of the artist"
},
"period_of_activity": {
"type": [
"string",
"null"
],
"description": "The period of activity of the artist"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"items": {
"type": "array",
"description": "Items associated with this artist (ItemResource[])",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"id",
"name",
"place_of_birth",
"place_of_death",
"date_of_birth",
"date_of_death",
"period_of_activity",
"internal_name",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "ArtistResource"
},
"AttachFromAvailableCollectionImageRequest": {
"type": "object",
"properties": {
"available_image_id": {
"type": "string",
"format": "uuid"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `collection`.",
"examples": [
"collection"
]
}
},
"required": [
"available_image_id"
],
"title": "AttachFromAvailableCollectionImageRequest"
},
"AttachFromAvailableContributorImageRequest": {
"type": "object",
"properties": {
"available_image_id": {
"type": "string",
"format": "uuid"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `contributor`.",
"examples": [
"contributor"
]
}
},
"required": [
"available_image_id"
],
"title": "AttachFromAvailableContributorImageRequest"
},
"AttachFromAvailableItemImageRequest": {
"type": "object",
"properties": {
"available_image_id": {
"type": "string",
"format": "uuid"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `item`.",
"examples": [
"item"
]
}
},
"required": [
"available_image_id"
],
"title": "AttachFromAvailableItemImageRequest"
},
"AttachFromAvailablePartnerImageRequest": {
"type": "object",
"properties": {
"available_image_id": {
"type": "string",
"format": "uuid"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `partner`.",
"examples": [
"partner"
]
}
},
"required": [
"available_image_id"
],
"title": "AttachFromAvailablePartnerImageRequest"
},
"AttachFromAvailablePartnerTranslationImageRequest": {
"type": "object",
"properties": {
"available_image_id": {
"type": "string",
"format": "uuid"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `partnerTranslation`.",
"examples": [
"partnerTranslation"
]
}
},
"required": [
"available_image_id"
],
"title": "AttachFromAvailablePartnerTranslationImageRequest"
},
"AttachGlossarySynonymRequest": {
"type": "object",
"properties": {
"synonym_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"synonym_id"
],
"title": "AttachGlossarySynonymRequest"
},
"AttachItemCollectionRequest": {
"type": "object",
"properties": {
"item_id": {
"type": "string",
"format": "uuid"
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `context`, `translations`, `partners`, `items`, `attachedItems`, `collectionImages`, `collectionMedia`, `contributors`.",
"examples": [
"language,context,translations"
]
}
},
"required": [
"item_id"
],
"title": "AttachItemCollectionRequest"
},
"AttachItemsCollectionRequest": {
"type": "object",
"properties": {
"item_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `language`, `context`, `translations`, `partners`, `items`, `attachedItems`, `collectionImages`, `collectionMedia`, `contributors`.",
"examples": [
"language,context,translations"
]
}
},
"required": [
"item_ids"
],
"title": "AttachItemsCollectionRequest"
},
"AttachTagItemRequest": {
"type": "object",
"properties": {
"tag_id": {
"type": "string",
"format": "uuid"
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"examples": [
"partner,country,project"
]
}
},
"required": [
"tag_id"
],
"title": "AttachTagItemRequest"
},
"AttachTagsItemRequest": {
"type": "object",
"properties": {
"tag_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"examples": [
"partner,country,project"
]
}
},
"required": [
"tag_ids"
],
"title": "AttachTagsItemRequest"
},
"AuthorResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"name": {
"type": "string",
"description": "The name of the author"
},
"firstname": {
"type": [
"string",
"null"
],
"description": "Name parts"
},
"lastname": {
"type": [
"string",
"null"
]
},
"givenname": {
"type": [
"string",
"null"
]
},
"originalname": {
"type": [
"string",
"null"
]
},
"internal_name": {
"type": [
"string",
"null"
],
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"translations": {
"type": "array",
"description": "Relationships",
"items": {
"$ref": "#/components/schemas/AuthorTranslationResource"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"name",
"firstname",
"lastname",
"givenname",
"originalname",
"internal_name",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "AuthorResource"
},
"AuthorTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"author_id": {
"type": "string"
},
"language_id": {
"type": "string"
},
"context_id": {
"type": "string"
},
"curriculum": {
"type": [
"string",
"null"
]
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
},
"context": {
"$ref": "#/components/schemas/ContextResource"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"author_id",
"language_id",
"context_id",
"curriculum",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "AuthorTranslationResource"
},
"AvailableImageResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"path": {
"type": [
"string",
"null"
],
"description": "The path to the picture file"
},
"original_name": {
"type": [
"string",
"null"
],
"description": "The original filename as uploaded"
},
"mime_type": {
"type": [
"string",
"null"
],
"description": "The MIME type of the file"
},
"size": {
"type": [
"integer",
"null"
],
"description": "The size of the processed file in bytes"
},
"comment": {
"type": [
"string",
"null"
],
"description": "A user defined comment associated with the file"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"path",
"original_name",
"mime_type",
"size",
"comment",
"created_at",
"updated_at"
],
"title": "AvailableImageResource"
},
"CollectionImageResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"collection_id": {
"type": "string",
"description": "The collection this image belongs to"
},
"path": {
"type": "string",
"description": "The path to the image file"
},
"original_name": {
"type": "string",
"description": "The original filename when uploaded"
},
"mime_type": {
"type": "string",
"description": "The MIME type of the image"
},
"size": {
"type": "integer",
"description": "The file size in bytes"
},
"alt_text": {
"type": [
"string",
"null"
],
"description": "Alternative text for accessibility"
},
"display_order": {
"type": "integer",
"description": "Display order for sorting images"
},
"collection": {
"description": "The collection this image belongs to (CollectionResource)",
"$ref": "#/components/schemas/CollectionResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"collection_id",
"path",
"original_name",
"mime_type",
"size",
"alt_text",
"display_order",
"created_at",
"updated_at"
],
"title": "CollectionImageResource"
},
"CollectionMediaResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"collection_id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/MediaType"
},
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
},
"display_order": {
"type": "integer"
},
"extra": {
"type": [
"object",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"collection": {
"$ref": "#/components/schemas/CollectionResource"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageResource"
},
{
"type": "null"
}
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"collection_id",
"language_id",
"type",
"title",
"description",
"url",
"display_order",
"extra",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "CollectionMediaResource"
},
"CollectionResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"type": {
"type": "string",
"description": "The type of collection: 'collection', 'exhibition', or 'gallery'"
},
"purpose": {
"type": [
"string",
"null"
],
"description": "The functional purpose of the collection within its context (e.g. 'exhibitions-root'), null for ordinary collections"
},
"language_id": {
"type": "string",
"description": "The language this collection belongs to (LanguageResource id)"
},
"context_id": {
"type": [
"string",
"null"
],
"description": "The context this collection belongs to (ContextResource id)"
},
"parent_id": {
"type": [
"string",
"null"
],
"description": "The parent collection ID (for hierarchical organization)"
},
"display_order": {
"type": [
"integer",
"null"
],
"description": "The display order within sibling collections"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"extra": {
"type": [
"object",
"null"
],
"description": "Collection-level structured attributes that belong to the collection rather than to one of its languages (e.g. a thematic gallery's source project, slug and canonical host)"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"language": {
"description": "The language relationship (LanguageResource)",
"$ref": "#/components/schemas/LanguageResource"
},
"context": {
"description": "The context relationship (ContextResource)",
"$ref": "#/components/schemas/ContextResource"
},
"parent": {
"anyOf": [
{
"description": "The parent collection (CollectionResource)",
"$ref": "#/components/schemas/CollectionResource"
},
{
"type": "null"
}
]
},
"children": {
"type": "array",
"description": "Child collections (CollectionResource[])",
"items": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"translations": {
"type": "array",
"description": "Translations for this collection (CollectionTranslationResource[])",
"items": {
"$ref": "#/components/schemas/CollectionTranslationResource"
}
},
"partners": {
"type": "array",
"description": "Partners associated with this collection (PartnerResource[])",
"items": {
"$ref": "#/components/schemas/PartnerResource"
}
},
"items": {
"type": "array",
"description": "Items associated with this collection - primary relationship (ItemResource[])",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
},
"attachedItems": {
"type": "array",
"description": "Items attached to this collection via many-to-many relationship (ItemResource[])",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
},
"items_count": {
"type": "integer",
"description": "The number of items in this collection (computed)",
"minimum": 0
},
"attached_items_count": {
"type": "integer",
"minimum": 0
},
"partners_count": {
"type": "integer",
"minimum": 0
},
"translations_count": {
"type": "integer",
"minimum": 0
},
"children_count": {
"type": "integer",
"minimum": 0
}
},
"required": [
"id",
"internal_name",
"type",
"purpose",
"language_id",
"context_id",
"parent_id",
"display_order",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "CollectionResource"
},
"CollectionTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"collection_id": {
"type": "string",
"description": "The collection this translation belongs to (CollectionResource id)"
},
"language_id": {
"type": "string",
"description": "The language of this translation (LanguageResource id)"
},
"context_id": {
"type": "string",
"description": "The context of this translation (ContextResource id)"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the collection translation"
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of the collection translation"
},
"quote": {
"type": [
"string",
"null"
],
"description": "The quote/introduction of the collection translation (optional)"
},
"url": {
"type": [
"string",
"null"
],
"description": "The URL for the collection translation"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"extra": {
"type": [
"object",
"null"
],
"description": "Extra data for translation (object, may be null)"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"collection": {
"description": "The collection relationship (CollectionResource)",
"$ref": "#/components/schemas/CollectionResource"
},
"language": {
"description": "The language relationship (LanguageResource)",
"$ref": "#/components/schemas/LanguageResource"
},
"context": {
"description": "The context relationship (ContextResource)",
"$ref": "#/components/schemas/ContextResource"
}
},
"required": [
"id",
"collection_id",
"language_id",
"context_id",
"title",
"description",
"quote",
"url",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "CollectionTranslationResource"
},
"ContextResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"is_default": {
"type": "boolean",
"description": "Indicates if this context is the default one. There is one single default context for the entire database."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"internal_name",
"backward_compatibility",
"is_default",
"created_at",
"updated_at"
],
"title": "ContextResource"
},
"ContributorImageResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contributor_id": {
"type": "string"
},
"path": {
"type": "string"
},
"original_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer"
},
"contributor": {
"description": "Relationships",
"$ref": "#/components/schemas/ContributorResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"contributor_id",
"path",
"original_name",
"mime_type",
"size",
"alt_text",
"display_order",
"created_at",
"updated_at"
],
"title": "ContributorImageResource"
},
"ContributorResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"collection_id": {
"type": "string"
},
"category": {
"type": "string"
},
"display_order": {
"type": "integer"
},
"visible": {
"type": "boolean"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"internal_name": {
"type": "string"
},
"collection": {
"description": "Relationships",
"$ref": "#/components/schemas/CollectionResource"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContributorTranslationResource"
}
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContributorImageResource"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"collection_id",
"category",
"display_order",
"visible",
"backward_compatibility",
"internal_name",
"created_at",
"updated_at"
],
"title": "ContributorResource"
},
"ContributorTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contributor_id": {
"type": "string"
},
"language_id": {
"type": "string"
},
"context_id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"link": {
"type": [
"string",
"null"
]
},
"alt_text": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"object",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"contributor": {
"description": "Relationships",
"$ref": "#/components/schemas/ContributorResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
},
"context": {
"$ref": "#/components/schemas/ContextResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"contributor_id",
"language_id",
"context_id",
"name",
"description",
"link",
"alt_text",
"extra",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "ContributorTranslationResource"
},
"ConversionResource": {
"type": "object",
"properties": {
"success": {
"type": [
"string",
"boolean"
]
},
"message": {
"type": "string"
},
"data": {
"type": "string"
},
"error": {
"type": "string"
},
"errors": {
"type": "string"
}
},
"required": [
"success",
"message",
"data",
"error",
"errors"
],
"title": "ConversionResource"
},
"CountryResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (ISO 3166-1 alpha-3 code)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"internal_name",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "CountryResource"
},
"CountryTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"country_id": {
"type": "string"
},
"language_id": {
"type": "string"
},
"name": {
"type": "string"
},
"country": {
"description": "Relationships",
"$ref": "#/components/schemas/CountryResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "Metadata"
},
"extra": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"country_id",
"language_id",
"name",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "CountryTranslationResource"
},
"DynastyResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from_ah": {
"type": [
"integer",
"null"
]
},
"to_ah": {
"type": [
"integer",
"null"
]
},
"from_ad": {
"type": [
"integer",
"null"
]
},
"to_ad": {
"type": [
"integer",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynastyTranslationResource"
}
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"from_ah",
"to_ah",
"from_ad",
"to_ad",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "DynastyResource"
},
"DynastyTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"dynasty_id": {
"type": "string"
},
"language_id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"also_known_as": {
"type": [
"string",
"null"
]
},
"area": {
"type": [
"string",
"null"
]
},
"history": {
"type": [
"string",
"null"
]
},
"date_description_ah": {
"type": [
"string",
"null"
]
},
"date_description_ad": {
"type": [
"string",
"null"
]
},
"author_id": {
"type": [
"string",
"null"
]
},
"text_copy_editor_id": {
"type": [
"string",
"null"
]
},
"translator_id": {
"type": [
"string",
"null"
]
},
"translation_copy_editor_id": {
"type": [
"string",
"null"
]
},
"dynasty": {
"$ref": "#/components/schemas/DynastyResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
},
"author": {
"anyOf": [
{
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"text_copy_editor": {
"anyOf": [
{
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"translator": {
"anyOf": [
{
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"translation_copy_editor": {
"anyOf": [
{
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"dynasty_id",
"language_id",
"name",
"also_known_as",
"area",
"history",
"date_description_ah",
"date_description_ad",
"author_id",
"text_copy_editor_id",
"translator_id",
"translation_copy_editor_id",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "DynastyTranslationResource"
},
"GlossaryResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"translations": {
"type": "array",
"description": "Relationships (only included if loaded)",
"items": {
"$ref": "#/components/schemas/GlossaryTranslationResource"
}
},
"spellings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlossarySpellingResource"
}
},
"synonyms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlossaryResource"
}
}
},
"required": [
"id",
"internal_name",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "GlossaryResource"
},
"GlossarySpellingResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"glossary_id": {
"type": "string",
"description": "The glossary this spelling belongs to"
},
"language_id": {
"type": "string",
"description": "The language of this spelling"
},
"spelling": {
"type": "string",
"description": "The spelling variation"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"glossary": {
"description": "Relationships (only included if loaded)",
"$ref": "#/components/schemas/GlossaryResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
},
"item_translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemTranslationResource"
}
}
},
"required": [
"id",
"glossary_id",
"language_id",
"spelling",
"created_at",
"updated_at"
],
"title": "GlossarySpellingResource"
},
"GlossaryTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"glossary_id": {
"type": "string",
"description": "The glossary this translation belongs to"
},
"language_id": {
"type": "string",
"description": "The language of this translation"
},
"definition": {
"type": "string",
"description": "The definition/translation text"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"glossary": {
"description": "Relationships (only included if loaded)",
"$ref": "#/components/schemas/GlossaryResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"id",
"glossary_id",
"language_id",
"definition",
"created_at",
"updated_at"
],
"title": "GlossaryTranslationResource"
},
"ImageUploadResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"path": {
"type": [
"string",
"null"
],
"description": "The path to the picture file"
},
"name": {
"type": [
"string",
"null"
],
"description": "The original name of the uploaded file"
},
"extension": {
"type": [
"string",
"null"
],
"description": "The file extension of the uploaded file"
},
"mime_type": {
"type": [
"string",
"null"
],
"description": "The MIME type of the uploaded file"
},
"size": {
"type": [
"integer",
"null"
],
"description": "The size of the uploaded file in bytes"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"path",
"name",
"extension",
"mime_type",
"size",
"created_at",
"updated_at"
],
"title": "ImageUploadResource"
},
"ImageUploadStatusResource": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"available_image": {
"anyOf": [
{
"$ref": "#/components/schemas/AvailableImageResource"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"available_image"
],
"title": "ImageUploadStatusResource"
},
"ItemDocumentResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
]
},
"path": {
"type": "string"
},
"original_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"title": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer"
},
"extra": {
"type": [
"object",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"item": {
"$ref": "#/components/schemas/ItemResource"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageResource"
},
{
"type": "null"
}
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"item_id",
"language_id",
"path",
"original_name",
"mime_type",
"size",
"title",
"display_order",
"extra",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "ItemDocumentResource"
},
"ItemImageResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"item_id": {
"type": "string",
"description": "The item this image belongs to"
},
"path": {
"type": "string",
"description": "The path to the image file"
},
"original_name": {
"type": "string",
"description": "The original filename when uploaded"
},
"mime_type": {
"type": "string",
"description": "The MIME type of the image"
},
"size": {
"type": "integer",
"description": "The file size in bytes"
},
"alt_text": {
"type": [
"string",
"null"
],
"description": "Alternative text for accessibility"
},
"display_order": {
"type": "integer",
"description": "Display order for sorting images"
},
"item": {
"description": "The item this image belongs to (ItemResource)",
"$ref": "#/components/schemas/ItemResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"item_id",
"path",
"original_name",
"mime_type",
"size",
"alt_text",
"display_order",
"created_at",
"updated_at"
],
"title": "ItemImageResource"
},
"ItemItemLinkResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"source_id": {
"type": "string",
"description": "The source item ID (the item initiating the link)"
},
"target_id": {
"type": "string",
"description": "The target item ID (the item receiving the link)"
},
"context_id": {
"type": "string",
"description": "The context ID (the context in which the link exists)"
},
"source": {
"description": "The source item (ItemResource)",
"$ref": "#/components/schemas/ItemResource"
},
"target": {
"description": "The target item (ItemResource)",
"$ref": "#/components/schemas/ItemResource"
},
"context": {
"description": "The context (ContextResource)",
"$ref": "#/components/schemas/ContextResource"
},
"translations": {
"type": "array",
"description": "The translations (ItemItemLinkTranslationResource collection)",
"items": {
"$ref": "#/components/schemas/ItemItemLinkTranslationResource"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"source_id",
"target_id",
"context_id",
"created_at",
"updated_at"
],
"title": "ItemItemLinkResource"
},
"ItemItemLinkTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"item_item_link_id": {
"type": "string",
"description": "The item-item link this translation belongs to (ItemItemLinkResource id)"
},
"language_id": {
"type": "string",
"description": "The language of this translation (LanguageResource id)"
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of the link (source \u2192 target direction)"
},
"reciprocal_description": {
"type": [
"string",
"null"
],
"description": "The reciprocal description of the link (target \u2192 source direction)"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"item_item_link": {
"description": "The item-item link relationship (ItemItemLinkResource)",
"$ref": "#/components/schemas/ItemItemLinkResource"
},
"language": {
"description": "The language relationship (LanguageResource)",
"$ref": "#/components/schemas/LanguageResource"
}
},
"required": [
"id",
"item_item_link_id",
"language_id",
"description",
"reciprocal_description",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "ItemItemLinkTranslationResource"
},
"ItemMediaResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/MediaType"
},
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
},
"display_order": {
"type": "integer"
},
"extra": {
"type": [
"object",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"item": {
"$ref": "#/components/schemas/ItemResource"
},
"language": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguageResource"
},
{
"type": "null"
}
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"item_id",
"language_id",
"type",
"title",
"description",
"url",
"display_order",
"extra",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "ItemMediaResource"
},
"ItemResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"type": {
"description": "The type of the item: 'object', 'monument', 'detail', or 'picture'.",
"$ref": "#/components/schemas/ItemType"
},
"parent_id": {
"type": [
"string",
"null"
],
"description": "The parent item ID (for hierarchical relationships), nullable"
},
"display_order": {
"type": [
"integer",
"null"
],
"description": "Display order among siblings sharing the same parent, nullable"
},
"owner_reference": {
"type": [
"string",
"null"
],
"description": "Owner's reference number for the item (external reference from owner)"
},
"mwnf_reference": {
"type": [
"string",
"null"
],
"description": "MWNF reference number for the item (reference from MWNF system)"
},
"start_date": {
"type": [
"integer",
"null"
],
"description": "The start year for the item (for datation purposes)"
},
"end_date": {
"type": [
"integer",
"null"
],
"description": "The end year for the item (for datation purposes)"
},
"parent": {
"anyOf": [
{
"description": "The parent item (for hierarchical relationships), nullable (ItemResource)",
"$ref": "#/components/schemas/ItemResource"
},
{
"type": "null"
}
]
},
"children": {
"type": "array",
"description": "The child items (for hierarchical relationships) (ItemResource[])",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
},
"partner": {
"anyOf": [
{
"description": "The partner owning the item (PartnerResource)",
"$ref": "#/components/schemas/PartnerResource"
},
{
"type": "null"
}
]
},
"project": {
"anyOf": [
{
"description": "The project this item belongs to, nullable (ProjectResource)",
"$ref": "#/components/schemas/ProjectResource"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"description": "The country this item is associated with, nullable (CountryResource)",
"$ref": "#/components/schemas/CountryResource"
},
{
"type": "null"
}
]
},
"collection": {
"anyOf": [
{
"description": "The collection that contains this item (CollectionResource)",
"$ref": "#/components/schemas/CollectionResource"
},
{
"type": "null"
}
]
},
"artists": {
"type": "array",
"description": "Artists associated with this item (ArtistResource[])",
"items": {
"$ref": "#/components/schemas/ArtistResource"
}
},
"workshops": {
"type": "array",
"description": "Workshops associated with this item (WorkshopResource[])",
"items": {
"$ref": "#/components/schemas/WorkshopResource"
}
},
"tags": {
"type": "array",
"description": "Tags associated with this item (TagResource[])",
"items": {
"$ref": "#/components/schemas/TagResource"
}
},
"dynasties": {
"type": "array",
"description": "Dynasties associated with this item (DynastyResource[])",
"items": {
"$ref": "#/components/schemas/DynastyResource"
}
},
"translations": {
"type": "array",
"description": "Translations for this item (internationalization and contextualization) (ItemTranslationResource[])",
"items": {
"$ref": "#/components/schemas/ItemTranslationResource"
}
},
"itemImages": {
"type": "array",
"description": "Item images attached to this item with display ordering (ItemImageResource[])",
"items": {
"$ref": "#/components/schemas/ItemImageResource"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"internal_name",
"backward_compatibility",
"type",
"parent_id",
"display_order",
"owner_reference",
"mwnf_reference",
"start_date",
"end_date",
"created_at",
"updated_at"
],
"title": "ItemResource"
},
"ItemTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"item_id": {
"type": "string",
"description": "The item this translation belongs to (ItemResource id)"
},
"language_id": {
"type": "string",
"description": "The language of this translation (LanguageResource id)"
},
"context_id": {
"type": "string",
"description": "The context of this translation (ContextResource id)"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the item translation"
},
"alternate_name": {
"type": [
"string",
"null"
],
"description": "The alternate name of the item translation"
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of the item translation"
},
"type": {
"type": [
"string",
"null"
],
"description": "The type of the item translation"
},
"holder": {
"type": [
"string",
"null"
],
"description": "The holder of the item"
},
"owner": {
"type": [
"string",
"null"
],
"description": "The owner of the item"
},
"initial_owner": {
"type": [
"string",
"null"
],
"description": "The initial owner of the item"
},
"dates": {
"type": [
"string",
"null"
],
"description": "The dates associated with the item"
},
"location": {
"type": [
"string",
"null"
],
"description": "The location associated with the item"
},
"dimensions": {
"type": [
"string",
"null"
],
"description": "The dimensions of the item"
},
"place_of_production": {
"type": [
"string",
"null"
],
"description": "The place of production of the item"
},
"method_for_datation": {
"type": [
"string",
"null"
],
"description": "The method for datation of the item"
},
"method_for_provenance": {
"type": [
"string",
"null"
],
"description": "The method for provenance of the item"
},
"provenance": {
"type": [
"string",
"null"
],
"description": "The ownership history of the item"
},
"obtention": {
"type": [
"string",
"null"
],
"description": "The obtention of the item"
},
"bibliography": {
"type": [
"string",
"null"
],
"description": "The bibliography for the item"
},
"author_id": {
"type": [
"string",
"null"
],
"description": "The author of the item (AuthorResource id)"
},
"text_copy_editor_id": {
"type": [
"string",
"null"
],
"description": "The copy-editor of the item (AuthorResource id)"
},
"translator_id": {
"type": [
"string",
"null"
],
"description": "The translator of the item translation (AuthorResource id)"
},
"translation_copy_editor_id": {
"type": [
"string",
"null"
],
"description": "The copy-editor of the item translation (AuthorResource id)"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"extra": {
"type": [
"object",
"null"
],
"description": "Extra data for translation (object, may be null)"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"item": {
"description": "The item relationship (ItemResource)",
"$ref": "#/components/schemas/ItemResource"
},
"language": {
"description": "The language relationship (LanguageResource)",
"$ref": "#/components/schemas/LanguageResource"
},
"context": {
"description": "The context relationship (ContextResource)",
"$ref": "#/components/schemas/ContextResource"
},
"author": {
"anyOf": [
{
"description": "The author relationship (AuthorResource)",
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"text_copy_editor": {
"anyOf": [
{
"description": "The copy-editor relationship (AuthorResource)",
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"translator": {
"anyOf": [
{
"description": "The translator relationship (AuthorResource)",
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"translation_copy_editor": {
"anyOf": [
{
"description": "The translation copy-editor relationship (AuthorResource)",
"$ref": "#/components/schemas/AuthorResource"
},
{
"type": "null"
}
]
},
"credits": {
"type": "array",
"description": "Every person credited, per role and in order (role, display_order, AuthorResource)",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"display_order": {
"type": "string"
},
"author": {
"$ref": "#/components/schemas/AuthorResource"
}
},
"required": [
"role",
"display_order",
"author"
]
}
}
},
"required": [
"id",
"item_id",
"language_id",
"context_id",
"name",
"alternate_name",
"description",
"type",
"holder",
"owner",
"initial_owner",
"dates",
"location",
"dimensions",
"place_of_production",
"method_for_datation",
"method_for_provenance",
"provenance",
"obtention",
"bibliography",
"author_id",
"text_copy_editor_id",
"translator_id",
"translation_copy_editor_id",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "ItemTranslationResource"
},
"ItemType": {
"type": "string",
"enum": [
"object",
"monument",
"detail",
"picture"
],
"title": "ItemType"
},
"LanguageResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (ISO 639-1 code)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"is_default": {
"type": "boolean",
"description": "Indicates if this language is the default one. There is one single default language for the entire database."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"internal_name",
"backward_compatibility",
"is_default",
"created_at",
"updated_at"
],
"title": "LanguageResource"
},
"LanguageTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"language_id": {
"type": "string"
},
"display_language_id": {
"type": "string"
},
"name": {
"type": "string"
},
"language": {
"description": "Relationships",
"$ref": "#/components/schemas/LanguageResource"
},
"display_language": {
"$ref": "#/components/schemas/LanguageResource"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "Metadata"
},
"extra": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"language_id",
"display_language_id",
"name",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "LanguageTranslationResource"
},
"MediaType": {
"type": "string",
"enum": [
"audio",
"video",
"document"
],
"title": "MediaType"
},
"MessageResource": {
"type": "object",
"properties": {
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
""
]
}
]
}
},
"required": [
"message"
],
"title": "MessageResource"
},
"OperationSuccessResource": {
"type": "object",
"properties": {
"success": {
"type": [
"string",
"boolean"
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"Operation completed successfully"
]
}
]
}
},
"required": [
"success",
"message"
],
"title": "OperationSuccessResource"
},
"PartnerImageResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"partner_id": {
"type": "string",
"description": "Foreign key"
},
"path": {
"type": "string",
"description": "Image information"
},
"original_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer"
},
"partner": {
"description": "Relationships",
"$ref": "#/components/schemas/PartnerResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"partner_id",
"path",
"original_name",
"mime_type",
"size",
"alt_text",
"display_order",
"created_at",
"updated_at"
],
"title": "PartnerImageResource"
},
"PartnerLogoResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"partner_id": {
"type": "string",
"description": "Foreign key"
},
"path": {
"type": "string",
"description": "Logo information"
},
"original_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"logo_type": {
"type": "string"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer"
},
"partner": {
"description": "Relationships",
"$ref": "#/components/schemas/PartnerResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"partner_id",
"path",
"original_name",
"mime_type",
"size",
"logo_type",
"alt_text",
"display_order",
"created_at",
"updated_at"
],
"title": "PartnerLogoResource"
},
"PartnerResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"type": {
"type": "string",
"description": "The type of the partner, either 'museum', 'institution' or 'individual'."
},
"country": {
"anyOf": [
{
"description": "The country this partner is associated with, nullable (CountryResource)",
"$ref": "#/components/schemas/CountryResource"
},
{
"type": "null"
}
]
},
"latitude": {
"type": [
"string",
"null"
],
"description": "GPS Location"
},
"longitude": {
"type": [
"string",
"null"
]
},
"map_zoom": {
"type": "integer"
},
"project": {
"anyOf": [
{
"description": "Relationships",
"$ref": "#/components/schemas/ProjectResource"
},
{
"type": "null"
}
]
},
"monument_item": {
"anyOf": [
{
"$ref": "#/components/schemas/ItemResource"
},
{
"type": "null"
}
]
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerTranslationResource"
}
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerImageResource"
}
},
"collections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionResource"
}
},
"visible": {
"type": "boolean",
"description": "Visibility"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"internal_name",
"backward_compatibility",
"type",
"latitude",
"longitude",
"map_zoom",
"visible",
"created_at",
"updated_at"
],
"title": "PartnerResource"
},
"PartnerTranslationImageResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"partner_translation_id": {
"type": "string",
"description": "Foreign key"
},
"path": {
"type": "string",
"description": "Image information"
},
"original_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer"
},
"partner_translation": {
"description": "Relationships",
"$ref": "#/components/schemas/PartnerTranslationResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"partner_translation_id",
"path",
"original_name",
"mime_type",
"size",
"alt_text",
"display_order",
"created_at",
"updated_at"
],
"title": "PartnerTranslationImageResource"
},
"PartnerTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"partner_id": {
"type": "string",
"description": "Foreign keys"
},
"language_id": {
"type": "string"
},
"context_id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
],
"description": "Core partner info"
},
"description": {
"type": [
"string",
"null"
]
},
"city_display": {
"type": [
"string",
"null"
],
"description": "Address fields (embedded)"
},
"address_line_1": {
"type": [
"string",
"null"
]
},
"address_line_2": {
"type": [
"string",
"null"
]
},
"postal_code": {
"type": [
"string",
"null"
]
},
"address_notes": {
"type": [
"string",
"null"
]
},
"contact_name": {
"type": [
"string",
"null"
],
"description": "Contact fields (semi-structured)"
},
"contact_email_general": {
"type": [
"string",
"null"
]
},
"contact_email_press": {
"type": [
"string",
"null"
]
},
"contact_phone": {
"type": [
"string",
"null"
]
},
"contact_fax": {
"type": [
"string",
"null"
]
},
"contact_website": {
"type": [
"string",
"null"
]
},
"contact_notes": {
"type": [
"string",
"null"
]
},
"contact_emails": {
"type": [
"array",
"null"
],
"items": {}
},
"contact_phones": {
"type": [
"array",
"null"
],
"items": {}
},
"partner": {
"description": "Relationships",
"$ref": "#/components/schemas/PartnerResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
},
"context": {
"$ref": "#/components/schemas/ContextResource"
},
"partner_translation_images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerTranslationImageResource"
}
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "Metadata"
},
"extra": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Timestamps"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"partner_id",
"language_id",
"context_id",
"name",
"description",
"city_display",
"address_line_1",
"address_line_2",
"postal_code",
"address_notes",
"contact_name",
"contact_email_general",
"contact_email_press",
"contact_phone",
"contact_fax",
"contact_website",
"contact_notes",
"contact_emails",
"contact_phones",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "PartnerTranslationResource"
},
"ProjectResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"launch_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Launch date of the project, nullable"
},
"is_launched": {
"type": "boolean",
"description": "Indicates if the project has been launched already"
},
"is_enabled": {
"type": "boolean",
"description": "Indicates if the project is enabled (active)"
},
"site_url": {
"type": [
"string",
"null"
],
"description": "The public URL of the project's website, nullable"
},
"related_database_url": {
"type": [
"string",
"null"
],
"description": "The URL of a related external database, nullable"
},
"artistic_introduction_url": {
"type": [
"string",
"null"
],
"description": "The URL of the project's artistic introduction page, nullable"
},
"context": {
"anyOf": [
{
"description": "The default context used within the project (ContextResource)",
"$ref": "#/components/schemas/ContextResource"
},
{
"type": "null"
}
]
},
"language": {
"anyOf": [
{
"description": "The default language used within the project (LanguageResource)",
"$ref": "#/components/schemas/LanguageResource"
},
{
"type": "null"
}
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
}
},
"required": [
"id",
"internal_name",
"backward_compatibility",
"launch_date",
"is_launched",
"is_enabled",
"site_url",
"related_database_url",
"artistic_introduction_url",
"created_at",
"updated_at"
],
"title": "ProjectResource"
},
"SetDefaultContextRequest": {
"type": "object",
"properties": {
"is_default": {
"type": "boolean"
}
},
"required": [
"is_default"
],
"title": "SetDefaultContextRequest"
},
"SetDefaultLanguageRequest": {
"type": "object",
"properties": {
"is_default": {
"type": "boolean"
}
},
"required": [
"is_default"
],
"title": "SetDefaultLanguageRequest"
},
"SetEnabledProjectRequest": {
"type": "object",
"properties": {
"is_enabled": {
"type": "boolean"
}
},
"required": [
"is_enabled"
],
"title": "SetEnabledProjectRequest"
},
"SetLaunchedProjectRequest": {
"type": "object",
"properties": {
"is_launched": {
"type": "boolean"
}
},
"required": [
"is_launched"
],
"title": "SetLaunchedProjectRequest"
},
"StoreAuthorRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 255
},
"firstname": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"lastname": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"givenname": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"originalname": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"internal_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
}
},
"required": [
"name"
],
"title": "StoreAuthorRequest"
},
"StoreAuthorTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"author_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"curriculum": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"author_id",
"language_id",
"context_id"
],
"title": "StoreAuthorTranslationRequest"
},
"StoreCollectionImageRequest": {
"type": "object",
"properties": {
"path": {
"type": "string",
"maxLength": 500
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_.]*$",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 1
},
"alt_text": {
"type": [
"string",
"null"
],
"maxLength": 500
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"path",
"original_name",
"mime_type",
"size"
],
"title": "StoreCollectionImageRequest"
},
"StoreCollectionMediaRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"type": {
"type": "string",
"enum": [
"audio",
"video",
"document"
]
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 512
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"required": [
"type",
"title",
"url"
],
"title": "StoreCollectionMediaRequest"
},
"StoreCollectionRequest": {
"type": "object",
"properties": {
"internal_name": {
"type": "string",
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"collection",
"exhibition",
"gallery",
"theme",
"exhibition trail",
"itinerary",
"location",
"subtheme",
"region"
]
},
"purpose": {
"type": [
"string",
"null"
],
"enum": [
"exhibitions-root",
"artistic-introduction-root",
"historical-profiles-root",
"historical-background-root",
"topics-root",
"galleries-root",
"travels-root",
"explore-root",
"explore-themes-root",
"explore-countries-root",
"explore-itineraries-root",
"national-context",
null
]
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string"
},
"parent_id": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"internal_name",
"type",
"language_id",
"context_id"
],
"title": "StoreCollectionRequest"
},
"StoreCollectionTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"collection_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"quote": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 2048
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"string",
"null"
]
}
},
"required": [
"collection_id",
"language_id",
"context_id",
"title"
],
"title": "StoreCollectionTranslationRequest"
},
"StoreContextRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"is_default": {
"type": "boolean"
}
},
"required": [
"internal_name"
],
"title": "StoreContextRequest"
},
"StoreContributorImageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contributor_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"contributor_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "StoreContributorImageRequest"
},
"StoreContributorRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"collection_id": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"maxLength": 50
},
"display_order": {
"type": "integer",
"minimum": 0
},
"visible": {
"type": "boolean"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"internal_name": {
"type": "string"
}
},
"required": [
"collection_id",
"category",
"internal_name"
],
"title": "StoreContributorRequest"
},
"StoreContributorTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contributor_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"link": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"alt_text": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"required": [
"contributor_id",
"language_id",
"context_id"
],
"title": "StoreContributorTranslationRequest"
},
"StoreCountryRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"minLength": 2,
"maxLength": 2
}
},
"required": [
"id",
"internal_name"
],
"title": "StoreCountryRequest"
},
"StoreCountryTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"country_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": "string",
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"country_id",
"language_id",
"name"
],
"title": "StoreCountryTranslationRequest"
},
"StoreDynastyRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from_ah": {
"type": [
"integer",
"null"
]
},
"to_ah": {
"type": [
"integer",
"null"
]
},
"from_ad": {
"type": [
"integer",
"null"
]
},
"to_ad": {
"type": [
"integer",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"title": "StoreDynastyRequest"
},
"StoreDynastyTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"dynasty_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"also_known_as": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"area": {
"type": [
"string",
"null"
]
},
"history": {
"type": [
"string",
"null"
]
},
"date_description_ah": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"date_description_ad": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"author_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"text_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translator_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translation_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"dynasty_id",
"language_id"
],
"title": "StoreDynastyTranslationRequest"
},
"StoreGlossaryRequest": {
"type": "object",
"properties": {
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"required": [
"internal_name"
],
"title": "StoreGlossaryRequest"
},
"StoreGlossarySpellingRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"glossary_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"spelling": {
"type": "string"
}
},
"required": [
"glossary_id",
"language_id",
"spelling"
],
"title": "StoreGlossarySpellingRequest"
},
"StoreGlossaryTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"glossary_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"definition": {
"type": "string"
}
},
"required": [
"glossary_id",
"language_id",
"definition"
],
"title": "StoreGlossaryTranslationRequest"
},
"StoreImageUploadRequest": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Maximum file size: 20480 kilobytes."
}
},
"required": [
"file"
],
"title": "StoreImageUploadRequest"
},
"StoreItemDocumentRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"path": {
"type": "string",
"maxLength": 500
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_.]*$",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 1
},
"title": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"required": [
"path",
"original_name",
"mime_type",
"size"
],
"title": "StoreItemDocumentRequest"
},
"StoreItemImageRequest": {
"type": "object",
"properties": {
"path": {
"type": "string",
"maxLength": 500
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_.]*$",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 1
},
"alt_text": {
"type": [
"string",
"null"
],
"maxLength": 500
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"path",
"original_name",
"mime_type",
"size"
],
"title": "StoreItemImageRequest"
},
"StoreItemItemLinkRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"source_id": {
"type": "string",
"format": "uuid"
},
"target_id": {
"type": "string",
"format": "uuid"
},
"context_id": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"source_id",
"target_id",
"context_id"
],
"title": "StoreItemItemLinkRequest"
},
"StoreItemItemLinkTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_item_link_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"description": {
"type": [
"string",
"null"
]
},
"reciprocal_description": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"item_item_link_id",
"language_id"
],
"title": "StoreItemItemLinkTranslationRequest"
},
"StoreItemMediaRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"type": {
"type": "string",
"enum": [
"audio",
"video"
]
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 512
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"required": [
"type",
"title",
"url"
],
"title": "StoreItemMediaRequest"
},
"StoreItemRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string",
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"object",
"monument",
"detail",
"picture"
]
},
"parent_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"country_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"partner_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"project_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"collection_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"owner_reference": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"mwnf_reference": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"start_date": {
"type": [
"integer",
"null"
],
"minimum": -9999,
"maximum": 9999
},
"end_date": {
"type": [
"integer",
"null"
],
"minimum": -9999,
"maximum": 9999
}
},
"required": [
"internal_name",
"type"
],
"title": "StoreItemRequest"
},
"StoreItemTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"maxLength": 255
},
"alternate_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"holder": {
"type": [
"string",
"null"
]
},
"owner": {
"type": [
"string",
"null"
]
},
"initial_owner": {
"type": [
"string",
"null"
]
},
"dates": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"dimensions": {
"type": [
"string",
"null"
]
},
"place_of_production": {
"type": [
"string",
"null"
]
},
"method_for_datation": {
"type": [
"string",
"null"
]
},
"method_for_provenance": {
"type": [
"string",
"null"
]
},
"provenance": {
"type": [
"string",
"null"
]
},
"obtention": {
"type": [
"string",
"null"
]
},
"bibliography": {
"type": [
"string",
"null"
]
},
"author_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"text_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translator_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translation_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"string",
"null"
]
}
},
"required": [
"item_id",
"language_id",
"context_id",
"name"
],
"title": "StoreItemTranslationRequest"
},
"StoreLanguageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"minLength": 2,
"maxLength": 2
},
"is_default": {
"type": "boolean"
}
},
"required": [
"id",
"internal_name"
],
"title": "StoreLanguageRequest"
},
"StoreLanguageTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"display_language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": "string",
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"language_id",
"display_language_id",
"name"
],
"title": "StoreLanguageTranslationRequest"
},
"StorePartnerImageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"partner_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "StorePartnerImageRequest"
},
"StorePartnerLogoRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"logo_type": {
"type": "string",
"maxLength": 50
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"partner_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "StorePartnerLogoRequest"
},
"StorePartnerRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"enum": [
"museum",
"institution",
"individual",
"school"
]
},
"country_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"latitude": {
"type": [
"number",
"null"
],
"description": "GPS Location",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": [
"number",
"null"
],
"minimum": -180,
"maximum": 180
},
"map_zoom": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 20
},
"project_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Relationships"
},
"monument_item_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"visible": {
"type": "boolean",
"description": "Visibility"
}
},
"required": [
"internal_name",
"type"
],
"title": "StorePartnerRequest"
},
"StorePartnerTranslationImageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_translation_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"partner_translation_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "StorePartnerTranslationImageRequest"
},
"StorePartnerTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"city_display": {
"type": [
"string",
"null"
],
"description": "Address fields",
"maxLength": 255
},
"address_line_1": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"address_line_2": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"postal_code": {
"type": [
"string",
"null"
],
"maxLength": 20
},
"address_notes": {
"type": [
"string",
"null"
]
},
"contact_name": {
"type": [
"string",
"null"
],
"description": "Contact fields",
"maxLength": 255
},
"contact_email_general": {
"type": [
"string",
"null"
],
"format": "email",
"maxLength": 255
},
"contact_email_press": {
"type": [
"string",
"null"
],
"format": "email",
"maxLength": 255
},
"contact_phone": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"contact_fax": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"contact_website": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"contact_notes": {
"type": [
"string",
"null"
]
},
"contact_emails": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "email",
"maxLength": 255
}
},
"contact_phones": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"maxLength": 50
}
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "Metadata",
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"partner_id",
"language_id",
"context_id",
"name"
],
"title": "StorePartnerTranslationRequest"
},
"StoreProjectRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"launch_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"is_launched": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
},
"site_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"related_database_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"artistic_introduction_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"context_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
}
},
"required": [
"internal_name"
],
"title": "StoreProjectRequest"
},
"StoreTagRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"category": {
"type": [
"string",
"null"
],
"enum": [
"keyword",
"material",
"artist",
"dynasty",
"subject",
"type",
"filter",
"image-type",
null
]
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
}
},
"required": [
"internal_name",
"description"
],
"title": "StoreTagRequest"
},
"StoreTimelineEventRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timeline_id": {
"type": "string"
},
"internal_name": {
"type": "string",
"maxLength": 255
},
"year_from": {
"type": "integer"
},
"year_to": {
"type": "integer"
},
"year_from_ah": {
"type": [
"integer",
"null"
]
},
"year_to_ah": {
"type": [
"integer",
"null"
]
},
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_to": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
}
},
"required": [
"timeline_id",
"internal_name",
"year_from",
"year_to"
],
"title": "StoreTimelineEventRequest"
},
"StoreTimelineEventTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timeline_event_id": {
"type": "string"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"date_from_description": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"date_to_description": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"date_from_ah_description": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
}
},
"required": [
"timeline_event_id",
"language_id"
],
"title": "StoreTimelineEventTranslationRequest"
},
"StoreTimelineRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string",
"maxLength": 255
},
"country_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"collection_id": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
}
},
"required": [
"internal_name",
"country_id"
],
"title": "StoreTimelineRequest"
},
"TagResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the tag (GUID)"
},
"internal_name": {
"type": "string",
"description": "The name of the tag, it shall only be used internally"
},
"category": {
"type": [
"string",
"null"
],
"description": "The category of the tag (keyword, material, artist, dynasty), nullable"
},
"language_id": {
"type": [
"string",
"null"
],
"description": "The language of the tag (ISO 639-3 code), nullable"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The legacy Id when this tag corresponds to a legacy tag from the previous database, nullable"
},
"description": {
"type": "string",
"description": "The description of the tag"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Date of creation"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Date of last modification"
}
},
"required": [
"id",
"internal_name",
"category",
"language_id",
"backward_compatibility",
"description",
"created_at",
"updated_at"
],
"title": "TagResource"
},
"TimelineEventImageResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timeline_event_id": {
"type": "string"
},
"path": {
"type": "string"
},
"original_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer"
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer"
},
"timeline_event": {
"$ref": "#/components/schemas/TimelineEventResource"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"timeline_event_id",
"path",
"original_name",
"mime_type",
"size",
"alt_text",
"display_order",
"created_at",
"updated_at"
],
"title": "TimelineEventImageResource"
},
"TimelineEventResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timeline_id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"year_from": {
"type": "integer"
},
"year_to": {
"type": "integer"
},
"year_from_ah": {
"type": [
"integer",
"null"
]
},
"year_to_ah": {
"type": [
"integer",
"null"
]
},
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_to": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"display_order": {
"type": "integer"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"object",
"null"
]
},
"timeline": {
"$ref": "#/components/schemas/TimelineResource"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEventTranslationResource"
}
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEventImageResource"
}
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"timeline_id",
"internal_name",
"year_from",
"year_to",
"year_from_ah",
"year_to_ah",
"date_from",
"date_to",
"display_order",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "TimelineEventResource"
},
"TimelineEventTranslationResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timeline_event_id": {
"type": "string"
},
"language_id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"date_from_description": {
"type": [
"string",
"null"
]
},
"date_to_description": {
"type": [
"string",
"null"
]
},
"date_from_ah_description": {
"type": [
"string",
"null"
]
},
"timeline_event": {
"$ref": "#/components/schemas/TimelineEventResource"
},
"language": {
"$ref": "#/components/schemas/LanguageResource"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"timeline_event_id",
"language_id",
"name",
"description",
"date_from_description",
"date_to_description",
"date_from_ah_description",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "TimelineEventTranslationResource"
},
"TimelineResource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"country_id": {
"type": [
"string",
"null"
]
},
"collection_id": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"object",
"null"
]
},
"country": {
"anyOf": [
{
"$ref": "#/components/schemas/CountryResource"
},
{
"type": "null"
}
]
},
"collection": {
"anyOf": [
{
"$ref": "#/components/schemas/CollectionResource"
},
{
"type": "null"
}
]
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEventResource"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"internal_name",
"country_id",
"collection_id",
"backward_compatibility",
"extra",
"created_at",
"updated_at"
],
"title": "TimelineResource"
},
"UpdateAuthorRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 255
},
"firstname": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"lastname": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"givenname": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"originalname": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"internal_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
}
},
"required": [
"name"
],
"title": "UpdateAuthorRequest"
},
"UpdateAuthorTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"author_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"curriculum": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"author_id",
"language_id",
"context_id"
],
"title": "UpdateAuthorTranslationRequest"
},
"UpdateAvailableImageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"original_name": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "string"
},
"comment": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateAvailableImageRequest"
},
"UpdateCollectionImageRequest": {
"type": "object",
"properties": {
"original_name": {
"type": "string",
"description": "Path and collection_id are immutable - not allowed in updates",
"maxLength": 255
},
"mime_type": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_.]*$",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 1
},
"alt_text": {
"type": [
"string",
"null"
],
"maxLength": 500
},
"display_order": {
"type": "integer",
"minimum": 1
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `collection`.",
"examples": [
"collection"
]
}
},
"title": "UpdateCollectionImageRequest"
},
"UpdateCollectionMediaRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"collection_id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"type": {
"type": "string",
"enum": [
"audio",
"video",
"document"
]
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 512
},
"display_order": {
"type": "integer",
"minimum": 0
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateCollectionMediaRequest"
},
"UpdateCollectionRequest": {
"type": "object",
"properties": {
"internal_name": {
"type": "string",
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"collection",
"exhibition",
"gallery",
"theme",
"exhibition trail",
"itinerary",
"location",
"subtheme",
"region"
]
},
"purpose": {
"type": [
"string",
"null"
],
"enum": [
"exhibitions-root",
"artistic-introduction-root",
"historical-profiles-root",
"historical-background-root",
"topics-root",
"galleries-root",
"travels-root",
"explore-root",
"explore-themes-root",
"explore-countries-root",
"explore-itineraries-root",
"national-context",
null
]
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string"
},
"parent_id": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"title": "UpdateCollectionRequest"
},
"UpdateCollectionTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"collection_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"quote": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 2048
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateCollectionTranslationRequest"
},
"UpdateContextRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"is_default": {
"type": "boolean"
}
},
"required": [
"internal_name"
],
"title": "UpdateContextRequest"
},
"UpdateContributorImageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contributor_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"contributor_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "UpdateContributorImageRequest"
},
"UpdateContributorRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"collection_id": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"maxLength": 50
},
"display_order": {
"type": "integer",
"minimum": 0
},
"visible": {
"type": "boolean"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"internal_name": {
"type": "string"
}
},
"required": [
"collection_id",
"category",
"internal_name"
],
"title": "UpdateContributorRequest"
},
"UpdateContributorTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contributor_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"link": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"alt_text": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"required": [
"contributor_id",
"language_id",
"context_id"
],
"title": "UpdateContributorTranslationRequest"
},
"UpdateCountryRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"minLength": 2,
"maxLength": 2
}
},
"required": [
"internal_name"
],
"title": "UpdateCountryRequest"
},
"UpdateCountryTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"country_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": "string",
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"title": "UpdateCountryTranslationRequest"
},
"UpdateDynastyRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from_ah": {
"type": [
"integer",
"null"
]
},
"to_ah": {
"type": [
"integer",
"null"
]
},
"from_ad": {
"type": [
"integer",
"null"
]
},
"to_ad": {
"type": [
"integer",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateDynastyRequest"
},
"UpdateDynastyTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"dynasty_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"also_known_as": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"area": {
"type": [
"string",
"null"
]
},
"history": {
"type": [
"string",
"null"
]
},
"date_description_ah": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"date_description_ad": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"author_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"text_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translator_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translation_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"dynasty_id",
"language_id"
],
"title": "UpdateDynastyTranslationRequest"
},
"UpdateGlossaryRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"required": [
"internal_name"
],
"title": "UpdateGlossaryRequest"
},
"UpdateGlossarySpellingRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"glossary_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"spelling": {
"type": "string"
}
},
"title": "UpdateGlossarySpellingRequest"
},
"UpdateGlossaryTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"glossary_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"definition": {
"type": "string"
}
},
"title": "UpdateGlossaryTranslationRequest"
},
"UpdateItemDocumentRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_.]*$",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 1
},
"title": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"display_order": {
"type": "integer",
"minimum": 0
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateItemDocumentRequest"
},
"UpdateItemImageRequest": {
"type": "object",
"properties": {
"original_name": {
"type": "string",
"description": "Path and item_id are immutable - not allowed in updates",
"maxLength": 255
},
"mime_type": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&\\-\\^_.]*$",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 1
},
"alt_text": {
"type": [
"string",
"null"
],
"maxLength": 500
},
"display_order": {
"type": "integer",
"minimum": 1
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `item`.",
"examples": [
"item"
]
}
},
"title": "UpdateItemImageRequest"
},
"UpdateItemItemLinkRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"source_id": {
"type": "string",
"format": "uuid"
},
"target_id": {
"type": "string",
"format": "uuid"
},
"context_id": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"source_id",
"target_id",
"context_id"
],
"title": "UpdateItemItemLinkRequest"
},
"UpdateItemItemLinkTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_item_link_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"description": {
"type": [
"string",
"null"
]
},
"reciprocal_description": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"item_item_link_id",
"language_id"
],
"title": "UpdateItemItemLinkTranslationRequest"
},
"UpdateItemMediaRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"type": {
"type": "string",
"enum": [
"audio",
"video"
]
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 512
},
"display_order": {
"type": "integer",
"minimum": 0
},
"extra": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateItemMediaRequest"
},
"UpdateItemRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string",
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"object",
"monument",
"detail",
"picture"
]
},
"parent_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"country_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"partner_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"project_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"collection_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"owner_reference": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"mwnf_reference": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"start_date": {
"type": [
"integer",
"null"
],
"minimum": -9999,
"maximum": 9999
},
"end_date": {
"type": [
"integer",
"null"
],
"minimum": -9999,
"maximum": 9999
}
},
"title": "UpdateItemRequest"
},
"UpdateItemTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"item_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"maxLength": 255
},
"alternate_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"description": {
"type": "string"
},
"type": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"holder": {
"type": [
"string",
"null"
]
},
"owner": {
"type": [
"string",
"null"
]
},
"initial_owner": {
"type": [
"string",
"null"
]
},
"dates": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"dimensions": {
"type": [
"string",
"null"
]
},
"place_of_production": {
"type": [
"string",
"null"
]
},
"method_for_datation": {
"type": [
"string",
"null"
]
},
"method_for_provenance": {
"type": [
"string",
"null"
]
},
"provenance": {
"type": [
"string",
"null"
]
},
"obtention": {
"type": [
"string",
"null"
]
},
"bibliography": {
"type": [
"string",
"null"
]
},
"author_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"text_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translator_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"translation_copy_editor_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateItemTranslationRequest"
},
"UpdateLanguageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"minLength": 2,
"maxLength": 2
},
"is_default": {
"type": "boolean"
}
},
"required": [
"internal_name"
],
"title": "UpdateLanguageRequest"
},
"UpdateLanguageTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"display_language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": "string",
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"title": "UpdateLanguageTranslationRequest"
},
"UpdatePartnerImageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"partner_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "UpdatePartnerImageRequest"
},
"UpdatePartnerLogoRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"logo_type": {
"type": "string",
"maxLength": 50
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"partner_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "UpdatePartnerLogoRequest"
},
"UpdatePartnerRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"enum": [
"museum",
"institution",
"individual",
"school"
]
},
"country_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"latitude": {
"type": [
"number",
"null"
],
"description": "GPS Location",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": [
"number",
"null"
],
"minimum": -180,
"maximum": 180
},
"map_zoom": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 20
},
"project_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Relationships"
},
"monument_item_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"visible": {
"type": "boolean",
"description": "Visibility"
}
},
"required": [
"internal_name",
"type"
],
"title": "UpdatePartnerRequest"
},
"UpdatePartnerTranslationImageRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_translation_id": {
"type": "string",
"format": "uuid"
},
"path": {
"type": "string",
"maxLength": 255
},
"original_name": {
"type": "string",
"maxLength": 255
},
"mime_type": {
"type": "string",
"maxLength": 100
},
"size": {
"type": "integer",
"minimum": 0
},
"alt_text": {
"type": [
"string",
"null"
]
},
"display_order": {
"type": "integer",
"minimum": 1
}
},
"required": [
"partner_translation_id",
"path",
"original_name",
"mime_type",
"size",
"display_order"
],
"title": "UpdatePartnerTranslationImageRequest"
},
"UpdatePartnerTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"partner_id": {
"type": "string",
"format": "uuid"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"context_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"city_display": {
"type": [
"string",
"null"
],
"description": "Address fields",
"maxLength": 255
},
"address_line_1": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"address_line_2": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"postal_code": {
"type": [
"string",
"null"
],
"maxLength": 20
},
"address_notes": {
"type": [
"string",
"null"
]
},
"contact_name": {
"type": [
"string",
"null"
],
"description": "Contact fields",
"maxLength": 255
},
"contact_email_general": {
"type": [
"string",
"null"
],
"format": "email",
"maxLength": 255
},
"contact_email_press": {
"type": [
"string",
"null"
],
"format": "email",
"maxLength": 255
},
"contact_phone": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"contact_fax": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"contact_website": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"contact_notes": {
"type": [
"string",
"null"
]
},
"contact_emails": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "email",
"maxLength": 255
}
},
"contact_phones": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"maxLength": 50
}
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "Metadata",
"maxLength": 255
},
"extra": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"partner_id",
"language_id",
"context_id",
"name"
],
"title": "UpdatePartnerTranslationRequest"
},
"UpdateProjectRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"launch_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"is_launched": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
},
"site_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"related_database_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"artistic_introduction_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"context_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
}
},
"required": [
"internal_name"
],
"title": "UpdateProjectRequest"
},
"UpdateTagRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string"
},
"category": {
"type": [
"string",
"null"
],
"enum": [
"keyword",
"material",
"artist",
"dynasty",
"subject",
"type",
"filter",
"image-type",
null
]
},
"language_id": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
}
},
"required": [
"internal_name",
"description"
],
"title": "UpdateTagRequest"
},
"UpdateTagsItemRequest": {
"type": "object",
"properties": {
"attach": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"detach": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"title": "UpdateTagsItemRequest"
},
"UpdateTimelineEventRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timeline_id": {
"type": "string"
},
"internal_name": {
"type": "string",
"maxLength": 255
},
"year_from": {
"type": "integer"
},
"year_to": {
"type": "integer"
},
"year_from_ah": {
"type": [
"integer",
"null"
]
},
"year_to_ah": {
"type": [
"integer",
"null"
]
},
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_to": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"display_order": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateTimelineEventRequest"
},
"UpdateTimelineEventTranslationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"timeline_event_id": {
"type": "string"
},
"language_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"date_from_description": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"date_to_description": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"date_from_ah_description": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateTimelineEventTranslationRequest"
},
"UpdateTimelineRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal_name": {
"type": "string",
"maxLength": 255
},
"country_id": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"collection_id": {
"type": [
"string",
"null"
]
},
"backward_compatibility": {
"type": [
"string",
"null"
]
},
"extra": {
"type": [
"string",
"null"
]
}
},
"title": "UpdateTimelineRequest"
},
"User": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"email_verified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"current_team_id": {
"type": [
"integer",
"null"
]
},
"profile_photo_path": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"two_factor_confirmed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"approved_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"suspended_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"name",
"email",
"email_verified_at",
"current_team_id",
"profile_photo_path",
"created_at",
"updated_at",
"two_factor_confirmed_at",
"approved_at",
"suspended_at"
],
"title": "User"
},
"UserPermissionsResource": {
"type": "object",
"properties": {
"permissions": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"maxItems": 0
}
]
}
},
"required": [
"permissions"
],
"title": "UserPermissionsResource"
},
"VersionResource": {
"type": "object",
"properties": {
"repository": {
"type": [
"string",
"null"
]
},
"build_timestamp": {
"type": [
"string",
"null"
]
},
"repository_url": {
"type": [
"string",
"null"
]
},
"app_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"1.0.0-dev"
]
}
]
},
"commit_sha": {
"type": [
"string",
"null"
]
}
},
"required": [
"repository",
"build_timestamp",
"repository_url",
"app_version",
"commit_sha"
],
"title": "VersionResource"
},
"WithAllTagsItemRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"examples": [
"partner,country,project"
]
}
},
"required": [
"tags"
],
"title": "WithAllTagsItemRequest"
},
"WithAnyTagsItemRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"minItems": 1
},
"include": {
"type": "string",
"description": "Comma-separated list of related resources to include. Valid values: `partner`, `country`, `project`, `collection`, `parent`, `children`, `itemImages`, `artists`, `workshops`, `tags`, `dynasties`, `translations`, `attachedToCollections`, `outgoingLinks`, `incomingLinks`, `itemMedia`, `itemDocuments`.",
"examples": [
"partner,country,project"
]
}
},
"required": [
"tags"
],
"title": "WithAnyTagsItemRequest"
},
"WorkshopResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier (GUID)"
},
"name": {
"type": "string",
"description": "The name of the workshop"
},
"internal_name": {
"type": "string",
"description": "A name for this resource, for internal use only."
},
"backward_compatibility": {
"type": [
"string",
"null"
],
"description": "The Id(s) of matching resource in the legacy system (if any)."
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of creation of the resource (managed by the system)"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date of last modification of the resource (managed by the system)"
},
"items": {
"type": "array",
"description": "Items associated with this workshop (ItemResource[])",
"items": {
"$ref": "#/components/schemas/ItemResource"
}
}
},
"required": [
"id",
"name",
"internal_name",
"backward_compatibility",
"created_at",
"updated_at"
],
"title": "WorkshopResource"
}
},
"responses": {
"AuthenticationException": {
"description": "Unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ValidationException": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"AuthorizationException": {
"description": "Authorization error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ModelNotFoundException": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
}
}
}
}