{ "openapi": "3.1.0", "info": { "title": "Localisync Projects & Languages API", "version": "2.0.0", "description": "Session authentication, current workspace membership and RLS are required. Owner/Admin manage projects; all members read. Language/source and fallback policies are documented in the Projects & languages guides. Session cookie is __Host-localisync-session in HTTPS deployments; explicit local HTTP uses localisync-session." }, "paths": { "/api/v1/workspaces/{workspaceId}/projects": { "get": { "operationId": "listProjects", "summary": "List projects", "description": "Requires current workspace membership. All workspace roles can read this resource, including when archived.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100000, "default": 1 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "archived", "all" ], "default": "active" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsPage" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } }, "post": { "operationId": "createProject", "summary": "Create a project", "description": "Requires current Owner/Admin membership and an active workspace.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProject" }, "example": { "name": "Customer app", "sourceLocale": "en", "targetLocales": [ "fr", "fr-CA" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}": { "get": { "operationId": "getProject", "summary": "Read a project", "description": "Requires current workspace membership. All workspace roles can read this resource, including when archived.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } }, "patch": { "operationId": "renameProject", "summary": "Rename a project", "description": "Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameProject" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}/archive": { "post": { "operationId": "archiveProject", "summary": "Archive a project", "description": "Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}/restore": { "post": { "operationId": "restoreProject", "summary": "Restore a project", "description": "Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/languages": { "get": { "operationId": "listLanguages", "summary": "List project languages", "description": "Requires current workspace membership. All workspace roles can read this resource, including when archived. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100000, "default": 1 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "branchId", "in": "path", "required": true, "description": "Explicit branch UUID in this project. No implicit main selection.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguagesPage" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } }, "post": { "operationId": "addLanguage", "summary": "Add a target language", "description": "Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "branchId", "in": "path", "required": true, "description": "Explicit branch UUID in this project. No implicit main selection.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLanguage" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/languages/{locale}": { "patch": { "operationId": "changeFallback", "summary": "Change a language fallback", "description": "Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "locale", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 255 } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "branchId", "in": "path", "required": true, "description": "Explicit branch UUID in this project. No implicit main selection.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeFallback" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/languages/{locale}/activate": { "post": { "operationId": "activateLanguage", "summary": "Reactivate a language", "description": "Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "locale", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 255 } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "branchId", "in": "path", "required": true, "description": "Explicit branch UUID in this project. No implicit main selection.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/languages/{locale}/deactivate": { "post": { "operationId": "deactivateLanguage", "summary": "Deactivate a language", "description": "Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "locale", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 255 } }, { "name": "Origin", "in": "header", "required": true, "schema": { "type": "string", "description": "Must exactly match the configured panel origin." } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "branchId", "in": "path", "required": true, "description": "Explicit branch UUID in this project. No implicit main selection.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Version" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/languages/{locale}/fallback-chain": { "get": { "operationId": "getFallbackChain", "summary": "Read a fallback chain", "description": "Requires current workspace membership. All workspace roles can read this resource, including when archived. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "locale", "in": "path", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 255 } }, { "name": "branchId", "in": "path", "required": true, "description": "Explicit branch UUID in this project. No implicit main selection.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FallbackChain" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/locales": { "get": { "operationId": "searchLocales", "summary": "Search the language catalog", "description": "Requires a valid customer session. Validates or searches the local registered language catalog without an external network call.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100000, "default": 1 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255, "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalesPage" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/v1/locales/validate": { "get": { "operationId": "validateLocale", "summary": "Validate a language code", "description": "Requires a valid customer session. Validates or searches the local registered language catalog without an external network call.", "tags": [ "Projects & Languages" ], "security": [ { "session": [] } ], "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 255 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Locale" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "400": { "description": "Invalid fields or unsupported locale", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "403": { "description": "Insufficient role or invalid CSRF/Origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "404": { "description": "Resource unavailable in the current workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "409": { "description": "Version, lifecycle, graph or idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "429": { "description": "Request limit reached", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "integer" } }, "required": [ "message" ], "description": "Fastify route limits or the aggregate application limit may supply this response." } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Cache-Control": { "schema": { "type": "string", "const": "no-store" } } } } } } } }, "components": { "schemas": { "Project": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Trimmed; control characters are rejected. Names need not be unique." }, "sourceLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "version": { "type": "integer", "minimum": 1 }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "mainBranchId": { "type": "string", "format": "uuid" } }, "required": [ "id", "workspaceId", "name", "sourceLocale", "version", "archivedAt", "createdAt", "mainBranchId" ] }, "Language": { "type": "object", "additionalProperties": false, "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "name": { "type": "string" }, "active": { "type": "boolean" }, "source": { "type": "boolean" }, "fallbackLocale": { "type": [ "string", "null" ] } }, "required": [ "locale", "name", "active", "source", "fallbackLocale" ] }, "Locale": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "minLength": 2, "maxLength": 255 }, "name": { "type": "string" } }, "required": [ "code", "name" ] }, "Error": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "enum": [ "unauthorized", "forbidden", "invalid_request", "not_found", "conflict", "rate_limited", "unavailable" ] }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": { "type": "object", "additionalProperties": false, "properties": { "dependentLocales": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 255 } } }, "required": [ "dependentLocales" ] } }, "required": [ "error", "message" ] }, "Version": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "integer", "minimum": 1 } }, "required": [ "version" ] }, "CreateProject": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Trimmed; control characters are rejected. Names need not be unique." }, "sourceLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "targetLocales": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 255 }, "default": [] } }, "required": [ "name", "sourceLocale" ] }, "RenameProject": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "integer", "minimum": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Trimmed; control characters are rejected. Names need not be unique." } }, "required": [ "version", "name" ] }, "AddLanguage": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "integer", "minimum": 1 }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 } }, "required": [ "version", "locale" ] }, "ChangeFallback": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "integer", "minimum": 1 }, "fallbackLocale": { "type": "string", "minLength": 2, "maxLength": 255 } }, "required": [ "version", "fallbackLocale" ] }, "ProjectsPage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ] }, "LanguagesPage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" }, "version": { "type": "integer", "minimum": 1 } }, "required": [ "items", "page", "pageSize", "hasMore", "version" ] }, "LocalesPage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Locale" } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" }, "registryDate": { "type": "string", "format": "date" } }, "required": [ "items", "page", "pageSize", "hasMore", "registryDate" ] }, "FallbackChain": { "type": "object", "additionalProperties": false, "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "active": { "type": "boolean" }, "chain": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 255 } }, "version": { "type": "integer", "minimum": 1 } }, "required": [ "locale", "active", "chain", "version" ] } }, "securitySchemes": { "session": { "type": "apiKey", "in": "cookie", "name": "__Host-localisync-session" } } } }