Files
slp-modular-cms/openapi/slpsoftware.v1.json
T
SluijsensandClaude Sonnet 5.5 f8d45eef54 OpenAPI-document van de SlpSoftware-host vastgelegd met snapshot-test en contactcontract
openapi/slpsoftware.v1.json is de bron voor de gegenereerde frontend-types; een test haalt het document van de echte host op en faalt bij afwijking (UPDATE_OPENAPI=1 herschrijft het bestand). De contactmodule voegt de herbruikbare foutresponses, de verplichte Idempotency-Key en de verplichte velden met maximale lengtes toe via een documenttransformer, zodat Core ongemoeid blijft.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-10 13:07:28 +01:00

1574 lines
34 KiB
JSON

{
"components": {
"responses": {
"RateLimited": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Too many requests. Retry after the number of seconds in the Retry-After header.",
"headers": {
"Retry-After": {
"description": "Seconds to wait before retrying.",
"schema": {
"format": "int32",
"type": "integer"
}
}
}
},
"TooLarge": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "The request body is too large."
},
"Validation": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblem"
}
}
},
"description": "Validation failed (also an expired, forged or other-site token as errors.token=[\"expired\"], a missing or non-UUID Idempotency-Key, and an unreadable body as errors.body=[\"invalid\"])."
}
},
"schemas": {
"AvailabilityStatus": {
"type": "integer"
},
"ChangePasswordRequest": {
"properties": {
"currentPassword": {
"type": "string"
},
"newPassword": {
"type": "string"
}
},
"required": [
"currentPassword",
"newPassword"
],
"type": "object"
},
"ChangeRoleRequest": {
"properties": {
"newRole": {
"type": "string"
}
},
"required": [
"newRole"
],
"type": "object"
},
"CompleteSetupRequest": {
"properties": {
"password": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"password"
],
"type": "object"
},
"ContactCaptchaInfo": {
"properties": {
"provider": {
"type": "string"
},
"siteKey": {
"type": "string"
}
},
"required": [
"provider",
"siteKey"
],
"type": "object"
},
"ContactMessageRequest": {
"properties": {
"captchaToken": {
"type": [
"null",
"string"
]
},
"email": {
"maxLength": 254,
"type": "string"
},
"hpCheck": {
"maxLength": 0,
"type": "string"
},
"message": {
"maxLength": 2000,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"subject": {
"maxLength": 100,
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"name",
"email",
"subject",
"message",
"hpCheck",
"token"
],
"type": "object"
},
"ContactTokenResponse": {
"properties": {
"captcha": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ContactCaptchaInfo"
}
]
},
"minSeconds": {
"format": "int32",
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
]
},
"token": {
"type": "string"
}
},
"required": [
"token",
"minSeconds",
"captcha"
],
"type": "object"
},
"CreateCmsInstanceRequest": {
"properties": {
"apiKey": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"name",
"url",
"apiKey"
],
"type": "object"
},
"CreateOfferingRequest": {
"properties": {
"categoryId": {
"format": "uuid",
"type": [
"null",
"string"
]
},
"ctaLabel": {
"type": "string"
},
"description": {
"type": "string"
},
"featured": {
"default": false,
"type": "boolean"
},
"features": {
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"type": "string"
},
"priceNote": {
"type": "string"
},
"slug": {
"type": [
"null",
"string"
]
},
"title": {
"type": "string"
}
},
"required": [
"title",
"description",
"price",
"priceNote",
"features",
"ctaLabel"
],
"type": "object"
},
"CreateOwnerRequest": {
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"name",
"email",
"password"
],
"type": "object"
},
"InviteUserRequest": {
"properties": {
"email": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": [
"email",
"role"
],
"type": "object"
},
"LoginRequest": {
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"email",
"password"
],
"type": "object"
},
"OfferingCategoryRequest": {
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Problem": {
"description": "RFC 9457 problem details. Only the standard members are sent; nothing about the limiter, the policy or the caller.",
"properties": {
"status": {
"format": "int32",
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ProblemDetails": {
"properties": {
"detail": {
"type": [
"null",
"string"
]
},
"instance": {
"type": [
"null",
"string"
]
},
"status": {
"format": "int32",
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
]
},
"title": {
"type": [
"null",
"string"
]
},
"type": {
"type": [
"null",
"string"
]
}
},
"type": "object"
},
"PushStatusRequest": {
"properties": {
"disableMessage": {
"type": [
"null",
"string"
]
},
"isAvailable": {
"type": "boolean"
}
},
"required": [
"isAvailable",
"disableMessage"
],
"type": "object"
},
"ReceivedResponse": {
"properties": {
"status": {
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"RegisterMasterRequest": {
"properties": {
"masterUrl": {
"type": "string"
}
},
"required": [
"masterUrl"
],
"type": "object"
},
"ReorderOfferingsRequest": {
"properties": {
"orderedIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"orderedIds"
],
"type": "object"
},
"SetUserActiveRequest": {
"properties": {
"isActive": {
"type": "boolean"
}
},
"required": [
"isActive"
],
"type": "object"
},
"UpdateOfferingRequest": {
"properties": {
"categoryId": {
"format": "uuid",
"type": [
"null",
"string"
]
},
"ctaLabel": {
"type": "string"
},
"description": {
"type": "string"
},
"featured": {
"default": false,
"type": "boolean"
},
"features": {
"items": {
"type": "string"
},
"type": "array"
},
"price": {
"type": "string"
},
"priceNote": {
"type": "string"
},
"slug": {
"type": [
"null",
"string"
]
},
"title": {
"type": "string"
}
},
"required": [
"title",
"description",
"price",
"priceNote",
"features",
"ctaLabel"
],
"type": "object"
},
"UpdateProfileRequest": {
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"email"
],
"type": "object"
},
"UpdateStatusRequest": {
"properties": {
"newStatus": {
"$ref": "#/components/schemas/AvailabilityStatus"
},
"reason": {
"type": [
"null",
"string"
]
}
},
"required": [
"newStatus",
"reason"
],
"type": "object"
},
"ValidationProblem": {
"description": "A 400 answer. 'errors' maps the JSON field name (name, email, subject, message, token, idempotencyKey, body) to its error codes; the client maps codes to texts.",
"properties": {
"errors": {
"additionalProperties": {
"items": {
"enum": [
"required",
"tooLong",
"invalid",
"expired"
],
"type": "string"
},
"type": "array"
},
"type": "object"
},
"status": {
"format": "int32",
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ValidationProblemDetails": {
"properties": {
"detail": {
"type": [
"null",
"string"
]
},
"errors": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"instance": {
"type": [
"null",
"string"
]
},
"status": {
"format": "int32",
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
]
},
"title": {
"type": [
"null",
"string"
]
},
"type": {
"type": [
"null",
"string"
]
}
},
"type": "object"
}
}
},
"info": {
"title": "SlpModularCms.Api.SlpSoftware | v1",
"version": "1.0.0"
},
"openapi": "3.1.1",
"paths": {
"/api/v1/Availability/admin/status": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Availability"
]
}
},
"/api/v1/Availability/status": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Availability"
]
}
},
"/api/v1/CmsInstances": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"CmsInstance"
]
},
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateCmsInstanceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCmsInstanceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateCmsInstanceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"CmsInstance"
]
}
},
"/api/v1/CmsInstances/{id}/status": {
"put": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"CmsInstance"
]
}
},
"/api/v1/Invitation/complete": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CompleteSetupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteSetupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CompleteSetupRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Invitation"
]
}
},
"/api/v1/Invitation/validate": {
"get": {
"parameters": [
{
"in": "query",
"name": "token",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Invitation"
]
}
},
"/api/v1/Master/register": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RegisterMasterRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterMasterRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RegisterMasterRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Master"
]
}
},
"/api/v1/Master/registered-url": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Master"
]
}
},
"/api/v1/Master/status": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PushStatusRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushStatusRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PushStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Master"
]
}
},
"/api/v1/Setup/owner": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateOwnerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOwnerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateOwnerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Setup"
]
}
},
"/api/v1/Setup/status": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Setup"
]
}
},
"/api/v1/SlaveStatus": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SlaveStatus"
]
}
},
"/api/v1/System/capabilities": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"System"
]
}
},
"/api/v1/Users": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Users"
]
}
},
"/api/v1/Users/invite": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Users"
]
}
},
"/api/v1/Users/me": {
"put": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateProfileRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProfileRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProfileRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Users"
]
}
},
"/api/v1/Users/{userId}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Users"
]
}
},
"/api/v1/Users/{userId}/active": {
"put": {
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SetUserActiveRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetUserActiveRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SetUserActiveRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Users"
]
}
},
"/api/v1/Users/{userId}/role": {
"put": {
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ChangeRoleRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeRoleRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ChangeRoleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Users"
]
}
},
"/api/v1/auth/change-password": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Auth"
]
}
},
"/api/v1/auth/login": {
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Auth"
]
}
},
"/api/v1/auth/refresh": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Auth"
]
}
},
"/api/v1/auth/revoke": {
"post": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Auth"
]
}
},
"/api/v1/contact-messages": {
"post": {
"parameters": [
{
"description": "A UUID chosen by the client per attempt series. A replay within 24 hours is answered with the same 202 without storing the message twice.",
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactMessageRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReceivedResponse"
}
}
},
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/Validation"
},
"404": {
"description": "The contact form is closed on this site (the website shows its mailto fallback)."
},
"413": {
"$ref": "#/components/responses/TooLarge"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
},
"tags": [
"ContactMessages"
]
}
},
"/api/v1/contact-messages/token": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactTokenResponse"
}
}
},
"description": "OK"
},
"404": {
"description": "The contact form is closed on this site (the website shows its mailto fallback)."
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
},
"tags": [
"ContactMessages"
]
}
},
"/api/v1/offerings": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Offerings"
]
},
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateOfferingRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOfferingRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateOfferingRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Offerings"
]
}
},
"/api/v1/offerings/categories": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"OfferingCategories"
]
},
"post": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OfferingCategoryRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferingCategoryRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OfferingCategoryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"OfferingCategories"
]
}
},
"/api/v1/offerings/categories/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"OfferingCategories"
]
},
"put": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OfferingCategoryRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferingCategoryRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OfferingCategoryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"OfferingCategories"
]
}
},
"/api/v1/offerings/order": {
"put": {
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReorderOfferingsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReorderOfferingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReorderOfferingsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Offerings"
]
}
},
"/api/v1/offerings/{id}": {
"delete": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Offerings"
]
},
"put": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateOfferingRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateOfferingRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateOfferingRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Offerings"
]
}
},
"/health": {
"get": {
"operationId": "HealthCheck",
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SlpModularCms.Api.SlpSoftware"
]
}
}
},
"tags": [
{
"name": "SlpModularCms.Api.SlpSoftware"
},
{
"name": "System"
},
{
"name": "Availability"
},
{
"name": "Master"
},
{
"name": "ContactMessages"
},
{
"name": "Auth"
},
{
"name": "Invitation"
},
{
"name": "Setup"
},
{
"name": "Users"
},
{
"name": "CmsInstance"
},
{
"name": "SlaveStatus"
},
{
"name": "OfferingCategories"
},
{
"name": "Offerings"
}
]
}