{ "openapi": "3.1.0", "info": { "title": "Loupe API", "description": "", "version": "1.0.0" }, "servers": [ { "url": "/", "description": "" } ], "paths": { "/api/manager/bookables": { "post": { "operationId": "api_managerbookables_post", "tags": [ "Bookings" ], "responses": { "201": { "description": "Bookable resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Bookable.jsonld-bookable.read_bookable.item.read_bookable.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bookable-bookable.read_bookable.item.read_bookable.item.post" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] } }, "summary": "Creates a Bookable resource.", "description": "Creates a Bookable resource.", "parameters": [], "requestBody": { "description": "The new Bookable resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Bookable-bookable.write_bookable.item.write_bookable.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bookable-bookable.write_bookable.item.write_bookable.item.post" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/bookables/{id}": { "delete": { "operationId": "api_managerbookables_id_delete", "tags": [ "Bookings" ], "responses": { "204": { "description": "Bookable resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Removes the Bookable resource.", "description": "Removes the Bookable resource.", "parameters": [ { "name": "id", "in": "path", "description": "Bookable identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "patch": { "operationId": "api_managerbookables_id_patch", "tags": [ "Bookings" ], "responses": { "200": { "description": "Bookable resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Bookable.jsonld-bookable.read_bookable.item.read_bookable.item.patch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bookable-bookable.read_bookable.item.read_bookable.item.patch" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Updates the Bookable resource.", "description": "Updates the Bookable resource.", "parameters": [ { "name": "id", "in": "path", "description": "Bookable identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated Bookable resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Bookable-bookable.write_bookable.item.write_bookable.item.patch.jsonMergePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bookable-bookable.write_bookable.item.write_bookable.item.patch.jsonMergePatch" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/bookables": { "get": { "operationId": "api_publicbookables_get_collection", "tags": [ "Bookings" ], "responses": { "200": { "description": "Bookable collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Bookable.jsonld-bookable.read_bookable.collection.read_bookable.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Bookable.jsonld-bookable.read_bookable.collection.read_bookable.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bookable-bookable.read_bookable.collection.read_bookable.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of Bookable resources.", "description": "Retrieves the collection of Bookable resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "title", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "bookableType", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "bookableType[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "equipment", "in": "query", "description": "Filter bookables by equipment. Allowed values: table, paperboard, projector, whiteboard, wheelchair_access, power_outlet.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false, "example": "projector" } ], "security": [] } }, "/api/public/bookables/item": { "get": { "operationId": "api_public_bookables_item_get", "tags": [ "Bookings" ], "responses": { "200": { "description": "Bookable resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Bookable.jsonld-bookable.read_bookable.item.read_bookable.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bookable-bookable.read_bookable.item.read_bookable.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a Bookable resource.", "description": "Retrieves a Bookable resource.", "parameters": [], "security": [] } }, "/api/manager/cms-events": { "post": { "operationId": "api_managercms-events_post", "tags": [ "Events" ], "responses": { "201": { "description": "CmsEvent resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.read_cmsevent.item.read_cmsevent.item.post" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] } }, "summary": "Creates a CmsEvent resource.", "description": "Creates a CmsEvent resource.", "parameters": [], "requestBody": { "description": "The new CmsEvent resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.write_cmsevent.item.write_cmsevent.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.write_cmsevent.item.write_cmsevent.item.post" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/cms-events/{id}": { "get": { "operationId": "api_managercms-events_id_get", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEvent resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.read_cmsevent.item.read_cmsevent.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a CmsEvent resource.", "description": "Retrieves a CmsEvent resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsEvent identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "delete": { "operationId": "api_managercms-events_id_delete", "tags": [ "Events" ], "responses": { "204": { "description": "CmsEvent resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Removes the CmsEvent resource.", "description": "Removes the CmsEvent resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsEvent identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "patch": { "operationId": "api_managercms-events_id_patch", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEvent resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.patch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.read_cmsevent.item.read_cmsevent.item.patch" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Updates the CmsEvent resource.", "description": "Updates the CmsEvent resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsEvent identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated CmsEvent resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.write_cmsevent.item.write_cmsevent.item.patch.jsonMergePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.write_cmsevent.item.write_cmsevent.item.patch.jsonMergePatch" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/cms-events": { "get": { "operationId": "api_publiccms-events_get_collection", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEvent collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "CmsEvent.jsonld-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEvent-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of CmsEvent resources.", "description": "Retrieves the collection of CmsEvent resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "categories.id", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "categories.id[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "title", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ], "security": [] } }, "/api/public/cms-events/item": { "get": { "operationId": "api_public_cms_events_item_get", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEvent resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEvent-cmsevent.read_cmsevent.item.read_cmsevent.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a CmsEvent resource.", "description": "Retrieves a CmsEvent resource.", "parameters": [], "security": [] } }, "/api/public/cms-event-categories": { "get": { "operationId": "api_publiccms-event-categories_get_collection", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEventCategory collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "CmsEventCategory.jsonld-cmseventcategory.read_cmseventcategory.collection.read_cmseventcategory.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory.jsonld-cmseventcategory.read_cmseventcategory.collection.read_cmseventcategory.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory-cmseventcategory.read_cmseventcategory.collection.read_cmseventcategory.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of CmsEventCategory resources.", "description": "Retrieves the collection of CmsEventCategory resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "name", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ], "security": [] } }, "/api/public/cms-event-categories/item": { "get": { "operationId": "api_public_cms_event_categories_item_get", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEventCategory resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEventCategory.jsonld-cmseventcategory.read_cmseventcategory.item.read_cmseventcategory.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEventCategory-cmseventcategory.read_cmseventcategory.item.read_cmseventcategory.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a CmsEventCategory resource.", "description": "Retrieves a CmsEventCategory resource.", "parameters": [], "security": [] } }, "/api/manager/cms-event-registrations": { "get": { "operationId": "api_managercms-event-registrations_get_collection", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEventRegistration collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "CmsEventRegistration.jsonld-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventRegistration.jsonld-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventRegistration-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of CmsEventRegistration resources.", "description": "Retrieves the collection of CmsEventRegistration resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "event.id", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "event.id[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "post": { "operationId": "api_managercms-event-registrations_post", "tags": [ "Events" ], "responses": { "201": { "description": "CmsEventRegistration resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] } }, "summary": "Creates a CmsEventRegistration resource.", "description": "Creates a CmsEventRegistration resource.", "parameters": [], "requestBody": { "description": "The new CmsEventRegistration resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration-cmseventregistration.write_cmseventregistration.item.write_cmseventregistration.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration-cmseventregistration.write_cmseventregistration.item.write_cmseventregistration.item.post" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/cms-event-registrations/{id}": { "delete": { "operationId": "api_managercms-event-registrations_id_delete", "tags": [ "Events" ], "responses": { "204": { "description": "CmsEventRegistration resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Removes the CmsEventRegistration resource.", "description": "Removes the CmsEventRegistration resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsEventRegistration identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "patch": { "operationId": "api_managercms-event-registrations_id_patch", "tags": [ "Events" ], "responses": { "200": { "description": "CmsEventRegistration resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Updates the CmsEventRegistration resource.", "description": "Updates the CmsEventRegistration resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsEventRegistration identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated CmsEventRegistration resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration-cmseventregistration.write_cmseventregistration.item.write_cmseventregistration.item.patch.jsonMergePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsEventRegistration-cmseventregistration.write_cmseventregistration.item.write_cmseventregistration.item.patch.jsonMergePatch" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/cms-pages": { "post": { "operationId": "api_managercms-pages_post", "tags": [ "Pages" ], "responses": { "201": { "description": "CmsPage resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsPage.jsonld-cmspage.read_cmspage.item.read_cmspage.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.read_cmspage.item.read_cmspage.item.post" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] } }, "summary": "Creates a CmsPage resource.", "description": "Creates a CmsPage resource.", "parameters": [], "requestBody": { "description": "The new CmsPage resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.write_cmspage.item.write_cmspage.item.post" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.write_cmspage.item.write_cmspage.item.post" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/cms-pages/{id}": { "get": { "operationId": "api_managercms-pages_id_get", "tags": [ "Pages" ], "responses": { "200": { "description": "CmsPage resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsPage.jsonld-cmspage.read_cmspage.item.read_cmspage.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.read_cmspage.item.read_cmspage.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a CmsPage resource.", "description": "Retrieves a CmsPage resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsPage identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "delete": { "operationId": "api_managercms-pages_id_delete", "tags": [ "Pages" ], "responses": { "204": { "description": "CmsPage resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Removes the CmsPage resource.", "description": "Removes the CmsPage resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsPage identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "patch": { "operationId": "api_managercms-pages_id_patch", "tags": [ "Pages" ], "responses": { "200": { "description": "CmsPage resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsPage.jsonld-cmspage.read_cmspage.item.read_cmspage.item.patch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.read_cmspage.item.read_cmspage.item.patch" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Updates the CmsPage resource.", "description": "Updates the CmsPage resource.", "parameters": [ { "name": "id", "in": "path", "description": "CmsPage identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated CmsPage resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.write_cmspage.item.write_cmspage.item.patch.jsonMergePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.write_cmspage.item.write_cmspage.item.patch.jsonMergePatch" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/cms-pages": { "get": { "operationId": "api_publiccms-pages_get_collection", "tags": [ "Pages" ], "responses": { "200": { "description": "CmsPage collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "CmsPage.jsonld-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage.jsonld-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of CmsPage resources.", "description": "Retrieves the collection of CmsPage resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "categories.id", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "categories.id[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "parent.id", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "parent.id[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "title", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "exists[parent]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": false } ], "security": [] } }, "/api/public/cms-pages/item": { "get": { "operationId": "api_public_cms_pages_item_get", "tags": [ "Pages" ], "responses": { "200": { "description": "CmsPage resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsPage.jsonld-cmspage.read_cmspage.item.read_cmspage.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage-cmspage.read_cmspage.item.read_cmspage.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a CmsPage resource.", "description": "Retrieves a CmsPage resource.", "parameters": [], "security": [] } }, "/api/public/cms-page-categories": { "get": { "operationId": "api_publiccms-page-categories_get_collection", "tags": [ "Pages" ], "responses": { "200": { "description": "CmsPageCategory collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "CmsPageCategory.jsonld-cmspagecategory.read_cmspagecategory.collection.read_cmspagecategory.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory.jsonld-cmspagecategory.read_cmspagecategory.collection.read_cmspagecategory.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory-cmspagecategory.read_cmspagecategory.collection.read_cmspagecategory.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of CmsPageCategory resources.", "description": "Retrieves the collection of CmsPageCategory resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "name", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ], "security": [] } }, "/api/public/cms-page-categories/item": { "get": { "operationId": "api_public_cms_page_categories_item_get", "tags": [ "Pages" ], "responses": { "200": { "description": "CmsPageCategory resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/CmsPageCategory.jsonld-cmspagecategory.read_cmspagecategory.item.read_cmspagecategory.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPageCategory-cmspagecategory.read_cmspagecategory.item.read_cmspagecategory.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a CmsPageCategory resource.", "description": "Retrieves a CmsPageCategory resource.", "parameters": [], "security": [] } }, "/api/manager/reservations/{id}": { "delete": { "operationId": "api_managerreservations_id_delete", "tags": [ "Bookings" ], "responses": { "204": { "description": "Reservation resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Removes the Reservation resource.", "description": "Removes the Reservation resource.", "parameters": [ { "name": "id", "in": "path", "description": "Reservation identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "patch": { "operationId": "api_managerreservations_id_patch", "tags": [ "Bookings" ], "responses": { "200": { "description": "Reservation resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Reservation.jsonld-reservation.read_reservation.item.read_reservation.item.patch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Reservation-reservation.read_reservation.item.read_reservation.item.patch" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Updates the Reservation resource.", "description": "Updates the Reservation resource.", "parameters": [ { "name": "id", "in": "path", "description": "Reservation identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated Reservation resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Reservation-reservation.write_reservation.item.write_reservation.item.patch.jsonMergePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Reservation-reservation.write_reservation.item.write_reservation.item.patch.jsonMergePatch" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "get": { "tags": [ "Bookings" ], "summary": "One reservation with its identity, companion count, retained companions and reservation-wide check-in", "operationId": "managerReservationDetail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organization", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reservation row; guests excludes the holder, participantDetails contains retained active companions, checkedInAt applies to the whole reservation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookingsManagerReservation" }, { "required": [ "participantDetails" ], "properties": { "participantDetails": { "description": "Named companions still on the reservation, in the order they were added; withdrawn and anonymized ones are omitted.", "type": "array", "items": { "required": [ "displayName", "identifier", "email" ], "properties": { "displayName": { "description": "Name of the companion's member account; null when unknown or when the reservation's personal data is erased or scheduled for erasure.", "type": "string", "nullable": true }, "identifier": { "description": "Identifier submitted by the holder: an email address or a card number.", "type": "string", "nullable": true }, "email": { "description": "Contact email of the companion.", "type": "string", "nullable": true } }, "type": "object" } } }, "type": "object" } ] } } } }, "401": { "description": "Authentication required" }, "403": { "description": "Organization, permission or module access denied" }, "404": { "description": "Reservation not found in this organization" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/reservations": { "get": { "operationId": "api_publicreservations_get_collection", "tags": [ "Bookings" ], "responses": { "200": { "description": "Reservation collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Reservation.jsonld-reservation.read_reservation.collection.read_reservation.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Reservation.jsonld-reservation.read_reservation.collection.read_reservation.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reservation-reservation.read_reservation.collection.read_reservation.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of Reservation resources.", "description": "Retrieves the collection of Reservation resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "bookable.organization.id", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "bookable.organization.id[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "bookable.organization.slug", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "bookable.organization.slug[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "bookable.id", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "bookable.id[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "validated", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": false }, { "name": "validated[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "boolean" } }, "style": "form", "explode": true }, { "name": "startAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "startAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "startAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "startAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "endAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "endAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "endAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "endAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false } ], "security": [] } }, "/api/manager/threads": { "get": { "operationId": "api_managerthreads_get_collection", "tags": [ "Messages" ], "responses": { "200": { "description": "Thread collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Thread.jsonld-thread.read_thread.collection.read_thread.collection.get_collection collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Thread.jsonld-thread.read_thread.collection.read_thread.collection.get_collection" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Thread-thread.read_thread.collection.read_thread.collection.get_collection" } } } } } }, "summary": "Retrieves the collection of Thread resources.", "description": "Retrieves the collection of Thread resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "token", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "token[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "contactName", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "contactEmail", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "type", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "type[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "acquisition.acquisitionStatus", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": false }, { "name": "acquisition.acquisitionStatus[]", "in": "query", "description": "", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/threads/{id}": { "get": { "operationId": "api_managerthreads_id_get", "tags": [ "Messages" ], "responses": { "200": { "description": "Thread resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Thread.jsonld-thread.read_thread.item.read_thread.item.get" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Thread-thread.read_thread.item.read_thread.item.get" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Retrieves a Thread resource.", "description": "Retrieves a Thread resource.", "parameters": [ { "name": "id", "in": "path", "description": "Thread identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "delete": { "operationId": "api_managerthreads_id_delete", "tags": [ "Messages" ], "responses": { "204": { "description": "Thread resource deleted" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Removes the Thread resource.", "description": "Removes the Thread resource.", "parameters": [ { "name": "id", "in": "path", "description": "Thread identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "patch": { "operationId": "api_managerthreads_id_patch", "tags": [ "Messages" ], "responses": { "200": { "description": "Thread resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Thread.jsonld-thread.read_thread.item.read_thread.item.patch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Thread-thread.read_thread.item.read_thread.item.patch" } } }, "links": [] }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": [] }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": [] } }, "summary": "Updates the Thread resource.", "description": "Updates the Thread resource.", "parameters": [ { "name": "id", "in": "path", "description": "Thread identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ], "requestBody": { "description": "The updated Thread resource", "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Thread-thread.write_thread.item.write_thread.item.patch.jsonMergePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Thread-thread.write_thread.item.write_thread.item.patch.jsonMergePatch" } } }, "required": true }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/organizations/{organizationSlug}/maps/{mapSlug}/affluence/zones": { "get": { "tags": [ "Footfall" ], "summary": "Live occupancy of the affluence zones linked to a map (public)", "operationId": "api_public_map_affluence_zones", "parameters": [ { "name": "organizationSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mapSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Per-zone live occupancy for the map", "content": { "application/json": { "schema": { "description": "Figures are refreshed at most every five minutes.", "required": [ "open", "entries" ], "properties": { "open": { "description": "True when at least one site of the zones linked to this map is open right now.", "type": "boolean" }, "entries": { "description": "One entry per zone linked to a room or building of this map, for sites that are open right now only. Empty while every site is closed.", "type": "array", "items": { "required": [ "mapEntityType", "mapEntityId", "occupancy", "quality", "calculationStatus", "capacity", "percentFull" ], "properties": { "mapEntityType": { "description": "Kind of map element the zone is linked to.", "type": "string", "enum": [ "room", "building" ] }, "mapEntityId": { "description": "Identifier of that room or building inside the map.", "type": "string" }, "occupancy": { "description": "Number of people currently in the zone, or null when it cannot be measured or calculated.", "type": "integer", "nullable": true }, "quality": { "description": "Reliability of the figures, per measure. occupancy is always present; ins and outs are present for zones counted with entry and exit sensors.", "properties": { "occupancy": { "$ref": "#/components/schemas/FootfallMeasureQuality" }, "ins": { "$ref": "#/components/schemas/FootfallMeasureQuality" }, "outs": { "$ref": "#/components/schemas/FootfallMeasureQuality" } }, "type": "object" }, "calculationStatus": { "description": "For a zone calculated from other zones, why no occupancy could be produced: a source has no measurement, or the subtraction gave a negative result. Null otherwise.", "type": "string", "nullable": true, "enum": [ "missing_measurement", "inconsistent" ] }, "capacity": { "description": "Maximum number of people configured for the zone, or null.", "type": "integer", "nullable": true }, "percentFull": { "description": "Occupancy divided by capacity, between 0 and 1. Null without a capacity or an occupancy.", "type": "number", "format": "float", "nullable": true } }, "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Map not found" } }, "security": [] } }, "/api/public/organizations/{slug}/calendar": { "get": { "tags": [ "Organization" ], "summary": "Get library open hours from Alma for a date range", "operationId": "almaLibraryOpenHours", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Open hours payload", "content": { "application/json": { "schema": { "properties": { "openHours": { "properties": { "openHours": { "description": "Open hours of the library over the date range, as returned by Alma, unchanged.", "type": "object", "additionalProperties": true }, "confOpenHours": { "description": "Opening hours configuration of the library, as returned by Alma, unchanged.", "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "No Alma library code configured, or invalid date range" }, "404": { "description": "Organization not found" } }, "deprecated": true, "security": [] } }, "/api/authentication/api-keys": { "get": { "tags": [ "API keys" ], "summary": "List the API keys owned by the authenticated user", "operationId": "authenticationApiKeysList", "responses": { "200": { "description": "API keys (token value is never returned here)", "content": { "application/json": { "schema": { "description": "Every API key of the user, revoked ones included, newest first.", "type": "array", "items": { "$ref": "#/components/schemas/ApiKeysApiKey" } } } } }, "403": { "description": "No authenticated user" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "post": { "tags": [ "API keys" ], "summary": "Create a new API key; the raw token is returned once in the response", "operationId": "authenticationApiKeysCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyDto" } } } }, "responses": { "201": { "description": "API key created; raw token included (shown only once)", "content": { "application/json": { "schema": { "required": [ "id", "label", "token", "createdAt" ], "properties": { "id": { "description": "API key identifier, used to revoke it.", "type": "string", "format": "uuid" }, "label": { "description": "Name given to the key, without surrounding spaces.", "type": "string" }, "token": { "description": "The secret key, 64 hexadecimal characters. It is shown only in this response and cannot be retrieved later, so store it safely.", "type": "string", "pattern": "^[0-9a-f]{64}$" }, "createdAt": { "description": "When the key was created.", "type": "string", "format": "date-time" } }, "type": "object" } } } }, "403": { "description": "No authenticated user" }, "422": { "description": "Missing, blank or too long label" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/authentication/api-keys/{id}": { "delete": { "tags": [ "API keys" ], "summary": "Revoke one of the authenticated user own API keys", "operationId": "authenticationApiKeysRevoke", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "API key revoked (idempotent)" }, "403": { "description": "No authenticated user" }, "404": { "description": "API key not found for this user" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/bookables/{id}/duplicate": { "post": { "tags": [ "Bookings" ], "summary": "Duplicate a bookable, optionally with a new title", "operationId": "duplicateBookable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "title": { "description": "Title for the duplicated bookable; falls back to a default when omitted", "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Bookable duplicated", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Bookable not found" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/bookables/available": { "post": { "tags": [ "Bookings" ], "summary": "Find available bookables for a day or a time range", "operationId": "findAvailableBookables", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "organization" ], "properties": { "organization": { "description": "Organization slug", "type": "string" }, "mode": { "description": "Availability mode; inferred as \"day\" when \"date\" is provided, otherwise \"range\"", "type": "string", "nullable": true, "enum": [ "day", "range" ] }, "date": { "description": "Day to check (YYYY-MM-DD), required for day mode", "type": "string", "format": "date", "nullable": true }, "from": { "description": "Range start, required for range mode", "type": "string", "format": "date-time", "nullable": true }, "to": { "description": "Range end, required for range mode", "type": "string", "format": "date-time", "nullable": true }, "bookableType": { "type": "string", "nullable": true, "enum": [ "room", "equipment" ] }, "equipment": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "List of available bookables", "content": { "application/json": { "schema": { "description": "Bookables available for the requested day or range; empty for a past day", "type": "array", "items": { "$ref": "#/components/schemas/BookingsBookable" } } } } }, "400": { "description": "Missing or invalid date/range, type, or equipment" }, "404": { "description": "Organization not found" } }, "security": [] } }, "/api/public/bookables/{id}/closures": { "get": { "tags": [ "Bookings" ], "summary": "List slot closures for a published bookable within a range", "operationId": "listPublicBookableClosures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Closures overlapping the requested range, ordered by start", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookingsSlotClosure" } } } } }, "400": { "description": "Missing \"from\" or \"to\" query parameter" }, "404": { "description": "Bookable not found or not published" } }, "security": [] } }, "/api/manager/bookables/{id}/closures": { "get": { "tags": [ "Bookings" ], "summary": "List slot closures for a bookable within a range", "operationId": "listBookableClosures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Closures overlapping the requested range, ordered by start", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookingsSlotClosure" } } } } }, "400": { "description": "Missing \"from\" or \"to\" query parameter" }, "403": { "description": "Bookable of another organization, or missing bookables.read permission" }, "404": { "description": "Bookable not found" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] }, "post": { "tags": [ "Bookings" ], "summary": "Create a slot closure for a bookable", "operationId": "createBookableClosure", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "startAt", "endAt" ], "properties": { "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "responses": { "201": { "description": "Closure created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingsSlotClosure" } } } }, "200": { "description": "Existing matching closure returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingsSlotClosure" } } } }, "400": { "description": "Missing dates or end not after start" }, "404": { "description": "Bookable not found" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/bookables/{id}/closures/batch": { "post": { "tags": [ "Bookings" ], "summary": "Create and/or delete several slot closures in a single request", "operationId": "batchBookableClosures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchBookableClosuresDto" } } } }, "responses": { "200": { "description": "The closures that now exist for the submitted ranges, in submission order; deleted closures are not listed", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookingsSlotClosure" } } } } }, "400": { "description": "A range has end not after start" }, "404": { "description": "Bookable not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/reservations": { "get": { "tags": [ "Bookings" ], "summary": "Manager reservation directory, 25 rows per page", "operationId": "managerReservationsList", "parameters": [ { "name": "organization", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Identity search: snapshot name, linked profile, SIGB fullname or email", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "upcoming", "history", "all" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "bookable", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Inclusive calendar date", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "items, totalItems, page and pageSize; ordered by start then UUID", "content": { "application/json": { "schema": { "required": [ "items", "totalItems", "page", "pageSize" ], "properties": { "items": { "description": "Reservations on this page, ordered by start then identifier.", "type": "array", "items": { "$ref": "#/components/schemas/BookingsManagerReservation" } }, "totalItems": { "description": "Number of reservations matching the filters, across all pages.", "type": "integer" }, "page": { "description": "Current page number.", "type": "integer", "minimum": 1 }, "pageSize": { "description": "Number of reservations per page.", "type": "integer", "enum": [ 25 ] } }, "type": "object" } } } }, "400": { "description": "Invalid filters" }, "401": { "description": "Authentication required" }, "403": { "description": "Organization, permission or module access denied" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/bookables/{id}/reservation": { "post": { "tags": [ "Bookings" ], "summary": "Create a reservation for a bookable", "operationId": "createBookableReservation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationDto" } } } }, "responses": { "200": { "description": "Reservation created", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookingsReservation" }, { "required": [ "token", "reservationLink", "participants" ], "properties": { "token": { "description": "Private token to view or cancel this reservation. Keep it secret.", "type": "string" }, "reservationLink": { "description": "Public page where the holder can view or cancel the reservation.", "type": "string", "format": "uri" }, "participants": { "description": "Named participants added to the reservation; empty when none.", "type": "array", "items": { "$ref": "#/components/schemas/BookingsReservationParticipant" } } }, "type": "object" } ] } } } }, "400": { "description": "Slot unavailable, already reserved, or guests exceed capacity" }, "404": { "description": "Bookable not found or not published" }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/public/bookables/{id}/checkin": { "get": { "tags": [ "Bookings" ], "summary": "Names shown on the on-site check-in page before the patron submits", "operationId": "getBookableCheckInContext", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Bookable title, organization name and calendar type", "content": { "application/json": { "schema": { "required": [ "bookableTitle", "organizationName", "calendarType" ], "properties": { "bookableTitle": { "description": "Bookable title in the request locale.", "type": "string" }, "organizationName": { "description": "Name of the library.", "type": "string" }, "calendarType": { "description": "Whether reservations cover whole days or time slots.", "type": "string", "enum": [ "day", "slot" ] } }, "type": "object" } } } }, "404": { "description": "Bookable not found, not published, or check-in disabled" } }, "security": [] }, "post": { "tags": [ "Bookings" ], "summary": "Check in to a reservation on-site by scanning the printed QR code", "operationId": "checkInBookableReservation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckInReservationDto" } } } }, "responses": { "200": { "description": "Reservation checked in (a repeated check-in returns the same reservation)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingsReservation" } } } }, "400": { "description": "Too far from the venue, no open reservation, deadline missed (reservation_expired), or check-in not configured" }, "404": { "description": "Bookable not found, not published, or check-in disabled" }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/manager/reservations/{id}/validate": { "post": { "tags": [ "Bookings" ], "summary": "Validate a reservation, optionally reassigning it to another bookable", "operationId": "validateReservation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "newBookable": { "description": "Id of a bookable to reassign the reservation to before validating", "type": "string", "format": "uuid", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Reservation validated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingsReservation" } } } }, "400": { "description": "Target bookable not found or slot already reserved" }, "404": { "description": "Reservation not found" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/reservations/{id}/cancel": { "post": { "tags": [ "Bookings" ], "summary": "Cancel a reservation as a manager", "operationId": "cancelReservation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelReservationDto" } } } }, "responses": { "204": { "description": "Reservation cancelled" }, "404": { "description": "Reservation not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/reservations/view": { "get": { "tags": [ "Bookings" ], "summary": "View a reservation by its public token", "operationId": "viewReservationByToken", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reservation found", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookingsReservation" }, { "required": [ "participants", "groupIncomplete", "participantMinimum" ], "properties": { "participants": { "description": "Named participants still on the reservation; withdrawn and anonymized ones are omitted.", "type": "array", "items": { "$ref": "#/components/schemas/BookingsReservationParticipant" } }, "groupIncomplete": { "description": "True when the group is below the minimum number of participants required at booking time.", "type": "boolean" }, "participantMinimum": { "description": "Minimum number of people, holder included, required when the reservation was made; null when no minimum applies.", "type": "integer", "nullable": true } }, "type": "object" } ] } } } }, "400": { "description": "Token is required" }, "404": { "description": "Reservation not found" } }, "security": [] } }, "/api/public/reservations/cancel": { "post": { "tags": [ "Bookings" ], "summary": "Cancel a reservation by its public token", "operationId": "cancelReservationByToken", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Reservation cancelled (or already cancelled)" }, "400": { "description": "Token is required" }, "404": { "description": "Reservation not found" } }, "security": [] } }, "/api/public/reservations/participants": { "post": { "tags": [ "Bookings" ], "summary": "Complete a reservation group as its authenticated holder", "operationId": "addReservationParticipants", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddReservationParticipantsDto" } } } }, "responses": { "204": { "description": "Participants added" }, "400": { "description": "Eligibility, quota or capacity refusal" }, "403": { "description": "Not the holder" }, "404": { "description": "Reservation unavailable" } }, "security": [] } }, "/api/public/bookables/{id}/participants/validate": { "post": { "tags": [ "Bookings" ], "summary": "Check named participants without creating a reservation or sending mail", "operationId": "validateReservationParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "organization", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateReservationParticipantsDto" } } } }, "responses": { "200": { "description": "Email eligibility only; no profile or usage counts", "content": { "application/json": { "schema": { "required": [ "participants" ], "properties": { "participants": { "description": "One result per submitted participant, in submission order.", "type": "array", "items": { "required": [ "email", "reason" ], "properties": { "email": { "description": "The submitted value, trimmed; email addresses are lowercased.", "type": "string" }, "reason": { "description": "Why this participant cannot be added, or null when eligible. A missing and a deactivated account share participant_account_required.", "type": "string", "nullable": true, "enum": [ "participant_duplicated", "participant_account_required", "participant_card_invalid", "participant_quota_exceeded", "participant_directory_unavailable", "participant_contact_required" ] } }, "type": "object" } } }, "type": "object" } } } }, "403": { "description": "Authenticated member or organization staff required" }, "404": { "description": "Unavailable resource or feature" }, "422": { "description": "Invalid list" }, "429": { "description": "Retry later" } }, "security": [] } }, "/api/manager/cms-events/{id}/duplicate": { "post": { "tags": [ "Events" ], "summary": "Duplicate a CMS event", "operationId": "duplicateCmsEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Event duplicated", "content": { "application/json": { "schema": { "required": [ "id", "slug" ], "properties": { "id": { "description": "Identifier of the new event copy.", "type": "string", "format": "uuid" }, "slug": { "description": "URL slug of the new event copy.", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Event not found" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/cms-events/{id}/register": { "post": { "tags": [ "Events" ], "summary": "Register a participant to a CMS event", "operationId": "registerToCmsEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationDto" } } } }, "responses": { "200": { "description": "Registration created", "content": { "application/json": { "schema": { "required": [ "message", "token" ], "properties": { "message": { "description": "Always \"ok\" on success.", "type": "string", "enum": [ "ok" ] }, "token": { "description": "Private registration token. It identifies this registration in the link used to view or cancel it, so keep it secret.", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Registration disabled, capacity exceeded, or already registered" }, "404": { "description": "Event not found" }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/manager/cms-events/{id}/cancel": { "post": { "tags": [ "Events" ], "summary": "Cancel a CMS event and notify its participants", "operationId": "cancelCmsEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelCmsEventDto" } } } }, "responses": { "204": { "description": "Event cancelled" }, "404": { "description": "Event not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/cms-events/{id}/notify-participants": { "post": { "tags": [ "Events" ], "summary": "Send an email notification to all active participants of a CMS event", "operationId": "notifyCmsEventParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsEventParticipantsMailDto" } } } }, "responses": { "200": { "description": "Notification sent", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "description": "Always \"ok\" on success.", "type": "string", "enum": [ "ok" ] } }, "type": "object" } } } }, "404": { "description": "Event not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/cms-event-registrations/{id}/cancel": { "post": { "tags": [ "Events" ], "summary": "Cancel a CMS event registration and notify the participant", "operationId": "cancelCmsEventRegistration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelCmsEventRegistrationDto" } } } }, "responses": { "204": { "description": "Registration cancelled" }, "404": { "description": "Registration not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/cms-pages/{id}/duplicate": { "post": { "tags": [ "Pages" ], "summary": "Duplicate a CMS page", "operationId": "duplicateCmsPage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Page duplicated", "content": { "application/json": { "schema": { "required": [ "id", "slug" ], "properties": { "id": { "description": "Identifier of the new page copy.", "type": "string", "format": "uuid" }, "slug": { "description": "URL slug of the new page copy.", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Page not found" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/cms-page-tree": { "get": { "tags": [ "Pages" ], "summary": "Published page navigation without draft metadata", "operationId": "publicPageTree", "parameters": [ { "name": "organization", "in": "query", "description": "Slug of the organization whose pages are listed.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Published page navigation summaries", "content": { "application/json": { "schema": { "required": [ "items" ], "properties": { "items": { "description": "Every published page of the organization, oldest first. Rebuild the tree from parentId.", "type": "array", "items": { "$ref": "#/components/schemas/PagesPublicPageTreeItem" } } }, "type": "object" } } } } }, "security": [] } }, "/api/public/ils/genres": { "get": { "tags": [ "Catalogue" ], "summary": "List the top catalog genres available for an organization", "operationId": "ilsGenres", "parameters": [ { "name": "organization", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1 } } ], "responses": { "200": { "description": "Catalog genres", "content": { "application/json": { "schema": { "properties": { "result": { "properties": { "genres": { "description": "Most frequent genres in the catalog, most frequent first.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogueFacetValue" } } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } }, "security": [] } }, "/api/public/ils/types": { "get": { "tags": [ "Catalogue" ], "summary": "List the top Loupe catalog types available for an organization", "operationId": "ilsTypes", "parameters": [ { "name": "organization", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1 } } ], "responses": { "200": { "description": "Catalog types", "content": { "application/json": { "schema": { "properties": { "result": { "properties": { "types": { "description": "Most frequent document types in the catalog, most frequent first.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogueFacetValue" } } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } }, "security": [] } }, "/api/public/organizations/{slug}/ils/locations": { "get": { "tags": [ "Organization" ], "summary": "The SIGB location directory of an organization, for the public maps", "operationId": "publicIlsLocations", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Locations with their stable locationRef, library and access mode", "content": { "application/json": { "schema": { "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogueLocation" } } }, "type": "object" } } } }, "404": { "description": "Organization not found or Catalog module disabled" } }, "security": [] } }, "/api/public/organizations/{slug}/opening-calendar": { "get": { "tags": [ "Organization" ], "summary": "Project effective organization opening hours over a date range", "operationId": "publicOrganizationOpeningCalendarProjection", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Inclusive effective calendar projection", "content": { "application/json": { "schema": { "properties": { "managementMode": { "description": "Where the opening hours come from: manual (managed in Loupe), ils (synchronized from the library system), ils_hours (regular hours synchronized, exceptions managed in Loupe) or ils_exceptions (exceptions synchronized, regular hours managed in Loupe).", "type": "string", "enum": [ "manual", "ils", "ils_hours", "ils_exceptions" ] }, "providerKey": { "description": "Library system the calendar is synchronized from, when configured.", "type": "string", "nullable": true }, "sourceId": { "description": "Calendar identifier in the library system, when configured.", "type": "string", "nullable": true }, "enabledFrom": { "description": "First date the synchronized calendar applies to.", "type": "string", "format": "date", "nullable": true }, "days": { "description": "One entry per day from the from date to the to date, inclusive.", "type": "array", "items": { "$ref": "#/components/schemas/OrganizationOpeningCalendarDay" } } }, "type": "object" } } } }, "400": { "description": "Invalid or oversized date range" } }, "security": [] } }, "/api/public/ils/browse": { "post": { "tags": [ "Catalogue" ], "summary": "Structured catalog listing (novelties by type/library, recency-sorted) \u2014 no keywords, no relevance ranking", "operationId": "ilsBrowse", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IlsBrowseDto" } } } }, "responses": { "200": { "description": "Catalog listing", "content": { "application/json": { "schema": { "properties": { "result": { "properties": { "engine": { "description": "Always browse for this endpoint.", "type": "string", "enum": [ "browse" ] }, "totalItems": { "description": "Number of records matching the listing.", "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "items": { "description": "Records of the requested page, most recent first.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogueRecord" } } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/public/ils/search": { "post": { "tags": [ "Catalogue" ], "summary": "Search the library catalog (ILS)", "operationId": "ilsSearch", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IlsSearchDto" } } } }, "responses": { "200": { "description": "Search results", "content": { "application/json": { "schema": { "properties": { "result": { "properties": { "provider": { "description": "Library system of the organization, for example alma, rero or netbiblio.", "type": "string" }, "engine": { "description": "How the results were found: rag (semantic search in the Loupe index), lexical (keyword search in the Loupe index), live (search in the library system) or browse (structured listing).", "type": "string", "enum": [ "rag", "lexical", "live", "browse" ] }, "confidence": { "description": "How well the results answer the query: strong (clear match), weak (closest approximations) or none (nothing relevant). Null when the results come straight from the library system.", "type": "string", "nullable": true, "enum": [ "strong", "weak", "none" ] }, "outcome": { "description": "results or empty for a completed search, unresolved when some filters could not be applied, source_unavailable when the catalog could not be reached.", "type": "string", "enum": [ "results", "empty", "unresolved", "source_unavailable" ] }, "fallbackReason": { "description": "Why the search used another engine than the preferred one, for example index_not_ready, no_relevant_index_match or live_unavailable. Null when no fallback happened.", "type": "string", "nullable": true }, "unresolvedConstraints": { "description": "Filter families that could not be applied on the selected source.", "type": "array", "items": { "type": "string" } }, "totalItems": { "description": "Number of matching records.", "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "items": { "description": "Records of the requested page.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogueRecord" } }, "facets": { "description": "Filters available on the results, with counts.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogueFacet" } } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/public/ils/item": { "post": { "tags": [ "Catalogue" ], "summary": "Fetch a single catalog item by ID (ILS)", "operationId": "ilsItem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IlsItemDto" } } } }, "responses": { "200": { "description": "Catalog item", "content": { "application/json": { "schema": { "properties": { "result": { "properties": { "provider": { "description": "Library system of the organization, for example alma, rero or netbiblio.", "type": "string" }, "item": { "$ref": "#/components/schemas/CatalogueRecord" } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/public/ils/items": { "post": { "tags": [ "Catalogue" ], "summary": "Fetch multiple catalog items by ID (ILS)", "operationId": "ilsItems", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IlsItemsDto" } } } }, "responses": { "200": { "description": "Catalog items", "content": { "application/json": { "schema": { "properties": { "result": { "properties": { "provider": { "description": "Library system of the organization, for example alma, rero or netbiblio.", "type": "string" }, "items": { "description": "Records found for the requested identifiers, at most 50 per request.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogueRecord" } } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/public/organizations/{organizationSlug}/maps/{mapSlug}": { "get": { "tags": [ "Maps" ], "summary": "Get the public definition of a map by slug", "operationId": "getMapDefinition", "parameters": [ { "name": "organizationSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mapSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wire", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "prototype-v1", "regional-v15" ] } } ], "responses": { "200": { "description": "Map definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapsMapDefinition" } } } }, "404": { "description": "Map not found" } }, "security": [] } }, "/api/public/organizations/{organizationSlug}/maps/{mapSlug}/layers/{layerId}": { "get": { "tags": [ "Maps" ], "summary": "Get one thematic layer of a public map", "description": "Returns the same document as the full map definition, restricted to one layer: its layers list holds only the requested layer, and only the labels and tours of that layer are kept.", "operationId": "getMapLayerDefinition", "parameters": [ { "name": "organizationSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mapSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "layerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wire", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "prototype-v1", "regional-v15" ] } } ], "responses": { "200": { "description": "Projected map definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapsMapDefinition" } } } }, "404": { "description": "Map or layer not found" } }, "security": [] } }, "/api/public/organizations/{organizationSlug}/map-places": { "get": { "tags": [ "Maps" ], "summary": "Search the named public places of an organization's maps", "operationId": "searchPublicMapPlaces", "parameters": [ { "name": "organizationSlug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 2 } }, { "name": "mapSlug", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "layerId", "in": "query", "required": false, "schema": { "type": "string", "default": "default" } }, { "name": "storey", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "types[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "legend", "room", "object", "box" ] } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 8, "maximum": 20, "minimum": 1 } } ], "responses": { "200": { "description": "Ranked public map places", "content": { "application/json": { "schema": { "required": [ "query", "total", "returned", "places" ], "properties": { "query": { "description": "The search text, trimmed.", "type": "string" }, "total": { "description": "Number of matching places before the limit is applied.", "type": "integer" }, "returned": { "description": "Number of places in this response.", "type": "integer" }, "places": { "description": "Matching places, best match first.", "type": "array", "items": { "$ref": "#/components/schemas/MapsPublicMapPlace" } } }, "type": "object" } } } }, "400": { "description": "Missing or too-short query" }, "403": { "description": "The map module is not enabled" }, "404": { "description": "Unknown organization" } }, "security": [] } }, "/api/public/organizations/{organizationSlug}/maps/{mapSlug}/renderer-errors": { "post": { "tags": [ "Maps" ], "summary": "Report a browser GPU failure on a public map", "operationId": "publicMapRendererError", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapRendererErrorDto" } } } }, "responses": { "204": { "description": "Diagnostic recorded" }, "404": { "description": "Map not public" }, "422": { "description": "Invalid diagnostic" }, "429": { "description": "Rate limited" } }, "security": [] } }, "/api/public/threads/acquisitions/precheck": { "post": { "tags": [ "Messages" ], "summary": "Check whether a suggested document is already held or already suggested", "operationId": "publicPrecheckAcquisition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrecheckAcquisitionDto" } } } }, "responses": { "200": { "description": "Pre-check result", "content": { "application/json": { "schema": { "properties": { "catalogMatch": { "oneOf": [ { "$ref": "#/components/schemas/MessagesAcquisitionCatalogMatch" } ], "nullable": true }, "openSuggestion": { "description": "Present when an open suggestion for the same document already exists. Null otherwise.", "properties": { "exists": { "type": "boolean", "enum": [ true ] }, "acquisitionStatus": { "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved" ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "nullable": true } }, "type": "object" } } } }, "400": { "description": "Missing organization or search criteria" } }, "security": [] } }, "/api/manager/threads/acquisitions/precheck": { "post": { "tags": [ "Messages" ], "summary": "Dedup pre-check against the selected organization catalog and open suggestions", "operationId": "managerPrecheckAcquisition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrecheckAcquisitionDto" } } } }, "responses": { "200": { "description": "Pre-check result", "content": { "application/json": { "schema": { "properties": { "catalogMatch": { "oneOf": [ { "$ref": "#/components/schemas/MessagesAcquisitionCatalogMatch" } ], "nullable": true }, "openSuggestion": { "description": "Present when an open suggestion for the same document already exists. Null otherwise.", "properties": { "exists": { "type": "boolean", "enum": [ true ] }, "threadId": { "description": "Thread of the existing suggestion.", "type": "string", "format": "uuid" }, "title": { "description": "Title of the existing suggestion.", "type": "string" }, "acquisitionStatus": { "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved" ] }, "createdAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "nullable": true } }, "type": "object" } } } }, "400": { "description": "Missing search criteria" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/threads/acquisitions/start": { "post": { "tags": [ "Messages" ], "summary": "Suggest a purchase as a public user (creates an acquisition thread)", "operationId": "publicStartAcquisitionThread", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartAcquisitionThreadDto" } } } }, "responses": { "201": { "description": "Acquisition thread created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesPublicThread" } } } }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/manager/threads/acquisitions/convert": { "post": { "tags": [ "Messages" ], "summary": "Convert a general thread into an acquisition request", "operationId": "convertThreadToAcquisition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertThreadToAcquisitionDto" } } } }, "responses": { "200": { "description": "Thread converted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesManagerThread" } } } }, "400": { "description": "Thread is already an acquisition request" }, "409": { "description": "Thread version conflict" }, "428": { "description": "If-Match header required" }, "404": { "description": "Thread not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/threads/acquisitions/revert": { "post": { "tags": [ "Messages" ], "summary": "Turn an acquisition request back into a general thread", "operationId": "revertAcquisitionToThread", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertThreadToMessageDto" } } } }, "responses": { "200": { "description": "Thread reverted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesManagerThread" } } } }, "400": { "description": "Thread is not an acquisition request" }, "409": { "description": "Thread version conflict" }, "428": { "description": "If-Match header required" }, "404": { "description": "Thread not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/threads/acquisitions/update": { "post": { "tags": [ "Messages" ], "summary": "Edit the bibliographic fields of an acquisition request", "operationId": "updateThreadAcquisition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAcquisitionDto" } } } }, "responses": { "200": { "description": "Acquisition updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesManagerThread" } } } }, "400": { "description": "Thread is not an acquisition request" }, "409": { "description": "Thread version conflict" }, "428": { "description": "If-Match header required" }, "404": { "description": "Thread not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/threads/acquisitions/decide": { "post": { "tags": [ "Messages" ], "summary": "Move an acquisition request through its decision workflow", "operationId": "decideThreadAcquisition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideAcquisitionDto" } } } }, "responses": { "200": { "description": "Decision recorded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesManagerThread" } } } }, "400": { "description": "Invalid transition or missing reason/reference" }, "409": { "description": "Thread version conflict" }, "428": { "description": "If-Match header required" }, "404": { "description": "Thread not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/threads/token/{token}": { "get": { "tags": [ "Messages" ], "summary": "Get a message thread by its public token", "operationId": "getThreadByToken", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Thread found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesPublicThread" } } } }, "404": { "description": "Thread not found" } }, "security": [] } }, "/api/public/threads/reply": { "post": { "tags": [ "Messages" ], "summary": "Reply to a message thread as a public user", "operationId": "publicReplyThread", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicReplyThreadDto" } } } }, "responses": { "200": { "description": "Reply posted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesPublicThread" } } } }, "404": { "description": "Thread not found" }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/manager/threads/reply": { "post": { "tags": [ "Messages" ], "summary": "Reply to a message thread as a manager", "operationId": "managerReplyThread", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagerReplyThreadDto" } } } }, "responses": { "200": { "description": "Reply posted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesManagerThread" } } } }, "404": { "description": "Thread not found" }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/threads/start": { "post": { "tags": [ "Messages" ], "summary": "Start a message thread as a manager", "operationId": "managerStartThread", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagerStartThreadDto" } } } }, "responses": { "201": { "description": "Thread created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesManagerThread" } } } }, "422": { "description": "Validation failed" } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/public/threads/start": { "post": { "tags": [ "Messages" ], "summary": "Start a message thread as a public user", "operationId": "publicStartThread", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartThreadDto" } } } }, "responses": { "201": { "description": "Thread created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesPublicThread" } } } }, "422": { "description": "Validation failed" } }, "security": [] } }, "/api/public/organizations/{slug}": { "get": { "tags": [ "Organization" ], "summary": "Get an organization and its settings by slug", "operationId": "getPublicOrganization", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organization found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationPublic" } } } }, "404": { "description": "Organization not found" } }, "security": [] } }, "/api/manager/statistics/bookables": { "get": { "tags": [ "Bookings" ], "summary": "Aggregated bookable and reservation statistics", "operationId": "getBookablesStatistics", "parameters": [ { "name": "organization", "in": "query", "description": "Organization slug (administrators only; defaults to caller organization)", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First day of the period, included (YYYY-MM-DD). Without it, the period has no start.", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day of the period, included (YYYY-MM-DD). Without it, the period has no end.", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Bookable and reservation statistics", "content": { "application/json": { "schema": { "required": [ "organization", "bookables", "reservations", "topBookablesByReservations" ], "properties": { "organization": { "description": "Organization the statistics belong to.", "required": [ "id", "slug", "name" ], "properties": { "id": { "description": "Organization identifier.", "type": "string", "format": "uuid" }, "slug": { "description": "Organization slug.", "type": "string" }, "name": { "description": "Organization name.", "type": "string" } }, "type": "object" }, "bookables": { "description": "Bookable counts, independent of any period.", "required": [ "total", "published", "unpublished" ], "properties": { "total": { "description": "All bookables.", "type": "integer" }, "published": { "description": "Published bookables.", "type": "integer" }, "unpublished": { "description": "Unpublished bookables.", "type": "integer" } }, "type": "object" }, "reservations": { "description": "Reservation counts. When a period is given, only reservations starting within it are counted.", "required": [ "total", "validated", "pending", "cancelled", "averagePerBookable" ], "properties": { "total": { "description": "All reservations, including cancelled ones.", "type": "integer" }, "validated": { "description": "Approved reservations that are not cancelled.", "type": "integer" }, "pending": { "description": "Reservations awaiting approval, not cancelled.", "type": "integer" }, "cancelled": { "description": "Cancelled reservations.", "type": "integer" }, "averagePerBookable": { "description": "Reservations divided by the number of bookables, rounded to two decimals; 0 when there is no bookable.", "type": "number", "format": "float" } }, "type": "object" }, "topBookablesByReservations": { "description": "Every bookable with its reservation count over the period, most reserved first, then by title.", "type": "array", "items": { "required": [ "id", "title", "slug", "isPublished", "reservations" ], "properties": { "id": { "description": "Bookable identifier.", "type": "string", "format": "uuid" }, "title": { "description": "Bookable title.", "type": "string" }, "slug": { "description": "Bookable slug.", "type": "string" }, "isPublished": { "description": "Whether the bookable is published.", "type": "boolean" }, "reservations": { "description": "Reservations over the period, cancelled ones included; 0 when none.", "type": "integer" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } }, "/api/manager/statistics/cms-events": { "get": { "tags": [ "Events" ], "summary": "Aggregated CMS event and registration statistics", "operationId": "getCmsEventsStatistics", "parameters": [ { "name": "organization", "in": "query", "description": "Organization slug (administrators only; defaults to caller organization)", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First day of the period, included (YYYY-MM-DD). Without it, the period has no start.", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day of the period, included (YYYY-MM-DD). Without it, the period has no end.", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "CMS event and registration statistics", "content": { "application/json": { "schema": { "required": [ "organization", "events", "registrations", "attendance" ], "properties": { "organization": { "description": "Organization the statistics belong to.", "required": [ "id", "slug", "name" ], "properties": { "id": { "description": "Organization identifier.", "type": "string", "format": "uuid" }, "slug": { "description": "Organization slug.", "type": "string" }, "name": { "description": "Organization name.", "type": "string" } }, "type": "object" }, "events": { "description": "Event counts. When a period is given, only events starting within it are counted.", "required": [ "total", "published", "unpublished", "cancelled" ], "properties": { "total": { "description": "All events.", "type": "integer" }, "published": { "description": "Published events.", "type": "integer" }, "unpublished": { "description": "Unpublished events.", "type": "integer" }, "cancelled": { "description": "Cancelled events, whether published or not.", "type": "integer" } }, "type": "object" }, "registrations": { "description": "Registrations to the counted events.", "required": [ "total", "active", "cancelled", "averageGuests" ], "properties": { "total": { "description": "All registrations, including cancelled ones.", "type": "integer" }, "active": { "description": "Registrations that are not cancelled.", "type": "integer" }, "cancelled": { "description": "Cancelled registrations.", "type": "integer" }, "averageGuests": { "description": "Average number of guests per registration, rounded to two decimals; 0 when there is no registration.", "type": "number", "format": "float" } }, "type": "object" }, "attendance": { "description": "Actual attendance, for events whose headcount was recorded after the event.", "required": [ "reportedEvents", "totalAttendees", "expectedAttendees" ], "properties": { "reportedEvents": { "description": "Events with a recorded headcount.", "type": "integer" }, "totalAttendees": { "description": "Sum of the recorded headcounts.", "type": "integer" }, "expectedAttendees": { "description": "Active registrants plus their guests for those same events, to compare with the actual attendance.", "type": "integer" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "ApiKey": [] }, { "JWT": [] } ] } } }, "components": { "schemas": { "Bookable-bookable.read_bookable.collection.read_bookable.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-bookable.read_bookable.collection.read_bookable.collection.get_collection" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] }, "Bookable-bookable.read_bookable.item.read_bookable.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-bookable.read_bookable.item.read_bookable.item.get" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] }, "Bookable-bookable.read_bookable.item.read_bookable.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-bookable.read_bookable.item.read_bookable.item.patch" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] }, "Bookable-bookable.read_bookable.item.read_bookable.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-bookable.read_bookable.item.read_bookable.item.post" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] }, "Bookable-bookable.write_bookable.item.write_bookable.item.patch.jsonMergePatch": { "type": "object", "properties": { "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } } }, "Bookable-bookable.write_bookable.item.write_bookable.item.post": { "type": "object", "properties": { "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] }, "Bookable.jsonld-bookable.read_bookable.collection.read_bookable.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-bookable.read_bookable.collection.read_bookable.collection.get_collection" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] } ] }, "Bookable.jsonld-bookable.read_bookable.item.read_bookable.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-bookable.read_bookable.item.read_bookable.item.get" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] } ] }, "Bookable.jsonld-bookable.read_bookable.item.read_bookable.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-bookable.read_bookable.item.read_bookable.item.patch" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] } ] }, "Bookable.jsonld-bookable.read_bookable.item.read_bookable.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-bookable.read_bookable.item.read_bookable.item.post" }, { "type": "null" } ] }, "photos": { "description": "Additional photo file UUIDs, in display order.", "type": "array", "items": { "type": "string" } }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "bookableType": { "default": "room", "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "default": "slot", "type": "string", "enum": [ "day", "slot" ] }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "autoValidate": { "default": false, "type": "boolean" }, "enableCheckIn": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "requireParticipantAccounts": { "description": "Sub-requirement of membersOnly: every additional participant must be\nidentified by an active patron account of the organization. Inert\nunless membersOnly is true AND patron-account access is enabled \u2014 no\ncross-field constraint on purpose, mirroring how a disabled module\nmakes membersOnly itself inert.", "default": false, "type": "boolean" }, "countParticipantQuota": { "default": true, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "capacity": { "type": [ "integer", "null" ] }, "slotSize": { "enum": [ 15, 30, 60 ], "description": "Contain the size time of a single defined slot (in minutes), only if applicable (range)", "type": [ "integer", "null" ] }, "maxSlotPerReservation": { "description": "Contain the number of slot that can be reserved in a single process, only if applicable (range)", "type": [ "integer", "null" ] }, "minSlotPerReservation": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "type": [ "integer", "null" ] }, "leadTimeAmount": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 365, "description": "Minimum delay before a reservation may start; the unit decides the\nsemantics (rolling hours, or calendar days at midnight org-time).", "type": [ "integer", "null" ] }, "leadTimeUnit": { "type": [ "string", "null" ], "enum": [ "hours", "days", null ] }, "maxAdvanceDays": { "minimum": 0, "exclusiveMinimum": 0, "maximum": 730, "description": "Booking horizon: the last reservable day is today + maxAdvanceDays\n(calendar days, organization timezone). Null means unlimited.", "type": [ "integer", "null" ] }, "minParticipants": { "minimum": 0, "exclusiveMinimum": 0, "description": "Minimum total participants, holder included (a group room may require\n2). Declarative: enforced against the declared guests count only.", "type": [ "integer", "null" ] }, "equipments": { "type": [ "array", "null" ], "items": { "type": "string" } }, "settings": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } } }, "required": [ "slug" ] } ] }, "CmsEvent-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] }, "CmsEvent-cmsevent.read_cmsevent.item.read_cmsevent.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmsevent.read_cmsevent.item.read_cmsevent.item.get" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory-cmsevent.read_cmsevent.item.read_cmsevent.item.get" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] }, "CmsEvent-cmsevent.read_cmsevent.item.read_cmsevent.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmsevent.read_cmsevent.item.read_cmsevent.item.patch" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory-cmsevent.read_cmsevent.item.read_cmsevent.item.patch" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] }, "CmsEvent-cmsevent.read_cmsevent.item.read_cmsevent.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmsevent.read_cmsevent.item.read_cmsevent.item.post" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory-cmsevent.read_cmsevent.item.read_cmsevent.item.post" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] }, "CmsEvent-cmsevent.write_cmsevent.item.write_cmsevent.item.patch.jsonMergePatch": { "type": "object", "properties": { "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMap": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "iri-reference", "example": "https://example.com/" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] } } }, "CmsEvent-cmsevent.write_cmsevent.item.write_cmsevent.item.post": { "type": "object", "properties": { "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMap": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "iri-reference", "example": "https://example.com/" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] } }, "required": [ "slug", "isPublished" ] }, "CmsEvent-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "CmsEvent-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "CmsEvent-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "CmsEvent.jsonld-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory.jsonld-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] } ] }, "CmsEvent.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.get" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.get" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] } ] }, "CmsEvent.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.patch" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.patch" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] } ] }, "CmsEvent.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.post" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "titleFont": { "default": "syne", "type": "string", "enum": [ "geist", "anton", "oswald", "poppins", "hahmlet", "manrope", "playfair_display", "archivo", "raleway", "bebas_neue", "archivo_black", "league_gothic", "barlow_condensed", "big_shoulders_display", "unbounded", "syne", "dela_gothic_one", "bricolage_grotesque", "six_caps", "anybody", "climate_crisis", "fraunces", "instrument_serif", "dm_serif_display", "cormorant_garamond", "bodoni_moda", "abril_fatface", "italiana", "alfa_slab_one", "bowlby_one", "yesteryear", "sans", "editorial", "display", "mono" ] }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "startAt": { "type": [ "string", "null" ], "format": "date-time" }, "endAt": { "type": [ "string", "null" ], "format": "date-time" }, "locationName": { "type": [ "string", "null" ] }, "locationUrl": { "type": [ "string", "null" ] }, "onlineUrl": { "type": [ "string", "null" ] }, "locationType": { "default": "none", "type": "string", "enum": [ "none", "free", "address", "map" ] }, "locationLatitude": { "type": [ "number", "null" ] }, "locationLongitude": { "type": [ "number", "null" ] }, "locationAddress": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "locationMapPoint": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "speakers": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsEventCategory.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.post" } }, "enableRegistration": { "default": false, "type": "boolean" }, "enableEmailRegistration": { "default": false, "type": "boolean" }, "membersOnly": { "default": false, "type": "boolean" }, "capacityGuests": { "minimum": 0, "default": 0, "type": "integer" }, "capacity": { "type": [ "integer", "null" ] }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "locationMapSlug": { "readOnly": true, "description": "The public runtime loads maps by slug (fetchLoupeMapDefinition), so the\nevent exposes the referenced map's slug instead of embedding the Map.", "type": [ "string", "null" ] } }, "required": [ "slug", "isPublished" ] } ] }, "CmsEvent.jsonld-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "CmsEvent.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "CmsEvent.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "CmsEventCategory-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsEventCategory-cmsevent.read_cmsevent.item.read_cmsevent.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsEventCategory-cmsevent.read_cmsevent.item.read_cmsevent.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsEventCategory-cmsevent.read_cmsevent.item.read_cmsevent.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsEventCategory-cmseventcategory.read_cmseventcategory.collection.read_cmseventcategory.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsEventCategory-cmseventcategory.read_cmseventcategory.item.read_cmseventcategory.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsEventCategory.jsonld-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsEventCategory.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsEventCategory.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsEventCategory.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsEventCategory.jsonld-cmseventcategory.read_cmseventcategory.collection.read_cmseventcategory.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsEventCategory.jsonld-cmseventcategory.read_cmseventcategory.item.read_cmseventcategory.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsEventRegistration-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "event": { "$ref": "#/components/schemas/CmsEvent-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection" }, "token": { "type": "string" }, "user": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" } } }, "CmsEventRegistration-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "event": { "$ref": "#/components/schemas/CmsEvent-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch" }, "token": { "type": "string" }, "user": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" } } }, "CmsEventRegistration-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "event": { "$ref": "#/components/schemas/CmsEvent-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post" }, "token": { "type": "string" }, "user": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" } } }, "CmsEventRegistration-cmseventregistration.write_cmseventregistration.item.write_cmseventregistration.item.patch.jsonMergePatch": { "type": "object" }, "CmsEventRegistration-cmseventregistration.write_cmseventregistration.item.write_cmseventregistration.item.post": { "type": "object" }, "CmsEventRegistration.jsonld-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "event": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmseventregistration.read_cmseventregistration.collection.read_cmseventregistration.collection.get_collection" }, "token": { "type": "string" }, "user": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" } } } ] }, "CmsEventRegistration.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "event": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.patch" }, "token": { "type": "string" }, "user": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" } } } ] }, "CmsEventRegistration.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "event": { "$ref": "#/components/schemas/CmsEvent.jsonld-cmseventregistration.read_cmseventregistration.item.read_cmseventregistration.item.post" }, "token": { "type": "string" }, "user": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" } } } ] }, "CmsPage-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection" } } }, "required": [ "slug" ] }, "CmsPage-cmspage.read_cmspage.item.read_cmspage.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmspage.read_cmspage.item.read_cmspage.item.get" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory-cmspage.read_cmspage.item.read_cmspage.item.get" } } }, "required": [ "slug" ] }, "CmsPage-cmspage.read_cmspage.item.read_cmspage.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmspage.read_cmspage.item.read_cmspage.item.patch" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory-cmspage.read_cmspage.item.read_cmspage.item.patch" } } }, "required": [ "slug" ] }, "CmsPage-cmspage.read_cmspage.item.read_cmspage.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File-cmspage.read_cmspage.item.read_cmspage.item.post" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory-cmspage.read_cmspage.item.read_cmspage.item.post" } } }, "required": [ "slug" ] }, "CmsPage-cmspage.write_cmspage.item.write_cmspage.item.patch.jsonMergePatch": { "type": "object", "properties": { "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "iri-reference", "example": "https://example.com/" } } } }, "CmsPage-cmspage.write_cmspage.item.write_cmspage.item.post": { "type": "object", "properties": { "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "iri-reference", "example": "https://example.com/" } } }, "required": [ "slug" ] }, "CmsPage.jsonld-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory.jsonld-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection" } } }, "required": [ "slug" ] } ] }, "CmsPage.jsonld-cmspage.read_cmspage.item.read_cmspage.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmspage.read_cmspage.item.read_cmspage.item.get" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory.jsonld-cmspage.read_cmspage.item.read_cmspage.item.get" } } }, "required": [ "slug" ] } ] }, "CmsPage.jsonld-cmspage.read_cmspage.item.read_cmspage.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmspage.read_cmspage.item.read_cmspage.item.patch" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory.jsonld-cmspage.read_cmspage.item.read_cmspage.item.patch" } } }, "required": [ "slug" ] } ] }, "CmsPage.jsonld-cmspage.read_cmspage.item.read_cmspage.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "parent": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "anyOf": [ { "$ref": "#/components/schemas/File.jsonld-cmspage.read_cmspage.item.read_cmspage.item.post" }, { "type": "null" } ] }, "coverPositionY": { "minimum": 0, "maximum": 100, "default": 50, "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPublished": { "default": false, "type": "boolean" }, "isAiIndexable": { "default": true, "type": "boolean" }, "content": { "default": "", "type": "string" }, "contentDocument": { "description": "Canonical Tiptap/ProseMirror document; content remains a transition fallback.", "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageCategory.jsonld-cmspage.read_cmspage.item.read_cmspage.item.post" } } }, "required": [ "slug" ] } ] }, "CmsPageCategory-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsPageCategory-cmspage.read_cmspage.item.read_cmspage.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsPageCategory-cmspage.read_cmspage.item.read_cmspage.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsPageCategory-cmspage.read_cmspage.item.read_cmspage.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsPageCategory-cmspagecategory.read_cmspagecategory.collection.read_cmspagecategory.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsPageCategory-cmspagecategory.read_cmspagecategory.item.read_cmspagecategory.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] }, "CmsPageCategory.jsonld-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsPageCategory.jsonld-cmspage.read_cmspage.item.read_cmspage.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsPageCategory.jsonld-cmspage.read_cmspage.item.read_cmspage.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsPageCategory.jsonld-cmspage.read_cmspage.item.read_cmspage.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsPageCategory.jsonld-cmspagecategory.read_cmspagecategory.collection.read_cmspagecategory.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "CmsPageCategory.jsonld-cmspagecategory.read_cmspagecategory.item.read_cmspagecategory.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "cover": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } ] }, "ConstraintViolation": { "type": "object", "description": "Unprocessable entity", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } }, "ConstraintViolation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "Unprocessable entity" }, "Error": { "type": "object", "description": "A representation of common errors.", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" } } }, "Error.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" }, "description": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "A representation of common errors." }, "File-bookable.read_bookable.collection.read_bookable.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-bookable.read_bookable.item.read_bookable.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-bookable.read_bookable.item.read_bookable.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-bookable.read_bookable.item.read_bookable.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmsevent.read_cmsevent.item.read_cmsevent.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmsevent.read_cmsevent.item.read_cmsevent.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmsevent.read_cmsevent.item.read_cmsevent.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmspage.read_cmspage.item.read_cmspage.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmspage.read_cmspage.item.read_cmspage.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File-cmspage.read_cmspage.item.read_cmspage.item.post": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } }, "File.jsonld-bookable.read_bookable.collection.read_bookable.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-bookable.read_bookable.item.read_bookable.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-bookable.read_bookable.item.read_bookable.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-bookable.read_bookable.item.read_bookable.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmsevent.read_cmsevent.collection.read_cmsevent.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmsevent.read_cmsevent.item.read_cmsevent.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmspage.read_cmspage.collection.read_cmspage.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmspage.read_cmspage.item.read_cmspage.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmspage.read_cmspage.item.read_cmspage.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "File.jsonld-cmspage.read_cmspage.item.read_cmspage.item.post": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" } } } ] }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "type": "object", "properties": { "view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "first": { "type": "string", "format": "iri-reference" }, "last": { "type": "string", "format": "iri-reference" }, "previous": { "type": "string", "format": "iri-reference" }, "next": { "type": "string", "format": "iri-reference" } }, "example": { "@id": "string", "@type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "totalItems": { "type": "integer", "minimum": 0 }, "search": { "type": "object", "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "Message-thread.read_thread.item.read_thread.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "name": { "type": [ "string", "null" ] }, "content": { "default": "", "type": "string" }, "kind": { "description": "Reply (public), Note (internal staff-only) or Event (system journal entry).", "default": "reply", "type": "string", "enum": [ "reply", "note", "event" ] }, "metadata": { "description": "Type-specific structured data, staff-only. Notes carry `mentionedUserIds`;\nevents carry `{eventType, fromStatus, toStatus, targetUserId, targetUserName, actorName}`.", "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } } }, "Message-thread.read_thread.item.read_thread.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "name": { "type": [ "string", "null" ] }, "content": { "default": "", "type": "string" }, "kind": { "description": "Reply (public), Note (internal staff-only) or Event (system journal entry).", "default": "reply", "type": "string", "enum": [ "reply", "note", "event" ] }, "metadata": { "description": "Type-specific structured data, staff-only. Notes carry `mentionedUserIds`;\nevents carry `{eventType, fromStatus, toStatus, targetUserId, targetUserName, actorName}`.", "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } } }, "Message.jsonld-thread.read_thread.item.read_thread.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "name": { "type": [ "string", "null" ] }, "content": { "default": "", "type": "string" }, "kind": { "description": "Reply (public), Note (internal staff-only) or Event (system journal entry).", "default": "reply", "type": "string", "enum": [ "reply", "note", "event" ] }, "metadata": { "description": "Type-specific structured data, staff-only. Notes carry `mentionedUserIds`;\nevents carry `{eventType, fromStatus, toStatus, targetUserId, targetUserName, actorName}`.", "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } } } ] }, "Message.jsonld-thread.read_thread.item.read_thread.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "name": { "type": [ "string", "null" ] }, "content": { "default": "", "type": "string" }, "kind": { "description": "Reply (public), Note (internal staff-only) or Event (system journal entry).", "default": "reply", "type": "string", "enum": [ "reply", "note", "event" ] }, "metadata": { "description": "Type-specific structured data, staff-only. Notes carry `mentionedUserIds`;\nevents carry `{eventType, fromStatus, toStatus, targetUserId, targetUserName, actorName}`.", "type": "object", "additionalProperties": { "type": [ "string", "null" ] } } } } ] }, "Reservation-reservation.read_reservation.collection.read_reservation.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "bookable": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "validated": { "default": false, "type": "boolean" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" }, "checkedInAt": { "description": "When the patron physically checked in on-site (scanned the printed QR code and\nconfirmed their email). Null until checked in. Only relevant on bookables with\ncheck-in enabled; reservations not checked in by their deadline get auto-cancelled.", "type": [ "string", "null" ], "format": "date-time" } } }, "Reservation-reservation.read_reservation.item.read_reservation.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "bookable": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "validated": { "default": false, "type": "boolean" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" }, "checkedInAt": { "description": "When the patron physically checked in on-site (scanned the printed QR code and\nconfirmed their email). Null until checked in. Only relevant on bookables with\ncheck-in enabled; reservations not checked in by their deadline get auto-cancelled.", "type": [ "string", "null" ], "format": "date-time" } } }, "Reservation-reservation.write_reservation.item.write_reservation.item.patch.jsonMergePatch": { "type": "object", "properties": { "validated": { "default": false, "type": "boolean" } } }, "Reservation.jsonld-reservation.read_reservation.collection.read_reservation.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "bookable": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "validated": { "default": false, "type": "boolean" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" }, "checkedInAt": { "description": "When the patron physically checked in on-site (scanned the printed QR code and\nconfirmed their email). Null until checked in. Only relevant on bookables with\ncheck-in enabled; reservations not checked in by their deadline get auto-cancelled.", "type": [ "string", "null" ], "format": "date-time" } } } ] }, "Reservation.jsonld-reservation.read_reservation.item.read_reservation.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "bookable": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "validated": { "default": false, "type": "boolean" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time" }, "cancelReason": { "type": [ "string", "null" ] }, "comment": { "maxLength": 500, "type": [ "string", "null" ] }, "guests": { "minimum": 0, "default": 0, "type": "integer" }, "checkedInAt": { "description": "When the patron physically checked in on-site (scanned the printed QR code and\nconfirmed their email). Null until checked in. Only relevant on bookables with\ncheck-in enabled; reservations not checked in by their deadline get auto-cancelled.", "type": [ "string", "null" ], "format": "date-time" } } } ] }, "Thread-thread.read_thread.collection.read_thread.collection.get_collection": { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "readOnly": true, "default": 1, "type": "integer" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "organization": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "status": { "default": "new", "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "priority": { "default": "normal", "type": "string", "enum": [ "low", "normal", "high" ] }, "type": { "description": "Kind of request: `general` for a message, `acquisition` for a purchase suggestion. Read-only: a message becomes a suggestion through the acquisition conversion endpoint.", "default": "general", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "anyOf": [ { "$ref": "#/components/schemas/ThreadAcquisition-thread.read_thread.collection.read_thread.collection.get_collection" }, { "type": "null" } ] }, "token": { "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string" }, "lastMessageContent": { "readOnly": true, "type": [ "string", "null" ] }, "assigneeId": { "readOnly": true, "description": "Assignee id/name as flat primitives so the thread list (collection read)\ncan render the owner without embedding the whole User (whose name fields\nonly serialize under the item-read group).", "type": [ "string", "null" ] }, "assigneeName": { "readOnly": true, "type": [ "string", "null" ] }, "lastMessageCreatedAt": { "readOnly": true, "type": [ "string", "null" ], "format": "date-time" } } }, "Thread-thread.read_thread.item.read_thread.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "readOnly": true, "default": 1, "type": "integer" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "organization": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "status": { "default": "new", "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "priority": { "default": "normal", "type": "string", "enum": [ "low", "normal", "high" ] }, "type": { "description": "Kind of request: `general` for a message, `acquisition` for a purchase suggestion. Read-only: a message becomes a suggestion through the acquisition conversion endpoint.", "default": "general", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "anyOf": [ { "$ref": "#/components/schemas/ThreadAcquisition-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "token": { "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message-thread.read_thread.item.read_thread.item.get" } }, "lastMessageContent": { "readOnly": true, "type": [ "string", "null" ] }, "assigneeId": { "readOnly": true, "description": "Assignee id/name as flat primitives so the thread list (collection read)\ncan render the owner without embedding the whole User (whose name fields\nonly serialize under the item-read group).", "type": [ "string", "null" ] }, "assigneeName": { "readOnly": true, "type": [ "string", "null" ] }, "lastMessageCreatedAt": { "readOnly": true, "type": [ "string", "null" ], "format": "date-time" } } }, "Thread-thread.read_thread.item.read_thread.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "readOnly": true, "default": 1, "type": "integer" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "organization": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "status": { "default": "new", "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "priority": { "default": "normal", "type": "string", "enum": [ "low", "normal", "high" ] }, "type": { "description": "Kind of request: `general` for a message, `acquisition` for a purchase suggestion. Read-only: a message becomes a suggestion through the acquisition conversion endpoint.", "default": "general", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "anyOf": [ { "$ref": "#/components/schemas/ThreadAcquisition-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "token": { "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message-thread.read_thread.item.read_thread.item.patch" } }, "lastMessageContent": { "readOnly": true, "type": [ "string", "null" ] }, "assigneeId": { "readOnly": true, "description": "Assignee id/name as flat primitives so the thread list (collection read)\ncan render the owner without embedding the whole User (whose name fields\nonly serialize under the item-read group).", "type": [ "string", "null" ] }, "assigneeName": { "readOnly": true, "type": [ "string", "null" ] }, "lastMessageCreatedAt": { "readOnly": true, "type": [ "string", "null" ], "format": "date-time" } } }, "Thread-thread.write_thread.item.write_thread.item.patch.jsonMergePatch": { "type": "object", "properties": { "status": { "default": "new", "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "assignee": { "description": "Staff member currently owning the thread. Null = unassigned. Set/cleared\nvia PATCH (IRI or null); SET NULL on user removal so the thread survives.", "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "priority": { "default": "normal", "type": "string", "enum": [ "low", "normal", "high" ] }, "contactName": { "type": "string" }, "contactEmail": { "type": "string" } } }, "Thread.jsonld-thread.read_thread.collection.read_thread.collection.get_collection": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "readOnly": true, "default": 1, "type": "integer" }, "createdBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "updatedBy": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "organization": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "status": { "default": "new", "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "priority": { "default": "normal", "type": "string", "enum": [ "low", "normal", "high" ] }, "type": { "description": "Kind of request: `general` for a message, `acquisition` for a purchase suggestion. Read-only: a message becomes a suggestion through the acquisition conversion endpoint.", "default": "general", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "anyOf": [ { "$ref": "#/components/schemas/ThreadAcquisition.jsonld-thread.read_thread.collection.read_thread.collection.get_collection" }, { "type": "null" } ] }, "token": { "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string" }, "lastMessageContent": { "readOnly": true, "type": [ "string", "null" ] }, "assigneeId": { "readOnly": true, "description": "Assignee id/name as flat primitives so the thread list (collection read)\ncan render the owner without embedding the whole User (whose name fields\nonly serialize under the item-read group).", "type": [ "string", "null" ] }, "assigneeName": { "readOnly": true, "type": [ "string", "null" ] }, "lastMessageCreatedAt": { "readOnly": true, "type": [ "string", "null" ], "format": "date-time" } } } ] }, "Thread.jsonld-thread.read_thread.item.read_thread.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "readOnly": true, "default": 1, "type": "integer" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "organization": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "status": { "default": "new", "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "priority": { "default": "normal", "type": "string", "enum": [ "low", "normal", "high" ] }, "type": { "description": "Kind of request: `general` for a message, `acquisition` for a purchase suggestion. Read-only: a message becomes a suggestion through the acquisition conversion endpoint.", "default": "general", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "anyOf": [ { "$ref": "#/components/schemas/ThreadAcquisition.jsonld-thread.read_thread.item.read_thread.item.get" }, { "type": "null" } ] }, "token": { "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message.jsonld-thread.read_thread.item.read_thread.item.get" } }, "lastMessageContent": { "readOnly": true, "type": [ "string", "null" ] }, "assigneeId": { "readOnly": true, "description": "Assignee id/name as flat primitives so the thread list (collection read)\ncan render the owner without embedding the whole User (whose name fields\nonly serialize under the item-read group).", "type": [ "string", "null" ] }, "assigneeName": { "readOnly": true, "type": [ "string", "null" ] }, "lastMessageCreatedAt": { "readOnly": true, "type": [ "string", "null" ], "format": "date-time" } } } ] }, "Thread.jsonld-thread.read_thread.item.read_thread.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": [ "string", "null" ], "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "readOnly": true, "default": 1, "type": "integer" }, "createdBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "updatedBy": { "anyOf": [ { "$ref": "#/components/schemas/User.jsonld-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "organization": { "type": [ "string", "null" ], "format": "iri-reference", "example": "https://example.com/" }, "status": { "default": "new", "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "priority": { "default": "normal", "type": "string", "enum": [ "low", "normal", "high" ] }, "type": { "description": "Kind of request: `general` for a message, `acquisition` for a purchase suggestion. Read-only: a message becomes a suggestion through the acquisition conversion endpoint.", "default": "general", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "anyOf": [ { "$ref": "#/components/schemas/ThreadAcquisition.jsonld-thread.read_thread.item.read_thread.item.patch" }, { "type": "null" } ] }, "token": { "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message.jsonld-thread.read_thread.item.read_thread.item.patch" } }, "lastMessageContent": { "readOnly": true, "type": [ "string", "null" ] }, "assigneeId": { "readOnly": true, "description": "Assignee id/name as flat primitives so the thread list (collection read)\ncan render the owner without embedding the whole User (whose name fields\nonly serialize under the item-read group).", "type": [ "string", "null" ] }, "assigneeName": { "readOnly": true, "type": [ "string", "null" ] }, "lastMessageCreatedAt": { "readOnly": true, "type": [ "string", "null" ], "format": "date-time" } } } ] }, "ThreadAcquisition-thread.read_thread.collection.read_thread.collection.get_collection": { "type": "object", "properties": { "title": { "default": "", "type": "string" }, "author": { "type": [ "string", "null" ] }, "isbn": { "description": "ISBN as typed by the requester (kept verbatim for display).", "type": [ "string", "null" ] }, "acquisitionStatus": { "default": "to_review", "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the patron on approve/reject (it is mailed to them).", "type": [ "string", "null" ] } } }, "ThreadAcquisition-thread.read_thread.item.read_thread.item.get": { "type": "object", "properties": { "title": { "default": "", "type": "string" }, "author": { "type": [ "string", "null" ] }, "isbn": { "description": "ISBN as typed by the requester (kept verbatim for display).", "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "publicationYear": { "type": [ "integer", "null" ] }, "format": { "type": [ "string", "null" ] }, "notes": { "description": "Internal staff notes \u2014 never public.", "type": [ "string", "null" ] }, "acquisitionStatus": { "default": "to_review", "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the patron on approve/reject (it is mailed to them).", "type": [ "string", "null" ] }, "ilsReference": { "description": "Purchase-request reference in the ILS once transmitted. Internal.", "type": [ "string", "null" ] }, "transmittedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedByName": { "readOnly": true, "description": "Decider as a flat primitive so the staff detail panel can render it\nwithout embedding the whole User (same shape as Thread::getAssigneeName).", "type": [ "string", "null" ] } } }, "ThreadAcquisition-thread.read_thread.item.read_thread.item.patch": { "type": "object", "properties": { "title": { "default": "", "type": "string" }, "author": { "type": [ "string", "null" ] }, "isbn": { "description": "ISBN as typed by the requester (kept verbatim for display).", "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "publicationYear": { "type": [ "integer", "null" ] }, "format": { "type": [ "string", "null" ] }, "notes": { "description": "Internal staff notes \u2014 never public.", "type": [ "string", "null" ] }, "acquisitionStatus": { "default": "to_review", "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the patron on approve/reject (it is mailed to them).", "type": [ "string", "null" ] }, "ilsReference": { "description": "Purchase-request reference in the ILS once transmitted. Internal.", "type": [ "string", "null" ] }, "transmittedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedByName": { "readOnly": true, "description": "Decider as a flat primitive so the staff detail panel can render it\nwithout embedding the whole User (same shape as Thread::getAssigneeName).", "type": [ "string", "null" ] } } }, "ThreadAcquisition.jsonld-thread.read_thread.collection.read_thread.collection.get_collection": { "type": "object", "properties": { "title": { "default": "", "type": "string" }, "author": { "type": [ "string", "null" ] }, "isbn": { "description": "ISBN as typed by the requester (kept verbatim for display).", "type": [ "string", "null" ] }, "acquisitionStatus": { "default": "to_review", "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the patron on approve/reject (it is mailed to them).", "type": [ "string", "null" ] } } }, "ThreadAcquisition.jsonld-thread.read_thread.item.read_thread.item.get": { "type": "object", "properties": { "title": { "default": "", "type": "string" }, "author": { "type": [ "string", "null" ] }, "isbn": { "description": "ISBN as typed by the requester (kept verbatim for display).", "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "publicationYear": { "type": [ "integer", "null" ] }, "format": { "type": [ "string", "null" ] }, "notes": { "description": "Internal staff notes \u2014 never public.", "type": [ "string", "null" ] }, "acquisitionStatus": { "default": "to_review", "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the patron on approve/reject (it is mailed to them).", "type": [ "string", "null" ] }, "ilsReference": { "description": "Purchase-request reference in the ILS once transmitted. Internal.", "type": [ "string", "null" ] }, "transmittedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedByName": { "readOnly": true, "description": "Decider as a flat primitive so the staff detail panel can render it\nwithout embedding the whole User (same shape as Thread::getAssigneeName).", "type": [ "string", "null" ] } } }, "ThreadAcquisition.jsonld-thread.read_thread.item.read_thread.item.patch": { "type": "object", "properties": { "title": { "default": "", "type": "string" }, "author": { "type": [ "string", "null" ] }, "isbn": { "description": "ISBN as typed by the requester (kept verbatim for display).", "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ] }, "publicationYear": { "type": [ "integer", "null" ] }, "format": { "type": [ "string", "null" ] }, "notes": { "description": "Internal staff notes \u2014 never public.", "type": [ "string", "null" ] }, "acquisitionStatus": { "default": "to_review", "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the patron on approve/reject (it is mailed to them).", "type": [ "string", "null" ] }, "ilsReference": { "description": "Purchase-request reference in the ILS once transmitted. Internal.", "type": [ "string", "null" ] }, "transmittedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedAt": { "type": [ "string", "null" ], "format": "date-time" }, "decidedByName": { "readOnly": true, "description": "Decider as a flat primitive so the staff detail panel can render it\nwithout embedding the whole User (same shape as Thread::getAssigneeName).", "type": [ "string", "null" ] } } }, "User-thread.read_thread.item.read_thread.item.get": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstname": { "minLength": 3, "maxLength": 180, "type": "string" }, "lastname": { "minLength": 3, "maxLength": 180, "type": "string" } } }, "User-thread.read_thread.item.read_thread.item.patch": { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstname": { "minLength": 3, "maxLength": 180, "type": "string" }, "lastname": { "minLength": 3, "maxLength": 180, "type": "string" } } }, "User.jsonld-thread.read_thread.item.read_thread.item.get": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstname": { "minLength": 3, "maxLength": 180, "type": "string" }, "lastname": { "minLength": 3, "maxLength": 180, "type": "string" } } } ] }, "User.jsonld-thread.read_thread.item.read_thread.item.patch": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstname": { "minLength": 3, "maxLength": 180, "type": "string" }, "lastname": { "minLength": 3, "maxLength": 180, "type": "string" } } } ] }, "FootfallMeasureQuality": { "required": [ "state", "reasons", "requiresRecalibration" ], "properties": { "state": { "description": "Whether the measure is based on complete data, partial data, or no usable data.", "type": "string", "enum": [ "complete", "partial", "unavailable" ] }, "reasons": { "description": "Machine-readable reasons why the figure is limited or missing, for example missing_measurement or occupancy_requires_recalibration. Empty when there is nothing to report.", "type": "array", "items": { "type": "string" } }, "requiresRecalibration": { "description": "True when the sensors need to be recalibrated before occupancy can be trusted again.", "type": "boolean" }, "coverage": { "description": "Details of the period or readings the figure covers. Its layout depends on the measurement method." } }, "type": "object", "additionalProperties": true }, "ApiKeysApiKey": { "required": [ "id", "label", "createdAt", "lastUsedAt", "revokedAt" ], "properties": { "id": { "description": "API key identifier, used to revoke it.", "type": "string", "format": "uuid" }, "label": { "description": "Name given to the key when it was created.", "type": "string" }, "createdAt": { "description": "When the key was created.", "type": "string", "format": "date-time" }, "lastUsedAt": { "description": "When the key was last used to authenticate a request, or null if never.", "type": "string", "format": "date-time", "nullable": true }, "revokedAt": { "description": "When the key was revoked, or null while it is active.", "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "CreateApiKeyDto": { "required": [ "label" ], "properties": { "label": { "type": "string", "maxLength": 180, "minLength": 1 } }, "type": "object" }, "BookingsBookable": { "description": "A bookable room or equipment, as returned by the availability search (JSON-LD item).", "properties": { "@context": { "description": "JSON-LD context IRI", "type": "string" }, "@id": { "description": "JSON-LD IRI of the resource", "type": "string" }, "@type": { "type": "string", "enum": [ "Bookable" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "description": "IRI of the staff account that created the bookable", "type": "string", "nullable": true }, "updatedBy": { "description": "IRI of the staff account that last updated the bookable", "type": "string", "nullable": true }, "cover": { "description": "Cover image", "properties": { "@id": { "description": "JSON-LD IRI of the file", "type": "string" }, "@type": { "type": "string", "enum": [ "File" ] }, "id": { "type": "string", "format": "uuid" }, "fileUrl": { "description": "API-relative URL that serves the image", "type": "string" }, "sizeFormatted": { "description": "Human-readable file size, for example \"616.15 KB\"", "type": "string" }, "mimeType": { "type": "string", "nullable": true } }, "type": "object", "nullable": true }, "photos": { "description": "Additional photo file ids, in display order", "type": "array", "items": { "type": "string", "format": "uuid" } }, "coverPositionY": { "description": "Vertical focal point of the cover, in percent", "type": "integer", "maximum": 100, "minimum": 0 }, "bookableType": { "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "description": "Whether reservations cover whole days or time slots", "type": "string", "enum": [ "day", "slot" ] }, "title": { "description": "Title in the requested locale. Null only when fallback is disabled and no translation exists", "type": "string", "nullable": true }, "slug": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time", "nullable": true }, "isPublished": { "type": "boolean" }, "autoValidate": { "description": "Whether new reservations are approved automatically", "type": "boolean" }, "enableCheckIn": { "description": "Whether on-site check-in is required", "type": "boolean" }, "membersOnly": { "description": "Whether only library members can reserve", "type": "boolean" }, "requireParticipantAccounts": { "description": "Whether every additional participant must have a member account", "type": "boolean" }, "countParticipantQuota": { "description": "Whether participations count toward each participant's reservation quota", "type": "boolean" }, "capacityGuests": { "description": "Maximum number of companions per reservation", "type": "integer", "minimum": 0 }, "content": { "description": "Description in the requested locale", "type": "string", "nullable": true }, "contentDocument": { "description": "Rich-text description as a structured editor document", "type": "object", "nullable": true, "additionalProperties": true }, "locationName": { "type": "string", "nullable": true }, "locationUrl": { "type": "string", "nullable": true }, "capacity": { "description": "Number of people the bookable holds", "type": "integer", "nullable": true }, "slotSize": { "description": "Slot length in minutes, for slot calendars", "type": "integer", "nullable": true, "enum": [ 15, 30, 60 ] }, "maxSlotPerReservation": { "description": "Maximum consecutive slots (or days) per reservation", "type": "integer", "nullable": true }, "minSlotPerReservation": { "description": "Minimum consecutive slots per reservation", "type": "integer", "nullable": true }, "leadTimeAmount": { "description": "How far in advance a reservation must be made, in leadTimeUnit", "type": "integer", "nullable": true }, "leadTimeUnit": { "type": "string", "nullable": true, "enum": [ "hours", "days" ] }, "maxAdvanceDays": { "description": "How many days ahead reservations are accepted", "type": "integer", "nullable": true }, "minParticipants": { "description": "Minimum number of people, holder included", "type": "integer", "nullable": true }, "equipments": { "type": "array", "items": { "type": "string", "enum": [ "table", "paperboard", "projector", "whiteboard", "wheelchair_access", "power_outlet" ] }, "nullable": true }, "settings": { "description": "Free-form booking settings such as opening hours and closed days", "type": "object", "nullable": true, "additionalProperties": true }, "requestedLocale": { "description": "Locale the translatable fields were requested in", "type": "string" }, "fieldLocales": { "description": "Locale actually used for each translatable field", "type": "object", "additionalProperties": { "type": "string" } }, "translatedLocales": { "description": "Locales this bookable has translations for", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "BookingsSlotClosure": { "description": "A period during which a bookable cannot be reserved.", "required": [ "id", "startAt", "endAt", "createdAt" ], "properties": { "id": { "description": "Closure identifier.", "type": "string", "format": "uuid" }, "startAt": { "description": "Start of the closure, local date and time formatted YYYY-MM-DD HH:MM:SS.", "type": "string", "example": "2026-06-09 00:00:00" }, "endAt": { "description": "End of the closure, local date and time formatted YYYY-MM-DD HH:MM:SS.", "type": "string", "example": "2026-06-10 00:00:00" }, "createdAt": { "description": "When the closure was created.", "type": "string", "format": "date-time" } }, "type": "object" }, "BookingsManagerReservation": { "description": "A reservation row in the staff reservation directory, with the holder's contact details.", "required": [ "id", "displayName", "iri", "bookableId", "bookable", "token", "firstname", "lastname", "email", "startAt", "endAt", "validated", "cancelledAt", "cancelReason", "comment", "guests", "checkedInAt" ], "properties": { "id": { "description": "Reservation identifier.", "type": "string", "format": "uuid" }, "displayName": { "description": "Best available name for the holder: the name given when booking, then the linked account, then the library card name, then the email address.", "type": "string", "nullable": true }, "iri": { "description": "IRI of the reservation.", "type": "string" }, "bookableId": { "description": "Identifier of the reserved bookable.", "type": "string", "format": "uuid" }, "bookable": { "description": "The reserved bookable.", "required": [ "id", "title", "slug", "bookableType", "calendarType" ], "properties": { "id": { "description": "Bookable identifier.", "type": "string", "format": "uuid" }, "title": { "description": "Bookable title in the requested locale.", "type": "string" }, "slug": { "description": "Bookable slug.", "type": "string" }, "bookableType": { "type": "string", "enum": [ "room", "equipment" ] }, "calendarType": { "description": "Whether reservations cover whole days or time slots.", "type": "string", "enum": [ "day", "slot" ] } }, "type": "object" }, "token": { "description": "Private token that lets the holder view or cancel the reservation.", "type": "string", "nullable": true }, "firstname": { "description": "First name given when booking.", "type": "string", "nullable": true }, "lastname": { "description": "Last name given when booking.", "type": "string", "nullable": true }, "email": { "description": "Contact email given when booking.", "type": "string", "nullable": true }, "startAt": { "description": "Start, local date and time formatted YYYY-MM-DD HH:MM:SS.", "type": "string", "example": "2026-06-02 09:00:00", "nullable": true }, "endAt": { "description": "End, local date and time formatted YYYY-MM-DD HH:MM:SS.", "type": "string", "example": "2026-06-02 17:00:00", "nullable": true }, "validated": { "description": "Whether the reservation is approved.", "type": "boolean" }, "cancelledAt": { "description": "When the reservation was cancelled; null while active.", "type": "string", "format": "date-time", "nullable": true }, "cancelReason": { "description": "Reason given for the cancellation.", "type": "string", "nullable": true }, "comment": { "description": "Comment left when booking.", "type": "string", "nullable": true }, "guests": { "description": "Number of companions, the holder excluded.", "type": "integer", "minimum": 0 }, "checkedInAt": { "description": "When the reservation was checked in on site. It applies to the whole reservation, not to individual participants.", "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "BookingsReservation": { "description": "A reservation as shown to the person who made it (JSON-LD item). Contact details are not included.", "required": [ "@context", "@id", "@type", "id", "createdAt", "bookable", "validated", "startAt", "endAt", "cancelledAt", "cancelReason", "comment", "guests", "checkedInAt", "bookableSlug", "bookableTitle", "bookableCover" ], "properties": { "@context": { "description": "JSON-LD context IRI.", "type": "string" }, "@id": { "description": "JSON-LD IRI of the reservation.", "type": "string" }, "@type": { "type": "string", "enum": [ "Reservation" ] }, "id": { "description": "Reservation identifier.", "type": "string", "format": "uuid" }, "createdAt": { "description": "When the reservation was made.", "type": "string", "format": "date-time" }, "bookable": { "description": "IRI of the reserved bookable.", "type": "string" }, "validated": { "description": "Whether the reservation is approved. False while awaiting approval and once cancelled.", "type": "boolean" }, "startAt": { "description": "Start, local date and time formatted YYYY-MM-DD HH:MM:SS.", "type": "string", "example": "2026-06-02 09:00:00" }, "endAt": { "description": "End, local date and time formatted YYYY-MM-DD HH:MM:SS.", "type": "string", "example": "2026-06-02 17:00:00" }, "cancelledAt": { "description": "When the reservation was cancelled; null while active.", "type": "string", "format": "date-time", "nullable": true }, "cancelReason": { "description": "Reason given for the cancellation.", "type": "string", "nullable": true }, "comment": { "description": "Comment left when booking.", "type": "string", "nullable": true }, "guests": { "description": "Number of companions, the holder excluded.", "type": "integer", "minimum": 0 }, "checkedInAt": { "description": "When the reservation was checked in on site; applies to the whole reservation.", "type": "string", "format": "date-time", "nullable": true }, "bookableSlug": { "description": "Slug of the reserved bookable.", "type": "string", "nullable": true }, "bookableTitle": { "description": "Title of the reserved bookable.", "type": "string", "nullable": true }, "bookableCover": { "description": "IRI of the bookable cover file, or null when it has none.", "type": "string", "nullable": true } }, "type": "object" }, "BookingsReservationParticipant": { "description": "A named participant, as submitted by the holder. Names are never returned.", "required": [ "email" ], "properties": { "email": { "description": "Identifier submitted for the participant: an email address or, where the library supports it, a card number.", "type": "string", "nullable": true } }, "type": "object" }, "AddReservationParticipantsDto": { "properties": { "participants": { "type": "array", "items": { "type": "string" }, "maxItems": 20 }, "participantsAgreement": { "type": "boolean" } }, "type": "object" }, "BatchBookableClosuresDto": [], "CancelReservationDto": { "required": [ "reason" ], "properties": { "reason": { "type": "string", "maxLength": 1000 } }, "type": "object" }, "CheckInReservationDto": { "required": [ "email", "latitude", "longitude" ], "properties": { "email": { "type": "string", "format": "email" }, "latitude": { "type": "number", "format": "float", "maximum": 90, "minimum": -90 }, "longitude": { "type": "number", "format": "float", "maximum": 180, "minimum": -180 } }, "type": "object" }, "ReservationDto": { "required": [ "startAt", "endAt" ], "properties": { "confirmationId": { "type": "string", "format": "uuid", "nullable": true }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "email": { "type": "string", "format": "email", "nullable": true }, "firstname": { "type": "string", "nullable": true, "maxLength": 255 }, "lastname": { "type": "string", "nullable": true, "maxLength": 255 }, "comment": { "type": "string", "nullable": true, "maxLength": 500 }, "guests": { "type": "integer", "nullable": true, "minimum": 0 }, "participants": { "description": "Additional participants' emails, one per person, when the bookable\nrequires named participant accounts. `guests` is then derived from this\nlist server-side.", "type": "array", "items": { "type": "string", "format": "email" }, "maxItems": 20 } }, "type": "object" }, "ValidateReservationParticipantsDto": { "properties": { "participants": { "type": "array", "items": { "type": "string", "format": "email" }, "maxItems": 20 } }, "type": "object" }, "PagesPublicPageTreeItem": { "required": [ "id", "parentId", "title", "slug", "isPublished" ], "properties": { "id": { "description": "Page identifier.", "type": "string", "format": "uuid" }, "parentId": { "description": "Identifier of the parent page, or null for a top-level page or when the parent is not published.", "type": "string", "format": "uuid", "nullable": true }, "title": { "description": "Page title in the requested language.", "type": "string" }, "slug": { "description": "URL slug of the page.", "type": "string" }, "isPublished": { "description": "Always true here: only published pages are listed.", "type": "boolean" } }, "type": "object" }, "CancelCmsEventDto": { "required": [ "reason" ], "properties": { "reason": { "type": "string" } }, "type": "object" }, "CancelCmsEventRegistrationDto": { "required": [ "reason" ], "properties": { "reason": { "type": "string" } }, "type": "object" }, "CmsEventParticipantsMailDto": { "required": [ "subject", "body" ], "properties": { "subject": { "type": "string" }, "body": { "type": "string" } }, "type": "object" }, "RegistrationDto": { "properties": { "confirmationId": { "type": "string", "format": "uuid", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "guests": { "type": "integer", "nullable": true } }, "type": "object" }, "CatalogueLocation": { "description": "A shelf location of the library system.", "properties": { "locationRef": { "description": "Stable reference of the location within the organization. Catalog records point to it.", "type": "string" }, "libraryCode": { "description": "Code of the library the location belongs to.", "type": "string" }, "libraryLabel": { "description": "Display name of the library.", "type": "string", "nullable": true }, "locationId": { "description": "Identifier of the location in the library system.", "type": "string" }, "code": { "description": "Location code as shown in the library system.", "type": "string" }, "name": { "description": "Display name of the location.", "type": "string", "nullable": true }, "providerType": { "description": "Location type reported by the library system.", "type": "string", "nullable": true }, "detectedAccessMode": { "description": "Access mode reported by the library system: shelf (open shelves) or request (closed or remote storage).", "type": "string", "enum": [ "shelf", "request" ] }, "accessMode": { "description": "Effective access mode after the organization settings. Copies in a hidden location are never shown publicly.", "type": "string", "enum": [ "shelf", "request", "hidden" ] }, "ownLibrary": { "description": "Whether the location belongs to one of the libraries declared in the organization SIGB settings, rather than to another library of its network. True for every location when the settings declare none.", "type": "boolean" }, "legacyCodeUnambiguous": { "description": "Whether the location code alone identifies this location across the libraries of the organization.", "type": "boolean" }, "legacyCodes": { "description": "Location codes that identify only this location.", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "OrganizationOpeningHoursRange": { "required": [ "open", "close" ], "properties": { "open": { "description": "Opening time, HH:MM in the organization time zone.", "type": "string", "example": "09:00" }, "close": { "description": "Closing time, HH:MM in the organization time zone.", "type": "string", "example": "17:00" } }, "type": "object" }, "OrganizationOpeningCalendarDay": { "description": "Effective opening hours of one day.", "properties": { "date": { "type": "string", "format": "date" }, "ranges": { "description": "Opening ranges sorted by opening time. An empty list means closed; null means no opening hours are configured.", "type": "array", "items": { "$ref": "#/components/schemas/OrganizationOpeningHoursRange" }, "nullable": true }, "origin": { "description": "weekly for the regular schedule, exception_open or exception_close when an exception sets the day.", "type": "string", "enum": [ "weekly", "exception_open", "exception_close" ] }, "annotations": { "description": "Notes about the day, such as the name of the exception that applies.", "type": "array", "items": { "properties": { "label": { "description": "Name of the exception, for example a holiday.", "type": "string" } }, "type": "object", "additionalProperties": true } }, "providerKey": { "description": "Library system the day was synchronized from. Null for hours managed in Loupe.", "type": "string", "nullable": true }, "sourceId": { "description": "Calendar identifier in the library system. Null for hours managed in Loupe.", "type": "string", "nullable": true }, "checksum": { "description": "Fingerprint of the synchronized day. Null for hours managed in Loupe.", "type": "string", "nullable": true } }, "type": "object" }, "CatalogueHolding": { "description": "One copy of a record and where it sits in the library.", "properties": { "locationRef": { "description": "Stable reference of the shelf location within the organization, used by the public maps.", "type": "string", "nullable": true }, "libraryCode": { "description": "Code of the library holding the copy in the library system.", "type": "string", "nullable": true }, "libraryLabel": { "description": "Display name of the library holding the copy.", "type": "string", "nullable": true }, "locationCode": { "description": "Code of the shelf location in the library system.", "type": "string", "nullable": true }, "locationLabel": { "description": "Display name of the shelf location.", "type": "string", "nullable": true }, "legacyCodeUnambiguous": { "description": "Whether the location code alone identifies a single location across the libraries of the organization.", "type": "boolean" }, "callNumber": { "description": "Call number of the copy.", "type": "string", "nullable": true }, "isAvailable": { "description": "True when the catalog reports the copy available, false when it is on loan or missing, null when unknown.", "type": "boolean", "nullable": true }, "detectedAccessMode": { "description": "Access mode reported by the library system: shelf (open shelves) or request (must be requested).", "type": "string" }, "accessMode": { "description": "Effective access mode after the organization settings: shelf or request.", "type": "string" } }, "type": "object" }, "CatalogueRecord": { "description": "A bibliographic record from the library catalog, in the same shape whatever the library system. The location, availability and access fields describe the first copy listed in holdings.", "required": [ "provider", "id", "isbn", "contributors", "holdings", "thumbnails" ], "properties": { "provider": { "description": "Library system that produced the record, for example alma, rero or netbiblio.", "type": "string" }, "id": { "description": "Identifier of the record in the library system. Pass it to the item endpoints.", "type": "string", "nullable": true }, "isbn": { "description": "ISBNs of the record.", "type": "array", "items": { "type": "string" } }, "locationRef": { "description": "Stable reference of the shelf location of the first copy.", "type": "string", "nullable": true }, "libraryLabel": { "description": "Display name of the library holding the first copy.", "type": "string", "nullable": true }, "legacyCodeUnambiguous": { "description": "Whether the location code of the first copy identifies a single location.", "type": "boolean" }, "libraryCode": { "description": "Library code of the first copy.", "type": "string", "nullable": true }, "locationCode": { "description": "Shelf location code of the first copy.", "type": "string", "nullable": true }, "locationLabel": { "description": "Display name of the shelf location of the first copy.", "type": "string", "nullable": true }, "callNumber": { "description": "Call number of the first copy.", "type": "string", "nullable": true }, "detectedAccessMode": { "description": "Access mode reported by the library system: shelf or request.", "type": "string", "nullable": true }, "accessMode": { "description": "Effective access mode: shelf (open shelves), request (must be requested) or hidden (no copy can be shown publicly).", "type": "string", "nullable": true, "enum": [ "shelf", "request", "hidden" ] }, "isAvailable": { "description": "True when the catalog reports the record available, false when it is on loan or missing, null when unknown.", "type": "boolean", "nullable": true }, "type": { "description": "Document type, for example book, comic, audio or video.", "type": "string", "nullable": true }, "format": { "description": "Physical or digital format as described by the catalog.", "type": "string", "nullable": true }, "genre": { "description": "Main genre.", "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "author": { "description": "Main author.", "type": "string", "nullable": true }, "contributors": { "description": "Other contributors.", "type": "array", "items": { "type": "string" } }, "publisher": { "type": "string", "nullable": true }, "publishedDate": { "description": "Publication date or year, as catalogued.", "type": "string", "nullable": true }, "description": { "description": "Summary or description.", "type": "string", "nullable": true }, "language": { "description": "Language as catalogued by the library.", "type": "string", "nullable": true }, "audience": { "description": "Target audience as catalogued by the library.", "type": "string", "nullable": true }, "catalogUrl": { "description": "Link to the record in the public catalog of the library.", "type": "string", "format": "uri", "nullable": true }, "fulfillmentUrl": { "description": "Link opening the request or reservation options of the library.", "type": "string", "format": "uri", "nullable": true }, "holdings": { "description": "Copies of the record that can be shown publicly.", "type": "array", "items": { "$ref": "#/components/schemas/CatalogueHolding" } }, "holdingSelectionVerified": { "description": "Whether indexed browsing confirmed its selected copies against a live notice. False means the indexed location is only a hint; links must open the notice without a copy selection.", "type": "boolean", "nullable": true }, "thumbnails": { "description": "Cover image URLs.", "type": "array", "items": { "type": "string", "format": "uri" } } }, "type": "object" }, "CatalogueFacetValue": { "required": [ "value", "count" ], "properties": { "value": { "description": "Value to show and to filter on.", "type": "string" }, "count": { "description": "Number of records carrying this value.", "type": "integer" } }, "type": "object" }, "CatalogueFacet": { "description": "A filter family with the values found in the results.", "required": [ "name", "values" ], "properties": { "name": { "description": "Filter family, for example type, genre, language, author, subject or year.", "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogueFacetValue" } } }, "type": "object" }, "IlsItemDto": { "properties": { "organization": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "IlsItemsDto": { "properties": { "organization": { "type": "string" }, "ids": { "type": "array", "items": [] } }, "type": "object" }, "IlsSearchDto": { "properties": { "organization": { "type": "string" }, "lang": { "type": "string" }, "sort": [], "queryField": [], "queryPrecision": [], "queryValue": { "type": "string" }, "retrievalMode": { "description": "The model chooses semantic discovery or a structured catalog listing.", "type": "string" }, "userQuery": { "type": "string", "nullable": true }, "facetProvenance": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "indexed_text", "indexed_value", "native" ] } }, "facetSourceScope": { "description": "Opaque identity of the source that resolved these facet values.", "type": "string", "nullable": true }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "facets": { "description": "Free-form facet payload \u2014 interpreted by each provider.\n\nShape: { facetName: { facetValue: operator } }", "type": "array", "items": [] }, "semanticQuery": { "description": "Optional rewritten semantic THEME of the request, used for the dense\n(vector) side of the RAG engine when present \u2014 richer than the bare\n`queryValue` keywords (\"un polar cosy dans les Alpes\" instead of \"polar\").\nThe sparse/lexical side and the live provider keep using `queryValue`.", "type": "string", "nullable": true }, "liveLookups": { "description": "Whether indexed (RAG) results wait for the live SIGB lookup (availability,\nprovider covers, catalog URL) before answering. Result grids that never\ndisplay availability opt out: the harvested notice renders at once and the\nrecord detail performs its own live lookup. Live-engine searches ignore it.", "type": "boolean" } }, "type": "object" }, "IlsBrowseDto": { "description": "The structured catalog listing (\"browse\") request \u2014 no keywords, no\nrelevance: filters + a recency sort. Powers \"nouveaut\u00e9s\" rails and the\nchat's browse branch.", "properties": { "organization": { "type": "string" }, "canonicalType": { "description": "Restricts the listing to one document type.", "type": "string", "nullable": true, "enum": [ "book", "comic", "manga", "serial", "score", "map", "video", "audio", "music", "image", "electronic", "kit", "object", "other" ] }, "noveltyAfter": { "description": "Only records displayed as novelties since this month ('YYYY-MM').", "type": "string", "nullable": true }, "libraryCode": { "description": "Owning library code (852 $b / 995 $b), e.g. 'bcur'.", "type": "string", "nullable": true }, "locationRef": { "type": "string", "nullable": true }, "locationCode": { "description": "Physical shelf, as a raw ILS location code (852 $c / 949 $4 / 995 $c),\ne.g. '810010072' \u2014 the \"what is on this shelf\" listing. Codes, not\nlabels. Prefer locationRef for new map associations.", "type": "string", "nullable": true }, "callNumberRegexes": { "description": "Call-number regexes narrowing $locationCode down to ONE physical shelf\nwhen several shelves share a location code (the map builder's per-shelf\n`regexes`). A record matches when any regex matches the call number of\na holding AT that location. Ignored without $locationCode; patterns the\nPostgres regex engine rejects (they are authored/tested as JS regexes\nin the map builder) are skipped individually rather than failing the\nlisting.", "type": "array", "items": { "type": "string" } }, "callNumberRanges": { "description": "Call-number ranges narrowing $locationCode down to one shelf, read in\nshelf order (docs/call-number-order.md): a copy matches when its\nstored sort key lies from `from` (inclusive) up to `to`, whatever\ncontinues `to` included. Either bound may be omitted. A copy matching\nany range or any regex is kept. Ignored without $locationCode.", "type": "array", "items": { "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true } }, "type": "object" } }, "shelfSegments": { "description": "Rayon segments narrowing $locationCode down to one shelf\n(docs/shelf-model.md): a copy matches when its `shelf` descriptor\nnames this rayon (and order, when given) and its key lies from\n`from` (inclusive) up to `to` (exclusive). Keys are `loupe-shelf-2`\nkeys; either bound may be omitted. A copy matching any segment,\nrange or regex is kept. Ignored without $locationCode.", "type": "array", "items": { "properties": { "rayon": { "type": "string" }, "order": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true } }, "type": "object" } }, "recordIds": { "description": "Records a shelf names directly (an exhibition), by public id (SIGB\nbibliographic id or harvest source id). They are listed whatever\ntheir location, alongside the location's matching copies.", "type": "array", "items": { "type": "string" } }, "excludeRecordIds": { "description": "Records named by other shelves' selections: they stand there, not on\nthis shelf's rayons, so the listing leaves them out.", "type": "array", "items": { "type": "string" } }, "sort": { "description": "'recency' (default, novelty-first) or 'callNumber' \u2014 the physical shelf\norder, sorted on the call number of the holding matched at\n$locationCode; requires $locationCode. With shelf segments, copies\nsort by segment, in the order given, then by shelf key.", "type": "string" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "facets": { "description": "Type values are canonical types; genre values are exact catalog\nlabels from /ils/genres or canonical genre slugs; one included\npublication year or year range (\"2025-2026\").", "type": "array", "items": [] }, "liveLookups": { "type": "boolean" } }, "type": "object" }, "MapsMapDefinition": { "description": "The whole map as one JSON document, in the map's internal format. It is versioned by schemaVersion but is not a stable integration contract: its content can change without notice, so only rely on the top-level keys below. Maps made with the previous editor are returned in their original format, without runtime, schemaVersion or document. With wire=prototype-v1, repeated boxes and objects are packed as shared prototypes plus positioned instances. With wire=regional-v15, a map with a regional publication returns a small index of separately downloaded parts instead of the document; other maps fall back to the prototype-v1 form.", "properties": { "runtime": { "description": "Runtime that reads the document.", "type": "string", "enum": [ "loupe-map" ] }, "schemaVersion": { "description": "Version of the document format.", "type": "integer", "minimum": 1 }, "document": { "description": "Map content (buildings, floors, rooms, furniture, labels, layers, settings) in the map's internal format. Not a stable integration contract.", "type": "object", "additionalProperties": true }, "wireFormat": { "description": "Compact transport actually applied. Absent when the document is returned as stored.", "type": "string", "enum": [ "prototype-v1", "regional-v15" ] } }, "type": "object", "additionalProperties": true }, "MapsPublicMapPlace": { "required": [ "id", "type", "label", "description", "position", "floorId", "storey", "shape", "map" ], "properties": { "id": { "description": "Identifier of the place inside its map.", "type": "string" }, "type": { "description": "Kind of place: a text label on the map, a room, a 3D object, or a furniture block such as a shelf or a table.", "type": "string", "enum": [ "legend", "room", "object", "box" ] }, "label": { "description": "Name of the place as shown on the map.", "type": "string" }, "description": { "description": "Plain-text description; empty when there is none.", "type": "string" }, "position": { "description": "Horizontal position of the place on the map plan, as [x, y].", "type": "array", "items": { "type": "number", "format": "float" }, "maxItems": 2, "minItems": 2 }, "floorId": { "description": "Identifier of the floor the place stands on, or null.", "type": "string", "nullable": true }, "storey": { "description": "Storey index of the place inside its building, or null.", "type": "integer", "nullable": true }, "floorLabel": { "description": "Name of the floor, when one is set on the map.", "type": "string" }, "floorNumber": { "description": "Floor number counted from the ground floor (0), negative below ground. Present only when it can be determined.", "type": "integer" }, "shape": { "description": "For a furniture block, its shape: shelf, table or box. Null for other kinds of place.", "type": "string", "nullable": true }, "map": { "description": "Map the place belongs to.", "required": [ "slug", "name" ], "properties": { "slug": { "description": "Map slug.", "type": "string" }, "name": { "description": "Map name.", "type": "string" } }, "type": "object" } }, "type": "object" }, "MapRendererErrorDto": { "required": [ "kind", "backend", "renderProfile", "width", "height", "storey" ], "properties": { "kind": { "type": "string" }, "backend": { "type": "string" }, "renderProfile": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "storey": { "type": "integer" }, "reason": { "type": "string" }, "errorType": { "type": "string" }, "message": { "type": "string" }, "userAgent": { "type": "string" } }, "type": "object" }, "MessagesAcquisitionCatalogMatch": { "description": "Document already held by the library, or null when none was found.", "properties": { "kind": { "description": "`isbn_exact` when the same ISBN is held, `other_edition` when another edition of the same work is held.", "type": "string", "enum": [ "isbn_exact", "other_edition" ] }, "record": { "properties": { "title": { "type": "string" }, "author": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" }, "MessagesUser": { "description": "User account, embedded.", "properties": { "@id": { "description": "JSON-LD identifier (IRI) of the user.", "type": "string" }, "@type": { "type": "string", "enum": [ "User" ] }, "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "firstname": { "type": "string" }, "lastname": { "type": "string" } }, "type": "object" }, "MessagesThreadOrganization": { "description": "Organization the thread belongs to, embedded with its public profile. Only the main identifying fields are listed; other public profile fields (logo, favicon, network, maps, profile, directory details) are also included.", "properties": { "@id": { "description": "JSON-LD identifier (IRI) of the organization.", "type": "string" }, "@type": { "type": "string", "enum": [ "Organization" ] }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "locales": { "description": "Languages enabled for the organization.", "type": "array", "items": { "type": "string" } }, "defaultLocale": { "type": "string" } }, "type": "object", "additionalProperties": true }, "MessagesPublicAcquisition": { "description": "Purchase suggestion details visible to the requester.", "properties": { "@id": { "description": "JSON-LD blank node identifier.", "type": "string" }, "@type": { "type": "string", "enum": [ "ThreadAcquisition" ] }, "title": { "description": "Title of the suggested document.", "type": "string" }, "author": { "type": "string", "nullable": true }, "isbn": { "description": "ISBN as typed by the requester.", "type": "string", "nullable": true }, "acquisitionStatus": { "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the requester when the suggestion is approved or rejected.", "type": "string", "nullable": true } }, "type": "object" }, "MessagesManagerAcquisition": { "description": "Purchase suggestion details, including staff-only fields.", "properties": { "@id": { "description": "JSON-LD blank node identifier.", "type": "string" }, "@type": { "type": "string", "enum": [ "ThreadAcquisition" ] }, "title": { "description": "Title of the suggested document.", "type": "string" }, "author": { "type": "string", "nullable": true }, "isbn": { "description": "ISBN as typed by the requester.", "type": "string", "nullable": true }, "publisher": { "type": "string", "nullable": true }, "publicationYear": { "type": "integer", "nullable": true }, "format": { "type": "string", "nullable": true }, "notes": { "description": "Internal staff notes, never shown to the requester.", "type": "string", "nullable": true }, "acquisitionStatus": { "type": "string", "enum": [ "to_review", "under_review", "info_requested", "approved", "rejected", "transmitted" ] }, "decisionReason": { "description": "Reason shared with the requester when the suggestion is approved or rejected.", "type": "string", "nullable": true }, "ilsReference": { "description": "Purchase request reference in the library system once transmitted.", "type": "string", "nullable": true }, "transmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "decidedAt": { "type": "string", "format": "date-time", "nullable": true }, "decidedByName": { "description": "Full name (or email when no name is set) of the staff member who recorded the decision.", "type": "string", "nullable": true } }, "type": "object" }, "MessagesPublicMessage": { "description": "Public reply in a thread.", "properties": { "@id": { "description": "JSON-LD identifier (IRI) of the message.", "type": "string" }, "@type": { "type": "string", "enum": [ "Message" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "thread": { "description": "IRI of the thread the message belongs to.", "type": "string" }, "name": { "description": "Display name of the author. Library replies carry `your_library`, meaning the library itself.", "type": "string", "nullable": true }, "content": { "type": "string" } }, "type": "object" }, "MessagesManagerMessage": { "description": "Message in a thread: a public reply, an internal note or a system event.", "properties": { "@id": { "description": "JSON-LD identifier (IRI) of the message.", "type": "string" }, "@type": { "type": "string", "enum": [ "Message" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "oneOf": [ { "$ref": "#/components/schemas/MessagesUser" } ], "nullable": true, "description": "Signed-in account that wrote the message. Null when written by an anonymous visitor." }, "updatedBy": { "oneOf": [ { "$ref": "#/components/schemas/MessagesUser" } ], "nullable": true }, "thread": { "description": "IRI of the thread the message belongs to.", "type": "string" }, "name": { "description": "Display name of the author. Library replies carry `your_library`, meaning the library itself.", "type": "string", "nullable": true }, "content": { "type": "string" }, "kind": { "description": "`reply` is visible to the contact, `note` is internal to staff, `event` is a system journal entry.", "type": "string", "enum": [ "reply", "note", "event" ] }, "metadata": { "description": "Structured details. Notes carry `mentionedUserIds`; events carry `eventType`, `fromStatus`, `toStatus`, `targetUserId`, `targetUserName` and `actorName`. An empty array when there are none.", "type": "object", "additionalProperties": true } }, "type": "object" }, "MessagesPublicThread": { "description": "Message thread as seen by the contact. Only public replies are included; internal notes and system events are never returned.", "properties": { "@context": { "type": "string" }, "@id": { "description": "JSON-LD identifier (IRI) of the thread.", "type": "string" }, "@type": { "type": "string", "enum": [ "Thread" ] }, "type": { "description": "`general` for a message, `acquisition` for a purchase suggestion.", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "oneOf": [ { "$ref": "#/components/schemas/MessagesPublicAcquisition" } ], "nullable": true, "description": "Purchase suggestion details. Null unless `type` is `acquisition`." }, "token": { "description": "Secret token giving the contact access to the thread.", "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string", "format": "email" }, "messages": { "description": "Public replies of the thread.", "type": "array", "items": { "$ref": "#/components/schemas/MessagesPublicMessage" } } }, "type": "object" }, "MessagesManagerThread": { "description": "Message thread as seen by staff, with every message (replies, internal notes and system events) and staff-only acquisition fields.", "properties": { "@context": { "type": "string" }, "@id": { "description": "JSON-LD identifier (IRI) of the thread.", "type": "string" }, "@type": { "type": "string", "enum": [ "Thread" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "description": "Current version, for optimistic concurrency (If-Match).", "type": "integer" }, "createdBy": { "oneOf": [ { "$ref": "#/components/schemas/MessagesUser" } ], "nullable": true, "description": "Signed-in account that started the thread. Null when an anonymous visitor started it." }, "updatedBy": { "oneOf": [ { "$ref": "#/components/schemas/MessagesUser" } ], "nullable": true }, "organization": { "$ref": "#/components/schemas/MessagesThreadOrganization" }, "status": { "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved", "closed" ] }, "priority": { "type": "string", "enum": [ "low", "normal", "high" ] }, "type": { "description": "`general` for a message, `acquisition` for a purchase suggestion.", "type": "string", "enum": [ "general", "acquisition" ] }, "acquisition": { "oneOf": [ { "$ref": "#/components/schemas/MessagesManagerAcquisition" } ], "nullable": true, "description": "Purchase suggestion details. Null unless `type` is `acquisition`." }, "token": { "description": "Secret token giving the contact access to the thread.", "type": "string" }, "contactName": { "type": "string" }, "contactEmail": { "type": "string", "format": "email" }, "messages": { "description": "All messages of the thread.", "type": "array", "items": { "$ref": "#/components/schemas/MessagesManagerMessage" } }, "lastMessageContent": { "description": "Content of the latest reply or note, for previews.", "type": "string", "nullable": true }, "assigneeId": { "description": "Staff member the thread is assigned to. Null when unassigned.", "type": "string", "format": "uuid", "nullable": true }, "assigneeName": { "description": "Full name (or email when no name is set) of the assignee.", "type": "string", "nullable": true }, "lastMessageCreatedAt": { "description": "Date of the latest reply or note.", "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "ConvertThreadToAcquisitionDto": { "properties": { "threadId": { "type": "string" }, "title": { "type": "string" }, "author": { "type": "string", "nullable": true }, "isbn": { "type": "string", "nullable": true }, "publisher": { "type": "string", "nullable": true }, "publicationYear": { "type": "integer", "nullable": true }, "format": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "type": "object" }, "ConvertThreadToMessageDto": { "properties": { "threadId": { "type": "string" } }, "type": "object" }, "DecideAcquisitionDto": { "properties": { "threadId": { "type": "string" }, "decision": { "description": "`start_review` (re)opens the evaluation; `approve` / `reject` decide;\n`request_info` hands the ball back to the patron; `mark_transmitted`\nrecords the manual push to the ILS.", "type": "string" }, "reason": { "description": "Required when rejecting; optional context otherwise.", "type": "string", "nullable": true }, "ilsReference": { "description": "Required when marking as transmitted.", "type": "string", "nullable": true } }, "type": "object" }, "ManagerReplyThreadDto": { "properties": { "threadId": { "type": "string" }, "message": { "type": "string" }, "kind": { "description": "`reply` = public message sent to the contact; `note` = internal staff-only\nnote (no email, no status change).", "type": "string" }, "mentionedUserIds": { "description": "User ids (UUID) mentioned in an internal note \u2014 each is notified. Ignored\nfor public replies.", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "ManagerStartThreadDto": { "properties": { "organization": { "type": "string" }, "contactEmail": { "type": "string" }, "contactName": { "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "PrecheckAcquisitionDto": { "properties": { "organization": { "description": "Organization slug \u2014 required publicly; managers may select an authorized organization.", "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "isbn": { "type": "string", "nullable": true }, "author": { "type": "string", "nullable": true }, "excludeThreadId": { "description": "Manager only: exclude this thread from the duplicate lookup (self-check).", "type": "string", "nullable": true } }, "type": "object" }, "PublicReplyThreadDto": { "properties": { "token": { "type": "string" }, "name": { "type": "string", "nullable": true }, "message": { "type": "string" } }, "type": "object" }, "StartAcquisitionThreadDto": { "properties": { "organization": { "type": "string" }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "title": { "type": "string" }, "author": { "type": "string", "nullable": true }, "isbn": { "type": "string", "nullable": true }, "publisher": { "type": "string", "nullable": true }, "publicationYear": { "type": "integer", "nullable": true }, "format": { "type": "string", "nullable": true }, "comment": { "description": "Free-text justification shown as the thread's first message.", "type": "string", "nullable": true } }, "type": "object" }, "StartThreadDto": { "properties": { "organization": { "type": "string" }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "message": { "type": "string" } }, "type": "object" }, "UpdateAcquisitionDto": { "properties": { "threadId": { "type": "string" }, "title": { "type": "string" }, "author": { "type": "string", "nullable": true }, "isbn": { "type": "string", "nullable": true }, "publisher": { "type": "string", "nullable": true }, "publicationYear": { "type": "integer", "nullable": true }, "format": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "type": "object" }, "OrganizationFileRef": { "description": "An uploaded image.", "properties": { "id": { "type": "string", "format": "uuid" }, "fileUrl": { "description": "URL that serves the file.", "type": "string" }, "mimeType": { "type": "string", "example": "image/png" } }, "type": "object", "additionalProperties": true }, "OrganizationPublic": { "description": "Public profile and settings of an organization. Signed-in staff of the organization receive additional administrative fields.", "properties": { "@context": { "description": "JSON-LD context.", "type": "string" }, "@id": { "description": "JSON-LD identifier of the organization.", "type": "string" }, "@type": { "type": "string", "enum": [ "Organization" ] }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "description": "Identifier used in public URLs.", "type": "string" }, "type": { "type": "string", "enum": [ "library", "museum", "archive", "cultural_center", "campus", "other" ] }, "network": { "description": "Network the organization belongs to, if any.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "logo": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationFileRef" } ], "nullable": true }, "members": { "description": "Member organizations, as objects or as resource IRIs.", "type": "array", "items": [] } }, "type": "object", "nullable": true, "additionalProperties": true }, "logo": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationFileRef" } ], "nullable": true }, "favicon": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationFileRef" } ], "nullable": true }, "maps": { "description": "Maps of the organization.", "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "isDefault": { "description": "Whether this is the default map of the organization.", "type": "boolean" }, "runtime": { "description": "Map engine the map is built for.", "type": "string", "enum": [ "loupe-map", "legacy" ] } }, "type": "object", "additionalProperties": true } }, "locales": { "description": "Languages offered by the organization.", "type": "array", "items": { "type": "string" } }, "defaultLocale": { "description": "Default language, for example fr or en.", "type": "string" }, "profile": { "description": "Public facts from open data, only for organizations imported from a directory.", "type": "object", "nullable": true, "additionalProperties": true }, "directoryVisibility": { "description": "How the organization appears in the public directory.", "type": "string", "enum": [ "published", "unlisted", "hidden" ] }, "sourceUpdatedAt": { "description": "Last update of the open data source, for imported organizations.", "type": "string", "format": "date-time", "nullable": true }, "sourceUrl": { "description": "Open data source of an imported organization.", "type": "string", "nullable": true }, "sourceLicense": { "description": "License of the open data source.", "type": "string", "nullable": true }, "claimedAt": { "description": "When the organization was claimed by its staff.", "type": "string", "format": "date-time", "nullable": true }, "settings": { "description": "Public settings, one group per feature.", "properties": { "timeZone": { "type": "string", "example": "Europe/Zurich" }, "supportEmail": { "type": "string" }, "menus": { "description": "Navigation menus of the public site.", "type": "array", "items": { "type": "object", "additionalProperties": true } }, "navigation": { "type": "object", "nullable": true, "additionalProperties": true }, "theme": { "type": "object", "additionalProperties": true }, "site": { "type": "object", "additionalProperties": true }, "homepage": { "type": "object", "additionalProperties": true }, "search": { "type": "object", "additionalProperties": true }, "intelligence": { "description": "Same content as search, kept for older integrations.", "type": "object", "additionalProperties": true }, "messages": { "type": "object", "additionalProperties": true }, "bookables": { "type": "object", "additionalProperties": true }, "events": { "type": "object", "additionalProperties": true }, "map": { "type": "object", "additionalProperties": true }, "calendar": { "type": "object", "additionalProperties": true }, "ils": { "type": "object", "nullable": true, "additionalProperties": true }, "contactDetails": { "type": "object", "nullable": true, "additionalProperties": true }, "socials": { "type": "object", "nullable": true, "additionalProperties": true }, "affluence": { "type": "object", "additionalProperties": true }, "analytics": { "type": "object", "additionalProperties": true } }, "type": "object", "additionalProperties": true }, "aiAccess": { "description": "Assistant access of the current user. Both false for visitors.", "properties": { "use": { "description": "Whether the current user can use the staff assistant.", "type": "boolean" }, "agent": { "description": "Whether the agent mode is enabled for the organization. False for visitors.", "type": "boolean" } }, "type": "object" }, "knowledgeLimits": { "description": "Knowledge base limits. Only returned to staff of the organization.", "properties": { "pagesPerOrganization": { "type": "integer" }, "pagesPerCrawl": { "type": "integer" } }, "type": "object" }, "modules": { "description": "Modules enabled for the organization. ils is the catalog; intelligence is listed with search for older integrations.", "type": "array", "items": { "type": "string", "enum": [ "site", "events", "bookables", "messages", "map", "affluence", "ils", "search", "analytics", "intelligence" ] } }, "subscriptionStatus": { "type": "string", "enum": [ "trial", "paid", "free" ] } }, "type": "object", "additionalProperties": true } }, "responses": [], "parameters": [], "examples": [], "requestBodies": [], "headers": [], "securitySchemes": { "JWT": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "Personal API key, created in the admin under Settings > API keys. The key acts as its owner. Send it from a server only: browsers cannot send this header cross-origin." } } }, "security": [], "tags": [ { "name": "API keys" }, { "name": "Organization" }, { "name": "Events" }, { "name": "Bookings" }, { "name": "Pages" }, { "name": "Catalogue" }, { "name": "Footfall" }, { "name": "Maps" }, { "name": "Messages" } ] }