{ "openapi": "3.1.0", "info": { "title": "Münderecat Content API", "version": "1.0.0", "description": "Release-pinned, read-only catalog and reader resources." }, "servers": [ { "url": "https://api.munderecat.com/v1" } ], "tags": [ { "name": "Reader" } ], "x-munderecat-target-binding-derivation": { "canonicalization": "sorted-json-utf8-v1", "rootAlgorithm": "sha-256", "idAlgorithm": "uuid-v8-from-sha-256", "idDomain": "munderecat-target-binding-v1" }, "paths": { "/contexts/{contextId}/chapters/{chapterId}/references": {"get":{"operationId":"chapter_reference_context_get","tags":["Reader"],"summary":"Read optional current chapter reference context independently of immutable passages","parameters":[{"$ref":"#/components/parameters/ContextId"},{"$ref":"#/components/parameters/ChapterId"}],"responses":{"200":{"description":"Current chapter reference context, independently revisioned","headers":{"Cache-Control":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChapterReferenceContextOperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"404":{"$ref":"#/components/responses/NotFoundOrForbidden"},"406":{"$ref":"#/components/responses/UnsupportedContract"},"409":{"$ref":"#/components/responses/ConflictOrContinuation"},"422":{"$ref":"#/components/responses/ResponseBudgetExceeded"},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"$ref":"#/components/responses/ServiceOrIntegrityFailure"},"504":{"$ref":"#/components/responses/Timeout"}}}}, "/contexts/{contextId}/managed-passages": { "get": { "operationId": "managed_passage_catalog_get", "tags": ["Reader"], "summary": "Read the current managed passage catalog independently of immutable passage releases", "parameters": [{ "$ref": "#/components/parameters/ContextId" }], "responses": { "200": { "description": "Current active passage memberships and placements, independently revisioned; identities may be unreferenced", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedPassageCatalogOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/reading-works": { "get": { "operationId": "reading_works_get", "tags": ["Reader"], "summary": "Read source-pinned library presentations of existing chapters", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "name": "view", "in": "query", "required": false, "description": "catalog returns every registered work; home returns the explicitly curated home selection in display order. Omission means catalog. Editorial classifications are never included.", "schema": { "type": "string", "enum": ["catalog", "home"], "default": "catalog" } } ], "responses": { "200": { "description": "Reading works catalog domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadingWorksOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/passage-releases/{passageReleaseId}/map": { "get": { "operationId": "passage_map_get", "tags": ["Reader"], "summary": "Read the compact accepted passage map without full placement text", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/PassageReleaseId" } ], "responses": { "200": { "description": "Accepted passage map domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PassageMapOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/catalog": { "get": { "operationId": "catalog_get", "tags": ["Reader"], "summary": "Resolve the current accepted reader catalog and immutable content context", "responses": { "200": { "description": "Catalog domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/targets": { "get": { "operationId": "target_registry_get", "tags": ["Reader"], "summary": "Read the target registry pinned by an immutable content context", "parameters": [ { "$ref": "#/components/parameters/ContextId" } ], "responses": { "200": { "description": "Target registry domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetRegistryOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/chapters/{chapterId}": { "get": { "operationId": "chapter_get", "tags": ["Reader"], "summary": "Read one exact source chapter under an immutable content context", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/ChapterId" } ], "responses": { "200": { "description": "Chapter domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChapterOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/chapters/{chapterId}/headings": { "get": { "operationId": "chapter_headings_get", "tags": ["Reader"], "summary": "Read the structural heading navigation for one chapter", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/ChapterId" } ], "responses": { "200": { "description": "Chapter heading navigation domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChapterHeadingsOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/chapters/{chapterId}/targets/{targetKey}": { "get": { "operationId": "chapter_target_get", "tags": ["Reader"], "summary": "Read one on-demand target using its exact registry binding", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/ChapterId" }, { "$ref": "#/components/parameters/TargetKey" }, { "$ref": "#/components/parameters/BindingId" } ], "responses": { "200": { "description": "Target domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/addresses": { "get": { "operationId": "addressing_get", "tags": ["Reader"], "summary": "Read the localized canonical chapter address inventory", "parameters": [ { "$ref": "#/components/parameters/ContextId" } ], "responses": { "200": { "description": "Public addressing domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressingOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/routes/{locale}/{bookAlias}/{chapterAlias}": { "get": { "operationId": "chapter_route_resolve", "tags": ["Reader"], "summary": "Resolve a durable localized reader path to its stable chapter identity", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/Locale" }, { "$ref": "#/components/parameters/BookAlias" }, { "$ref": "#/components/parameters/ChapterAlias" } ], "responses": { "200": { "description": "Reader route resolution result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChapterRouteOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } } } }, "/contexts/{contextId}/chapters/{chapterId}/notes/{noteReleaseId}": { "get": { "operationId": "chapter_notes_get", "tags": [ "Reader" ], "summary": "Read an explicitly pinned source notes release for one chapter", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/ChapterId" }, { "$ref": "#/components/parameters/NoteReleaseId" } ], "responses": { "200": { "description": "Chapter source notes domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChapterNotesOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } }, "description": "The content context pins the compatible source, not the note authority. The requested note release is immutable and independently authoritative." } }, "/contexts/{contextId}/chapters/{chapterId}/passages/{passageReleaseId}": { "get": { "operationId": "chapter_passages_get", "tags": [ "Reader" ], "summary": "Read accepted local passage placements and lineage for one chapter", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/ChapterId" }, { "$ref": "#/components/parameters/PassageReleaseId" } ], "responses": { "200": { "description": "Accepted passage domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChapterPassagesOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } }, "description": "The content context pins the compatible source, not the note authority. The requested note release is immutable and independently authoritative." } }, "/contexts/{contextId}/passage-releases/{passageReleaseId}/identities/{identityId}": { "get": { "operationId": "passage_identity_get", "tags": [ "Reader" ], "summary": "Read every local placement of one accepted passage identity", "parameters": [ { "$ref": "#/components/parameters/ContextId" }, { "$ref": "#/components/parameters/PassageReleaseId" }, { "$ref": "#/components/parameters/PassageIdentityId" } ], "responses": { "200": { "description": "Accepted passage domain result", "headers": { "Cache-Control": { "schema": { "type": "string" } }, "ETag": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PassageIdentityOperationResponse" } } } }, "400": { "$ref": "#/components/responses/InvalidRequest" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "404": { "$ref": "#/components/responses/NotFoundOrForbidden" }, "406": { "$ref": "#/components/responses/UnsupportedContract" }, "409": { "$ref": "#/components/responses/ConflictOrContinuation" }, "422": { "$ref": "#/components/responses/ResponseBudgetExceeded" }, "429": { "$ref": "#/components/responses/RateLimited" }, "503": { "$ref": "#/components/responses/ServiceOrIntegrityFailure" }, "504": { "$ref": "#/components/responses/Timeout" } }, "description": "The content context pins the compatible source, not the note authority. The requested note release is immutable and independently authoritative." } } }, "components": { "parameters": { "NoteReleaseId": { "name": "noteReleaseId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" } }, "ContextId": { "name": "contextId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" } }, "ChapterId": { "name": "chapterId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" } }, "TargetKey": { "name": "targetKey", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/TargetKey" } }, "BindingId": { "name": "binding", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" } }, "Locale": { "name": "locale", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/AddressLocale" } }, "BookAlias": { "name": "bookAlias", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/RouteAlias" } }, "ChapterAlias": { "name": "chapterAlias", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/RouteAlias" } }, "PassageReleaseId": { "name": "passageReleaseId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" } }, "PassageIdentityId": { "name": "identityId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" } } }, "responses": { "InvalidRequest": { "description": "The public request shape is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequestErrorEnvelope" } } } }, "Unauthenticated": { "description": "Authentication is required without identity disclosure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthenticatedErrorEnvelope" } } } }, "NotFoundOrForbidden": { "description": "The resource is absent or not visible; the cases are indistinguishable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundOrForbiddenErrorEnvelope" } } } }, "UnsupportedContract": { "description": "The client contract is unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnsupportedContractErrorEnvelope" } } } }, "ConflictOrContinuation": { "description": "The request conflicts or its immutable context is unusable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictStatusErrorEnvelope" } } } }, "ResponseBudgetExceeded": { "description": "The complete resource exceeds its response budget", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBudgetExceededErrorEnvelope" } } } }, "RateLimited": { "description": "The request is rate limited with bounded retry metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedErrorEnvelope" } } } }, "ServiceOrIntegrityFailure": { "description": "The service is unavailable or an integrity check failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusErrorEnvelope" } } } }, "Timeout": { "description": "The bounded operation timed out", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeoutErrorEnvelope" } } } } }, "schemas": { "Uuid": { "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "Sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "TargetKey": { "type": "string", "pattern": "^[a-z]{2,3}(?:-[a-z0-9]+)+$", "maxLength": 80 }, "LanguageTag": { "type": "string", "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]+)*$", "maxLength": 35 }, "AddressLocale": { "type": "string", "enum": ["en", "tr"] }, "RouteAlias": { "type": "string", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "maxLength": 96 }, "ScriptCode": { "type": "string", "pattern": "^[A-Z][a-z]{3}$" }, "Direction": { "type": "string", "enum": ["ltr", "rtl"] }, "LogicalTargetKind": { "type": "string", "enum": ["text_release", "render_projection"] }, "SourceApiRelease": { "type": "object", "additionalProperties": false, "required": [ "apiDeploymentId", "apiDeploymentRoot", "apiContractReleaseId", "codeReleaseId", "schemaReleaseId", "dataReleaseSetRoot", "policyReleaseSetRoot", "exposureManifestRoot" ], "properties": { "apiDeploymentId": { "$ref": "#/components/schemas/Uuid" }, "apiDeploymentRoot": { "$ref": "#/components/schemas/Sha256" }, "apiContractReleaseId": { "$ref": "#/components/schemas/Uuid" }, "codeReleaseId": { "$ref": "#/components/schemas/Uuid" }, "schemaReleaseId": { "$ref": "#/components/schemas/Uuid" }, "dataReleaseSetRoot": { "$ref": "#/components/schemas/Sha256" }, "policyReleaseSetRoot": { "$ref": "#/components/schemas/Sha256" }, "exposureManifestRoot": { "$ref": "#/components/schemas/Sha256" } } }, "TargetRegistryReleaseRef": { "type": "object", "additionalProperties": false, "required": ["releaseId", "releaseRoot"], "properties": { "releaseId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" } } }, "AddressReleaseRef": { "type": "object", "additionalProperties": false, "required": ["releaseId", "releaseRoot", "routePolicyId", "routePolicyRoot"], "properties": { "releaseId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" }, "routePolicyId": { "$ref": "#/components/schemas/Uuid" }, "routePolicyRoot": { "$ref": "#/components/schemas/Sha256" } } }, "ContentReleaseContext": { "type": "object", "additionalProperties": false, "required": [ "contentContextId", "contextRoot", "contentApiContractReleaseId", "contentApiContractRoot", "source", "targetRegistry" ], "properties": { "contentContextId": { "$ref": "#/components/schemas/Uuid" }, "contextRoot": { "$ref": "#/components/schemas/Sha256" }, "contentApiContractReleaseId": { "$ref": "#/components/schemas/Uuid" }, "contentApiContractRoot": { "$ref": "#/components/schemas/Sha256" }, "source": { "$ref": "#/components/schemas/SourceApiRelease" }, "targetRegistry": { "$ref": "#/components/schemas/TargetRegistryReleaseRef" } } }, "NullableContentReleaseContext": { "oneOf": [ { "$ref": "#/components/schemas/ContentReleaseContext" }, { "type": "null" } ] }, "CatalogResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind"], "properties": { "kind": { "const": "catalog" } } }, "TargetRegistryResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId"], "properties": { "kind": { "const": "target_registry" }, "contextId": { "$ref": "#/components/schemas/Uuid" } } }, "AddressingResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId"], "properties": { "kind": { "const": "addressing" }, "contextId": { "$ref": "#/components/schemas/Uuid" } } }, "ChapterResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId", "chapterId"], "properties": { "kind": { "const": "chapter" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" } } }, "ChapterTargetResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId", "chapterId", "targetKey", "bindingId"], "properties": { "kind": { "const": "chapter_target" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" }, "targetKey": { "$ref": "#/components/schemas/TargetKey" }, "bindingId": { "$ref": "#/components/schemas/Uuid" } } }, "ChapterHeadingsResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId", "chapterId"], "properties": { "kind": { "const": "chapter_headings" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" } } }, "ChapterRouteResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId", "locale", "bookAlias", "chapterAlias"], "properties": { "kind": { "const": "chapter_route" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "locale": { "$ref": "#/components/schemas/AddressLocale" }, "bookAlias": { "$ref": "#/components/schemas/RouteAlias" }, "chapterAlias": { "$ref": "#/components/schemas/RouteAlias" } } }, "ResourceIdentity": { "oneOf": [ { "$ref": "#/components/schemas/ManagedPassageCatalogResourceIdentity" }, { "$ref": "#/components/schemas/ReadingWorksResourceIdentity" }, { "$ref": "#/components/schemas/ChapterReferenceContextResourceIdentity" }, { "$ref": "#/components/schemas/CatalogResourceIdentity" }, { "$ref": "#/components/schemas/TargetRegistryResourceIdentity" }, { "$ref": "#/components/schemas/AddressingResourceIdentity" }, { "$ref": "#/components/schemas/ChapterResourceIdentity" }, { "$ref": "#/components/schemas/ChapterHeadingsResourceIdentity" }, { "$ref": "#/components/schemas/ChapterTargetResourceIdentity" }, { "$ref": "#/components/schemas/ChapterRouteResourceIdentity" }, { "$ref": "#/components/schemas/ChapterNotesResourceIdentity" }, {"$ref":"#/components/schemas/ChapterPassagesResourceIdentity"}, {"$ref":"#/components/schemas/PassageIdentityResourceIdentity"}, {"$ref":"#/components/schemas/PassageMapResourceIdentity"}] }, "AvailableStateContext": { "type": "object", "additionalProperties": false, "required": ["reasonCode", "retryAfterMs", "statusResourceId", "replacementContextId"], "properties": { "reasonCode": { "type": "null" }, "retryAfterMs": { "type": "null" }, "statusResourceId": { "type": "null" }, "replacementContextId": { "type": "null" } } }, "PendingStateContext": { "type": "object", "additionalProperties": false, "required": ["reasonCode", "retryAfterMs", "statusResourceId", "replacementContextId"], "properties": { "reasonCode": { "type": "string", "minLength": 1, "maxLength": 80 }, "retryAfterMs": { "type": "integer", "minimum": 0 }, "statusResourceId": { "oneOf": [ { "$ref": "#/components/schemas/Uuid" }, { "type": "null" } ] }, "replacementContextId": { "type": "null" } } }, "UnavailableStateContext": { "type": "object", "additionalProperties": false, "required": ["reasonCode", "retryAfterMs", "statusResourceId", "replacementContextId"], "properties": { "reasonCode": { "type": "string", "minLength": 1, "maxLength": 80 }, "retryAfterMs": { "type": "null" }, "statusResourceId": { "type": "null" }, "replacementContextId": { "type": "null" } } }, "RetiredStateContext": { "type": "object", "additionalProperties": false, "required": ["reasonCode", "retryAfterMs", "statusResourceId", "replacementContextId"], "properties": { "reasonCode": { "type": "string", "minLength": 1, "maxLength": 80 }, "retryAfterMs": { "type": "null" }, "statusResourceId": { "type": "null" }, "replacementContextId": { "oneOf": [ { "$ref": "#/components/schemas/Uuid" }, { "type": "null" } ] } } }, "TextTargetDescriptor": { "type": "object", "additionalProperties": false, "required": ["key", "kind", "languageTag", "scriptCode", "direction", "label"], "properties": { "key": { "$ref": "#/components/schemas/TargetKey" }, "kind": { "const": "text_release" }, "languageTag": { "$ref": "#/components/schemas/LanguageTag" }, "scriptCode": { "$ref": "#/components/schemas/ScriptCode" }, "direction": { "$ref": "#/components/schemas/Direction" }, "label": { "type": "string", "minLength": 1, "maxLength": 80 } } }, "RenderProjectionTargetDescriptor": { "type": "object", "additionalProperties": false, "required": ["key", "kind", "languageTag", "scriptCode", "direction", "label"], "properties": { "key": { "$ref": "#/components/schemas/TargetKey" }, "kind": { "const": "render_projection" }, "languageTag": { "$ref": "#/components/schemas/LanguageTag" }, "scriptCode": { "$ref": "#/components/schemas/ScriptCode" }, "direction": { "$ref": "#/components/schemas/Direction" }, "label": { "type": "string", "minLength": 1, "maxLength": 80 } } }, "TargetDescriptor": { "oneOf": [ { "$ref": "#/components/schemas/TextTargetDescriptor" }, { "$ref": "#/components/schemas/RenderProjectionTargetDescriptor" } ] }, "CoreTextReleaseAuthority": { "type": "object", "additionalProperties": false, "required": ["kind", "releaseId", "textVersionId", "releaseRoot"], "properties": { "kind": { "const": "core_text_release" }, "releaseId": { "$ref": "#/components/schemas/Uuid" }, "textVersionId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" } } }, "TextReleaseAuthority": { "type": "object", "additionalProperties": false, "required": ["kind", "releaseId", "textVersionId", "releaseRoot"], "properties": { "kind": { "const": "text_release" }, "releaseId": { "$ref": "#/components/schemas/Uuid" }, "textVersionId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" } } }, "RenderProjectionAuthority": { "type": "object", "additionalProperties": false, "required": ["kind", "releaseId", "sourceTextVersionId", "releaseRoot", "profileKey"], "properties": { "kind": { "const": "render_projection" }, "releaseId": { "$ref": "#/components/schemas/Uuid" }, "sourceTextVersionId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" }, "profileKey": { "type": "string", "pattern": "^[a-z0-9][a-z0-9._/-]*$", "maxLength": 100 } } }, "CoreReaderDelivery": { "type": "object", "additionalProperties": false, "required": ["kind", "releaseId", "releaseRoot"], "properties": { "kind": { "const": "core_reader" }, "releaseId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" } } }, "OttomanReaderDelivery": { "type": "object", "additionalProperties": false, "required": ["kind", "releaseId", "releaseRoot"], "properties": { "kind": { "const": "ottoman_reader" }, "releaseId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" } } }, "TargetRenderDelivery": { "type": "object", "additionalProperties": false, "required": ["kind", "releaseId", "releaseRoot", "deploymentId"], "properties": { "kind": { "const": "target_render" }, "releaseId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" }, "deploymentId": { "$ref": "#/components/schemas/Uuid" } } }, "SourceCompatibility": { "type": "object", "additionalProperties": false, "required": ["coreReleaseId", "coreRoot", "sourceTextVersionId"], "properties": { "coreReleaseId": { "$ref": "#/components/schemas/Uuid" }, "coreRoot": { "$ref": "#/components/schemas/Sha256" }, "sourceTextVersionId": { "$ref": "#/components/schemas/Uuid" } } }, "CoreTargetBinding": { "type": "object", "additionalProperties": false, "required": ["bindingId", "bindingRoot", "descriptor", "projectionKind", "authority", "delivery", "sourceCompatibility"], "properties": { "bindingId": { "$ref": "#/components/schemas/Uuid" }, "bindingRoot": { "$ref": "#/components/schemas/Sha256" }, "descriptor": { "$ref": "#/components/schemas/TextTargetDescriptor" }, "projectionKind": { "const": "source_bound_blocks" }, "authority": { "$ref": "#/components/schemas/CoreTextReleaseAuthority" }, "delivery": { "$ref": "#/components/schemas/CoreReaderDelivery" }, "sourceCompatibility": { "$ref": "#/components/schemas/SourceCompatibility" } } }, "RenderProjectionTargetBinding": { "type": "object", "additionalProperties": false, "required": ["bindingId", "bindingRoot", "descriptor", "projectionKind", "authority", "delivery", "sourceCompatibility"], "properties": { "bindingId": { "$ref": "#/components/schemas/Uuid" }, "bindingRoot": { "$ref": "#/components/schemas/Sha256" }, "descriptor": { "$ref": "#/components/schemas/RenderProjectionTargetDescriptor" }, "projectionKind": { "const": "source_bound_blocks" }, "authority": { "$ref": "#/components/schemas/RenderProjectionAuthority" }, "delivery": { "$ref": "#/components/schemas/OttomanReaderDelivery" }, "sourceCompatibility": { "$ref": "#/components/schemas/SourceCompatibility" } } }, "DeliveredTextTargetBinding": { "type": "object", "additionalProperties": false, "required": ["bindingId", "bindingRoot", "descriptor", "projectionKind", "authority", "delivery", "sourceCompatibility"], "properties": { "bindingId": { "$ref": "#/components/schemas/Uuid" }, "bindingRoot": { "$ref": "#/components/schemas/Sha256" }, "descriptor": { "$ref": "#/components/schemas/TextTargetDescriptor" }, "projectionKind": { "const": "standalone_text" }, "authority": { "$ref": "#/components/schemas/TextReleaseAuthority" }, "delivery": { "$ref": "#/components/schemas/TargetRenderDelivery" }, "sourceCompatibility": { "$ref": "#/components/schemas/SourceCompatibility" }, "alignmentReleaseId": { "$ref": "#/components/schemas/Uuid", "description": "Optional immutable sentence-alignment release. Updating it creates a new binding and content context without changing text identity." } } }, "TargetBinding": { "oneOf": [ { "$ref": "#/components/schemas/CoreTargetBinding" }, { "$ref": "#/components/schemas/RenderProjectionTargetBinding" }, { "$ref": "#/components/schemas/DeliveredTextTargetBinding" } ] }, "TargetRegistryData": { "type": "object", "additionalProperties": false, "required": ["registry", "targets"], "properties": { "registry": { "$ref": "#/components/schemas/TargetRegistryReleaseRef" }, "targets": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/TargetBinding" } } } }, "AvailableTargetAvailability": { "type": "object", "additionalProperties": false, "required": ["targetKey", "bindingId", "state", "reasonCode"], "properties": { "targetKey": { "$ref": "#/components/schemas/TargetKey" }, "bindingId": { "$ref": "#/components/schemas/Uuid" }, "state": { "const": "available" }, "reasonCode": { "type": "null" } } }, "UnavailableTargetAvailability": { "type": "object", "additionalProperties": false, "required": ["targetKey", "bindingId", "state", "reasonCode"], "properties": { "targetKey": { "$ref": "#/components/schemas/TargetKey" }, "bindingId": { "$ref": "#/components/schemas/Uuid" }, "state": { "enum": ["pending", "unavailable"] }, "reasonCode": { "type": "string", "minLength": 1, "maxLength": 80 } } }, "TargetAvailability": { "oneOf": [ { "$ref": "#/components/schemas/AvailableTargetAvailability" }, { "$ref": "#/components/schemas/UnavailableTargetAvailability" } ] }, "LocalizedChapterAddress": { "type": "object", "additionalProperties": false, "required": ["locale", "bookLabel", "chapterLabel", "bookAlias", "chapterAlias", "path"], "properties": { "locale": { "$ref": "#/components/schemas/AddressLocale" }, "bookLabel": { "type": "string", "minLength": 1, "maxLength": 240 }, "chapterLabel": { "type": "string", "minLength": 1, "maxLength": 400 }, "bookAlias": { "$ref": "#/components/schemas/RouteAlias" }, "chapterAlias": { "$ref": "#/components/schemas/RouteAlias" }, "path": { "type": "string", "pattern": "^/(?:en|tr)/[a-z0-9]+(?:-[a-z0-9]+)*/[a-z0-9]+(?:-[a-z0-9]+)*$", "maxLength": 204 } } }, "ChapterRouteResolution": { "type": "object", "additionalProperties": false, "required": ["addressRelease", "status", "bookId", "chapterId", "canonicalAddress"], "properties": { "addressRelease": { "$ref": "#/components/schemas/AddressReleaseRef" }, "status": { "enum": ["canonical", "redirect"] }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" }, "canonicalAddress": { "$ref": "#/components/schemas/LocalizedChapterAddress" } } }, "AddressedChapter": { "type": "object", "additionalProperties": false, "required": ["chapterId", "bookId", "addresses"], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "addresses": { "type": "array", "minItems": 1, "maxItems": 2, "items": { "$ref": "#/components/schemas/LocalizedChapterAddress" } } } }, "AddressingData": { "type": "object", "additionalProperties": false, "required": ["release", "chapters"], "properties": { "release": { "$ref": "#/components/schemas/AddressReleaseRef" }, "chapters": { "type": "array", "items": { "$ref": "#/components/schemas/AddressedChapter" } } } }, "CatalogChapter": { "type": "object", "additionalProperties": false, "required": [ "chapterId", "bookId", "bookPosition", "chapterPosition", "canonicalChapterOrdinal", "chapterStem", "title", "bookTitle", "targets" ], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "bookPosition": { "type": "integer", "minimum": 0 }, "chapterPosition": { "type": "integer", "minimum": 0 }, "canonicalChapterOrdinal": { "type": "integer", "minimum": 0 }, "chapterStem": { "type": "string", "minLength": 1, "maxLength": 240 }, "title": { "type": "string", "minLength": 1, "maxLength": 400 }, "bookTitle": { "type": "string", "minLength": 1, "maxLength": 240 }, "targets": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/TargetAvailability" } } } }, "CatalogData": { "type": "object", "additionalProperties": false, "required": ["chapters"], "properties": { "chapters": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogChapter" } } } }, "SentenceBlock": { "type": "object", "additionalProperties": false, "required": ["sentenceId", "position", "text", "followingText"], "properties": { "sentenceId": { "$ref": "#/components/schemas/Uuid" }, "position": { "type": "integer", "minimum": 0 }, "text": { "type": "string" }, "followingText": { "type": "string" } } }, "ParagraphBlock": { "type": "object", "additionalProperties": false, "required": ["paragraphId", "position", "sentences", "followingText"], "properties": { "paragraphId": { "$ref": "#/components/schemas/Uuid" }, "position": { "type": "integer", "minimum": 0 }, "sentences": { "type": "array", "items": { "$ref": "#/components/schemas/SentenceBlock" } }, "followingText": { "type": "string" } } }, "ChapterProjection": { "type": "object", "additionalProperties": false, "required": [ "chapterId", "bookId", "textVersionId", "chapterPosition", "title", "bookTitle", "initialText", "paragraphs", "reconstructionRoot" ], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "textVersionId": { "$ref": "#/components/schemas/Uuid" }, "chapterPosition": { "type": "integer", "minimum": 0 }, "title": { "type": "string", "minLength": 1, "maxLength": 400 }, "bookTitle": { "type": "string", "minLength": 1, "maxLength": 240 }, "initialText": { "type": "string" }, "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/ParagraphBlock" } }, "reconstructionRoot": { "$ref": "#/components/schemas/Sha256" } } }, "SourceBoundTargetProjection": { "type": "object", "additionalProperties": false, "required": [ "chapterId", "targetKey", "bindingId", "renderKind", "initialText", "paragraphs", "standaloneText", "reconstructionRoot", "fallbackUsed" ], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "targetKey": { "$ref": "#/components/schemas/TargetKey" }, "bindingId": { "$ref": "#/components/schemas/Uuid" }, "renderKind": { "const": "source_bound_blocks" }, "initialText": { "type": "string" }, "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/ParagraphBlock" } }, "standaloneText": { "type": "null" }, "reconstructionRoot": { "$ref": "#/components/schemas/Sha256" }, "fallbackUsed": { "type": "boolean" } } }, "StandaloneTargetProjection": { "type": "object", "additionalProperties": false, "required": [ "chapterId", "targetKey", "bindingId", "renderKind", "initialText", "paragraphs", "standaloneText", "reconstructionRoot", "fallbackUsed" ], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "targetKey": { "$ref": "#/components/schemas/TargetKey" }, "bindingId": { "$ref": "#/components/schemas/Uuid" }, "renderKind": { "const": "standalone_text" }, "initialText": { "const": "" }, "paragraphs": { "type": "array", "maxItems": 0, "items": { "$ref": "#/components/schemas/ParagraphBlock" } }, "standaloneText": { "type": "string", "minLength": 1 }, "reconstructionRoot": { "$ref": "#/components/schemas/Sha256" }, "fallbackUsed": { "const": false }, "translationAlignment": { "$ref": "#/components/schemas/TranslationAlignment" } } }, "TranslationSourceSpan": { "type": "object", "additionalProperties": false, "required": ["sentenceId", "startScalar", "endScalar"], "properties": { "sentenceId": { "$ref": "#/components/schemas/Uuid" }, "startScalar": { "type": "integer", "minimum": 0 }, "endScalar": { "type": ["integer", "null"], "minimum": 1, "description": "Null means the end of the complete source sentence." } } }, "TranslationAlignmentUnit": { "type": "object", "additionalProperties": false, "required": ["id", "groupId", "startScalar", "endScalar", "sourceSpans"], "properties": { "id": { "$ref": "#/components/schemas/Uuid" }, "groupId": { "$ref": "#/components/schemas/Uuid" }, "startScalar": { "type": "integer", "minimum": 0 }, "endScalar": { "type": "integer", "minimum": 1 }, "sourceSpans": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/TranslationSourceSpan" } } } }, "TranslationAlignment": { "type": "object", "additionalProperties": false, "description": "Optional accepted sentence links over unchanged target text. Target offsets are Unicode scalar half-open positions relative to standaloneText, not byte or UTF-16 offsets. Missing links do not imply missing translation. Source spans retain alignment order and may represent part of a sentence.", "required": ["alignmentReleaseId", "sourceTextVersionId", "targetTextVersionId", "units"], "properties": { "alignmentReleaseId": { "$ref": "#/components/schemas/Uuid" }, "sourceTextVersionId": { "$ref": "#/components/schemas/Uuid" }, "targetTextVersionId": { "$ref": "#/components/schemas/Uuid" }, "units": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationAlignmentUnit" } } } }, "TargetProjection": { "oneOf": [ { "$ref": "#/components/schemas/SourceBoundTargetProjection" }, { "$ref": "#/components/schemas/StandaloneTargetProjection" } ] }, "HeadingScriptClass": { "type": "string", "enum": ["latin", "arabic", "mixed_arabic_latin", "other"] }, "HeadingNavigationItem": { "type": "object", "additionalProperties": false, "required": [ "headingId", "parentHeadingId", "markerSpanId", "sentenceId", "position", "level", "depth", "startScalar", "endScalar", "text", "scriptClass" ], "properties": { "headingId": { "$ref": "#/components/schemas/Uuid" }, "parentHeadingId": { "oneOf": [ { "$ref": "#/components/schemas/Uuid" }, { "type": "null" } ] }, "markerSpanId": { "$ref": "#/components/schemas/Uuid" }, "sentenceId": { "$ref": "#/components/schemas/Uuid" }, "position": { "type": "integer", "minimum": 1 }, "level": { "type": "integer", "minimum": 1 }, "depth": { "type": "integer", "minimum": 0 }, "startScalar": { "type": "integer", "minimum": 0 }, "endScalar": { "type": "integer", "minimum": 1 }, "text": { "type": "string", "minLength": 1 }, "scriptClass": { "$ref": "#/components/schemas/HeadingScriptClass" } } }, "ChapterHeadingsProjection": { "type": "object", "additionalProperties": false, "required": ["chapterId", "coreReleaseId", "headingReleaseId", "headings"], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "coreReleaseId": { "$ref": "#/components/schemas/Uuid" }, "headingReleaseId": { "$ref": "#/components/schemas/Uuid" }, "headings": { "type": "array", "items": { "$ref": "#/components/schemas/HeadingNavigationItem" } } } }, "CatalogAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "catalog_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/CatalogResourceIdentity" }, "data": { "$ref": "#/components/schemas/CatalogData" }, "page": { "type": "null" } } }, "TargetRegistryAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "target_registry_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/TargetRegistryResourceIdentity" }, "data": { "$ref": "#/components/schemas/TargetRegistryData" }, "page": { "type": "null" } } }, "ChapterAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterResourceIdentity" }, "data": { "$ref": "#/components/schemas/ChapterProjection" }, "page": { "type": "null" } } }, "TargetAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_target_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterTargetResourceIdentity" }, "data": { "$ref": "#/components/schemas/TargetProjection" }, "page": { "type": "null" } } }, "ChapterHeadingsAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_headings_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterHeadingsResourceIdentity" }, "data": { "$ref": "#/components/schemas/ChapterHeadingsProjection" }, "page": { "type": "null" } } }, "ChapterRouteAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_route_resolve" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterRouteResourceIdentity" }, "data": { "$ref": "#/components/schemas/ChapterRouteResolution" }, "page": { "type": "null" } } }, "AddressingAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "addressing_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/AddressingResourceIdentity" }, "data": { "$ref": "#/components/schemas/AddressingData" }, "page": { "type": "null" } } }, "AddressingUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "addressing_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/AddressingResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ChapterRouteUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_route_resolve" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterRouteResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "CatalogPendingResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "catalog_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "pending" }, "stateContext": { "$ref": "#/components/schemas/PendingStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/CatalogResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "CatalogUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "catalog_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/NullableContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/CatalogResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "TargetRegistryPendingResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "target_registry_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "pending" }, "stateContext": { "$ref": "#/components/schemas/PendingStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/TargetRegistryResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "TargetRegistryUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "target_registry_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/TargetRegistryResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "TargetRegistryRetiredResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "target_registry_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "retired" }, "stateContext": { "$ref": "#/components/schemas/RetiredStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/TargetRegistryResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ChapterPendingResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "pending" }, "stateContext": { "$ref": "#/components/schemas/PendingStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ChapterUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ChapterRetiredResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "retired" }, "stateContext": { "$ref": "#/components/schemas/RetiredStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "TargetPendingResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_target_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "pending" }, "stateContext": { "$ref": "#/components/schemas/PendingStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterTargetResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "TargetUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_target_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterTargetResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "TargetRetiredResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_target_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "retired" }, "stateContext": { "$ref": "#/components/schemas/RetiredStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterTargetResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ChapterHeadingsUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_headings_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterHeadingsResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "CatalogOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/CatalogAvailableResponse" }, { "$ref": "#/components/schemas/CatalogPendingResponse" }, { "$ref": "#/components/schemas/CatalogUnavailableResponse" } ] }, "TargetRegistryOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/TargetRegistryAvailableResponse" }, { "$ref": "#/components/schemas/TargetRegistryPendingResponse" }, { "$ref": "#/components/schemas/TargetRegistryUnavailableResponse" }, { "$ref": "#/components/schemas/TargetRegistryRetiredResponse" } ] }, "ChapterOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/ChapterAvailableResponse" }, { "$ref": "#/components/schemas/ChapterPendingResponse" }, { "$ref": "#/components/schemas/ChapterUnavailableResponse" }, { "$ref": "#/components/schemas/ChapterRetiredResponse" } ] }, "TargetOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/TargetAvailableResponse" }, { "$ref": "#/components/schemas/TargetPendingResponse" }, { "$ref": "#/components/schemas/TargetUnavailableResponse" }, { "$ref": "#/components/schemas/TargetRetiredResponse" } ] }, "ChapterHeadingsOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/ChapterHeadingsAvailableResponse" }, { "$ref": "#/components/schemas/ChapterHeadingsUnavailableResponse" } ] }, "ChapterRouteOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/ChapterRouteAvailableResponse" }, { "$ref": "#/components/schemas/ChapterRouteUnavailableResponse" } ] }, "AddressingOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/AddressingAvailableResponse" }, { "$ref": "#/components/schemas/AddressingUnavailableResponse" } ] }, "OperationId": { "type": "string", "enum": ["catalog_get", "target_registry_get", "chapter_get", "chapter_headings_get", "chapter_target_get", "addressing_get", "chapter_route_resolve", "chapter_notes_get", "chapter_passages_get", "passage_identity_get", "passage_map_get", "reading_works_get", "chapter_reference_context_get", "managed_passage_catalog_get"] }, "InvalidRequestError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 400, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "invalid_request" }, "retryable": { "const": false }, "detailCode": { "enum": ["malformed_identifier", "missing_binding", "unsupported_parameter"] }, "retryAfterMs": { "type": "null" }, "incidentId": { "type": "null" } } }, "UnauthenticatedError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 401, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "unauthenticated" }, "retryable": { "const": false }, "detailCode": { "type": "null" }, "retryAfterMs": { "type": "null" }, "incidentId": { "type": "null" } } }, "NotFoundOrForbiddenError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 404, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "not_found_or_forbidden" }, "retryable": { "const": false }, "detailCode": { "type": "null" }, "retryAfterMs": { "type": "null" }, "incidentId": { "type": "null" } } }, "UnsupportedContractError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 406, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "unsupported_contract" }, "retryable": { "const": false }, "detailCode": { "const": "content_api_contract_not_supported" }, "retryAfterMs": { "type": "null" }, "incidentId": { "type": "null" } } }, "ConflictError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 409, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "conflict" }, "retryable": { "const": false }, "detailCode": { "const": "request_conflict" }, "retryAfterMs": { "type": "null" }, "incidentId": { "type": "null" } } }, "ContinuationInvalidError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 409, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "continuation_invalid" }, "retryable": { "const": false }, "detailCode": { "const": "context_not_usable" }, "retryAfterMs": { "type": "null" }, "incidentId": { "type": "null" } } }, "ResponseBudgetExceededError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 422, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "response_budget_exceeded" }, "retryable": { "const": false }, "detailCode": { "const": "chapter_budget_exceeded" }, "retryAfterMs": { "type": "null" }, "incidentId": { "type": "null" } } }, "RateLimitedError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 429, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "rate_limited" }, "retryable": { "const": true }, "detailCode": { "type": "null" }, "retryAfterMs": { "type": "integer", "minimum": 1, "maximum": 3600000 }, "incidentId": { "type": "null" } } }, "IntegrityFailureError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 503, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "integrity_failure" }, "retryable": { "const": false }, "detailCode": { "type": "null" }, "retryAfterMs": { "type": "null" }, "incidentId": { "$ref": "#/components/schemas/Uuid" } } }, "ServiceUnavailableError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 503, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "service_unavailable" }, "retryable": { "const": true }, "detailCode": { "type": "null" }, "retryAfterMs": { "type": "integer", "minimum": 1, "maximum": 3600000 }, "incidentId": { "type": "null" } } }, "TimeoutError": { "type": "object", "additionalProperties": false, "x-munderecat-http-status": 504, "required": ["code", "retryable", "detailCode", "retryAfterMs", "incidentId"], "properties": { "code": { "const": "timeout" }, "retryable": { "const": true }, "detailCode": { "type": "null" }, "retryAfterMs": { "type": "integer", "minimum": 1, "maximum": 3600000 }, "incidentId": { "type": "null" } } }, "PublicError": { "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestError" }, { "$ref": "#/components/schemas/UnauthenticatedError" }, { "$ref": "#/components/schemas/NotFoundOrForbiddenError" }, { "$ref": "#/components/schemas/UnsupportedContractError" }, { "$ref": "#/components/schemas/ConflictError" }, { "$ref": "#/components/schemas/ContinuationInvalidError" }, { "$ref": "#/components/schemas/ResponseBudgetExceededError" }, { "$ref": "#/components/schemas/RateLimitedError" }, { "$ref": "#/components/schemas/IntegrityFailureError" }, { "$ref": "#/components/schemas/ServiceUnavailableError" }, { "$ref": "#/components/schemas/TimeoutError" } ] }, "InvalidRequestErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "pre_dispatch" }, "error": { "$ref": "#/components/schemas/InvalidRequestError" }, "releaseContext": { "type": "null" }, "resource": { "type": "null" } } }, "UnauthenticatedErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "pre_dispatch" }, "error": { "$ref": "#/components/schemas/UnauthenticatedError" }, "releaseContext": { "type": "null" }, "resource": { "type": "null" } } }, "NotFoundOrForbiddenErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "context_bound" }, "error": { "$ref": "#/components/schemas/NotFoundOrForbiddenError" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ResourceIdentity" } } }, "UnsupportedContractErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "pre_dispatch" }, "error": { "$ref": "#/components/schemas/UnsupportedContractError" }, "releaseContext": { "type": "null" }, "resource": { "type": "null" } } }, "ConflictErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "context_bound" }, "error": { "$ref": "#/components/schemas/ConflictError" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ResourceIdentity" } } }, "ContinuationInvalidErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "pre_dispatch" }, "error": { "$ref": "#/components/schemas/ContinuationInvalidError" }, "releaseContext": { "type": "null" }, "resource": { "type": "null" } } }, "ConflictStatusErrorEnvelope": { "oneOf": [ { "$ref": "#/components/schemas/ConflictErrorEnvelope" }, { "$ref": "#/components/schemas/ContinuationInvalidErrorEnvelope" } ] }, "ResponseBudgetExceededErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "context_bound" }, "error": { "$ref": "#/components/schemas/ResponseBudgetExceededError" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ResourceIdentity" } } }, "RateLimitedErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "pre_dispatch" }, "error": { "$ref": "#/components/schemas/RateLimitedError" }, "releaseContext": { "type": "null" }, "resource": { "type": "null" } } }, "IntegrityFailureErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "context_bound" }, "error": { "$ref": "#/components/schemas/IntegrityFailureError" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ResourceIdentity" } } }, "ServiceUnavailableErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "pre_dispatch" }, "error": { "$ref": "#/components/schemas/ServiceUnavailableError" }, "releaseContext": { "type": "null" }, "resource": { "type": "null" } } }, "ServiceStatusErrorEnvelope": { "oneOf": [ { "$ref": "#/components/schemas/IntegrityFailureErrorEnvelope" }, { "$ref": "#/components/schemas/ServiceUnavailableErrorEnvelope" } ] }, "TimeoutErrorEnvelope": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "errorPhase", "error", "releaseContext", "resource"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "$ref": "#/components/schemas/OperationId" }, "errorPhase": { "const": "context_bound" }, "error": { "$ref": "#/components/schemas/TimeoutError" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ResourceIdentity" } } }, "PublicErrorEnvelope": { "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestErrorEnvelope" }, { "$ref": "#/components/schemas/UnauthenticatedErrorEnvelope" }, { "$ref": "#/components/schemas/NotFoundOrForbiddenErrorEnvelope" }, { "$ref": "#/components/schemas/UnsupportedContractErrorEnvelope" }, { "$ref": "#/components/schemas/ConflictErrorEnvelope" }, { "$ref": "#/components/schemas/ContinuationInvalidErrorEnvelope" }, { "$ref": "#/components/schemas/ResponseBudgetExceededErrorEnvelope" }, { "$ref": "#/components/schemas/RateLimitedErrorEnvelope" }, { "$ref": "#/components/schemas/IntegrityFailureErrorEnvelope" }, { "$ref": "#/components/schemas/ServiceUnavailableErrorEnvelope" }, { "$ref": "#/components/schemas/TimeoutErrorEnvelope" } ] }, "NoteReleaseRef": { "type": "object", "additionalProperties": false, "required": [ "releaseId", "releaseRoot" ], "properties": { "releaseId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" } } }, "NoteSourceCompatibility": { "type": "object", "additionalProperties": false, "required": [ "coreReleaseId", "coreReleaseRoot", "sourceTextVersionId", "chapterReconstructionRoot" ], "properties": { "coreReleaseId": { "$ref": "#/components/schemas/Uuid" }, "coreReleaseRoot": { "$ref": "#/components/schemas/Sha256" }, "sourceTextVersionId": { "$ref": "#/components/schemas/Uuid" }, "chapterReconstructionRoot": { "$ref": "#/components/schemas/Sha256" } } }, "NoteSpan": { "type": "object", "additionalProperties": false, "required": [ "spanId", "sentenceId", "startScalar", "endScalar", "text" ], "properties": { "spanId": { "$ref": "#/components/schemas/Uuid" }, "sentenceId": { "$ref": "#/components/schemas/Uuid" }, "startScalar": { "type": "integer", "minimum": 0 }, "endScalar": { "type": "integer", "minimum": 1 }, "text": { "type": "string" } }, "description": "Exact source sentence text selected by Unicode scalar half-open offsets. Offsets exclude sentence followingText." }, "NoteMarker": { "type": "object", "additionalProperties": false, "required": [ "position", "role", "spanId", "sentenceId", "startScalar", "endScalar", "text" ], "properties": { "position": { "type": "integer", "minimum": 1 }, "role": { "type": "string", "enum": [ "call", "label" ] }, "spanId": { "$ref": "#/components/schemas/Uuid" }, "sentenceId": { "$ref": "#/components/schemas/Uuid" }, "startScalar": { "type": "integer", "minimum": 0 }, "endScalar": { "type": "integer", "minimum": 1 }, "text": { "type": "string" } }, "description": "One-based ordered occurrence. A call references a note; a label identifies its body and is not an implicit call." }, "NoteBodySpan": { "type": "object", "additionalProperties": false, "required": [ "position", "spanId", "sentenceId", "startScalar", "endScalar", "text", "separatorAfter" ], "properties": { "position": { "type": "integer", "minimum": 1 }, "spanId": { "$ref": "#/components/schemas/Uuid" }, "sentenceId": { "$ref": "#/components/schemas/Uuid" }, "startScalar": { "type": "integer", "minimum": 0 }, "endScalar": { "type": "integer", "minimum": 1 }, "text": { "type": "string" }, "separatorAfter": { "type": "string" } }, "description": "One-based selection member. Preserve separatorAfter exactly; never infer or normalize separators." }, "NoteBody": { "type": "object", "additionalProperties": false, "required": [ "position", "selectionId", "spans" ], "properties": { "position": { "type": "integer", "minimum": 1 }, "selectionId": { "$ref": "#/components/schemas/Uuid" }, "spans": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/NoteBodySpan" } } } }, "MappedNote": { "type": "object", "additionalProperties": false, "required": [ "noteId", "gapId", "noteType", "markers", "mappingStatus", "bodies" ], "properties": { "noteId": { "$ref": "#/components/schemas/Uuid" }, "gapId": { "type": "null" }, "noteType": { "type": "string", "enum": [ "formal_hasiye", "starred_note" ] }, "markers": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/NoteMarker" } }, "mappingStatus": { "const": "mapped" }, "bodies": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/NoteBody" } } } }, "SourceGapNote": { "type": "object", "additionalProperties": false, "required": [ "noteId", "gapId", "noteType", "markers", "mappingStatus", "bodies" ], "properties": { "noteId": { "oneOf": [ { "$ref": "#/components/schemas/Uuid" }, { "type": "null" } ] }, "gapId": { "$ref": "#/components/schemas/Uuid" }, "noteType": { "type": "string", "enum": [ "formal_hasiye", "starred_note" ] }, "markers": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/NoteMarker" } }, "mappingStatus": { "const": "source_gap" }, "bodies": { "type": "array", "minItems": 0, "items": { "$ref": "#/components/schemas/NoteBody" }, "maxItems": 0 } } }, "ChapterNote": { "oneOf": [ { "$ref": "#/components/schemas/MappedNote" }, { "$ref": "#/components/schemas/SourceGapNote" } ] }, "ChapterNotesProjection": { "type": "object", "additionalProperties": false, "required": [ "chapterId", "noteRelease", "sourceCompatibility", "notes" ], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "noteRelease": { "$ref": "#/components/schemas/NoteReleaseRef" }, "sourceCompatibility": { "$ref": "#/components/schemas/NoteSourceCompatibility" }, "notes": { "type": "array", "minItems": 0, "items": { "$ref": "#/components/schemas/ChapterNote" } } }, "description": "Complete release-declared chapter coverage, including unresolved source gaps. An empty notes array is verified empty coverage, not an unavailable release. No target-script offsets are implied." }, "ChapterNotesResourceIdentity": { "type": "object", "additionalProperties": false, "required": [ "kind", "contextId", "chapterId", "noteReleaseId" ], "properties": { "kind": { "const": "chapter_notes" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" }, "noteReleaseId": { "$ref": "#/components/schemas/Uuid" } } }, "ChapterNotesAvailableResponse": { "type": "object", "additionalProperties": false, "required": [ "requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page" ], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_notes_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterNotesResourceIdentity" }, "data": { "$ref": "#/components/schemas/ChapterNotesProjection" }, "page": { "type": "null" } } }, "ChapterNotesUnavailableResponse": { "type": "object", "additionalProperties": false, "required": [ "requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page" ], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_notes_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterNotesResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ChapterNotesOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/ChapterNotesAvailableResponse" }, { "$ref": "#/components/schemas/ChapterNotesUnavailableResponse" } ] }, "PassageMapPlacement": { "type": "object", "additionalProperties": false, "required": ["placementId", "identityId", "identityKind", "bookId", "chapterId", "startSentenceId", "endSentenceId", "memberCount", "preview"], "properties": { "placementId": { "$ref": "#/components/schemas/Uuid" }, "identityId": { "$ref": "#/components/schemas/Uuid" }, "identityKind": { "$ref": "#/components/schemas/PassageIdentityKind" }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" }, "startSentenceId": { "$ref": "#/components/schemas/Uuid" }, "endSentenceId": { "$ref": "#/components/schemas/Uuid" }, "memberCount": { "type": "integer", "minimum": 1 }, "preview": { "type": "string", "maxLength": 160 } } }, "PassageMapIdentity": { "type": "object", "additionalProperties": false, "required": ["identityId", "identityKind", "placementCount", "chapterCount", "bookCount"], "properties": { "identityId": { "$ref": "#/components/schemas/Uuid" }, "identityKind": { "$ref": "#/components/schemas/PassageIdentityKind" }, "placementCount": { "type": "integer", "minimum": 1 }, "chapterCount": { "type": "integer", "minimum": 1 }, "bookCount": { "type": "integer", "minimum": 1 } } }, "PassageMapCompilation": { "type": "object", "additionalProperties": false, "required": ["mapId", "scopeKind", "scopeChapterId", "memberCount", "regionCount", "members", "regions"], "properties": { "mapId": { "$ref": "#/components/schemas/Uuid" }, "scopeKind": { "type": "string", "enum": ["book", "chapter", "passage_placement"] }, "scopeChapterId": { "$ref": "#/components/schemas/Uuid" }, "memberCount": { "type": "integer", "minimum": 0 }, "regionCount": { "type": "integer", "minimum": 0 }, "members": { "type": "array", "maxItems": 309, "items": { "$ref": "#/components/schemas/PassageCompilationMember" } }, "regions": { "type": "array", "maxItems": 816, "items": { "$ref": "#/components/schemas/PassageCompilationRegion" } } } }, "PassageMapCounts": { "type": "object", "additionalProperties": false, "required": ["identityCount", "placementCount", "chapterCount", "bookCount", "edgeCount", "compilationMapCount", "regionCount"], "properties": { "identityCount": { "type": "integer", "minimum": 0 }, "placementCount": { "type": "integer", "minimum": 0 }, "chapterCount": { "type": "integer", "minimum": 0 }, "bookCount": { "type": "integer", "minimum": 0 }, "edgeCount": { "type": "integer", "minimum": 0 }, "compilationMapCount": { "type": "integer", "minimum": 0 }, "regionCount": { "type": "integer", "minimum": 0 } } }, "PassageMapProjection": { "type": "object", "additionalProperties": false, "required": ["passageRelease", "counts", "placements", "identities", "edges", "compilationMaps"], "properties": { "passageRelease": { "$ref": "#/components/schemas/PassageReleaseRef" }, "counts": { "$ref": "#/components/schemas/PassageMapCounts" }, "placements": { "type": "array", "maxItems": 309, "items": { "$ref": "#/components/schemas/PassageMapPlacement" } }, "identities": { "type": "array", "maxItems": 142, "items": { "$ref": "#/components/schemas/PassageMapIdentity" } }, "edges": { "type": "array", "maxItems": 84, "items": { "$ref": "#/components/schemas/PassageEdge" } }, "compilationMaps": { "type": "array", "maxItems": 24, "items": { "$ref": "#/components/schemas/PassageMapCompilation" } } } }, "ReadingWorkSourceRelease": { "type": "object", "additionalProperties": false, "required": ["coreReleaseId", "coreReleaseRoot", "sourceTextVersionId"], "properties": { "coreReleaseId": { "$ref": "#/components/schemas/Uuid" }, "coreReleaseRoot": { "$ref": "#/components/schemas/Sha256" }, "sourceTextVersionId": { "$ref": "#/components/schemas/Uuid" } } }, "ReadingWorkChapterReference": { "type": "object", "additionalProperties": false, "required": ["kind", "bookId", "chapterId"], "properties": { "kind": { "const": "chapter" }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" } } }, "ReadingWorkMember": { "type": "object", "additionalProperties": false, "required": ["memberId", "position", "source"], "properties": { "memberId": { "$ref": "#/components/schemas/Uuid" }, "position": { "type": "integer", "minimum": 0 }, "source": { "$ref": "#/components/schemas/ReadingWorkChapterReference" } } }, "ReadingWork": { "type": "object", "additionalProperties": false, "required": ["workId", "slug", "name", "kind", "members"], "properties": { "workId": { "$ref": "#/components/schemas/Uuid" }, "slug": { "type": "string", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "maxLength": 96 }, "name": { "type": "string", "minLength": 1 }, "kind": { "const": "presentation" }, "members": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/ReadingWorkMember" } } } }, "ChapterReferenceBaseline": {"type":"object","additionalProperties":false,"required":["readerReleaseId","releaseKey","coreReleaseId","textVersionId","coreRootSha256"],"properties":{"readerReleaseId":{"$ref":"#/components/schemas/Uuid"},"releaseKey":{"const":"tr-passage-1"},"coreReleaseId":{"$ref":"#/components/schemas/Uuid"},"textVersionId":{"$ref":"#/components/schemas/Uuid"},"coreRootSha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}}}, "ChapterReferencePlacement": {"type":"object","additionalProperties":false,"required":["placementId","selectionId","chapterId"],"properties":{"placementId":{"$ref":"#/components/schemas/Uuid"},"selectionId":{"$ref":"#/components/schemas/Uuid"},"chapterId":{"$ref":"#/components/schemas/Uuid"}}}, "ChapterReferenceMembership": {"type":"object","additionalProperties":false,"required":["membershipId","placementId","identityId","applicability"],"properties":{"membershipId":{"$ref":"#/components/schemas/Uuid"},"placementId":{"$ref":"#/components/schemas/Uuid"},"identityId":{"$ref":"#/components/schemas/Uuid"},"applicability":{"enum":["whole","excerpt_only"]}}}, "ChapterReferenceSpan": {"type":"object","additionalProperties":false,"required":["sentenceId","startScalar","endScalar"],"properties":{"sentenceId":{"$ref":"#/components/schemas/Uuid"},"startScalar":{"type":"integer","minimum":0},"endScalar":{"type":"integer","minimum":1}}}, "ChapterReferenceSelection": {"type":"object","additionalProperties":false,"required":["selectionId","chapterId","spans"],"properties":{"selectionId":{"$ref":"#/components/schemas/Uuid"},"chapterId":{"$ref":"#/components/schemas/Uuid"},"spans":{"type":"array","minItems":1,"maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReferenceSpan"}}}}, "ChapterReferenceScope": {"type":"object","additionalProperties":false,"required":["scopeId","identityId","kind","label"],"properties":{"scopeId":{"$ref":"#/components/schemas/Uuid"},"identityId":{"$ref":"#/components/schemas/Uuid"},"kind":{"enum":["whole","subpart"]},"label":{"type":["string","null"],"maxLength":1000}}}, "ChapterReferenceBinding": {"type":"object","additionalProperties":false,"required":["bindingId","scopeId","placementId","selectionId","evidence"],"properties":{"bindingId":{"$ref":"#/components/schemas/Uuid"},"scopeId":{"$ref":"#/components/schemas/Uuid"},"placementId":{"$ref":"#/components/schemas/Uuid"},"selectionId":{"$ref":"#/components/schemas/Uuid"},"evidence":{"enum":["exact","reviewed_variant","accepted_family"]}}}, "ChapterReferenceEndpoint": {"type":"object","additionalProperties":false,"required":["kind","id"],"properties":{"kind":{"enum":["identity","scope","placement","selection","chapter"]},"id":{"$ref":"#/components/schemas/Uuid"}}}, "ChapterReference": {"type":"object","additionalProperties":false,"required":["referenceId","label","text","source","target","sourceActive","targetActive"],"properties":{"referenceId":{"$ref":"#/components/schemas/Uuid"},"label":{"type":["string","null"],"maxLength":1000},"text":{"type":["string","null"],"maxLength":16000},"source":{"$ref":"#/components/schemas/ChapterReferenceEndpoint"},"target":{"$ref":"#/components/schemas/ChapterReferenceEndpoint"},"sourceActive":{"type":"boolean"},"targetActive":{"type":"boolean"}}}, "ChapterReferenceEffectiveEndpoint": {"type":"object","additionalProperties":false,"required":["referenceId","side","kind","chapterId","placementId","selectionId","identityId","scopeId","bindingId","evidence"],"properties":{"referenceId":{"$ref":"#/components/schemas/Uuid"},"side":{"enum":["source","target"]},"kind":{"enum":["identity","scope","placement","selection","chapter"]},"chapterId":{"$ref":"#/components/schemas/Uuid"},"placementId":{"oneOf":[{"$ref":"#/components/schemas/Uuid"},{"type":"null"}]},"selectionId":{"oneOf":[{"$ref":"#/components/schemas/Uuid"},{"type":"null"}]},"identityId":{"oneOf":[{"$ref":"#/components/schemas/Uuid"},{"type":"null"}]},"scopeId":{"oneOf":[{"$ref":"#/components/schemas/Uuid"},{"type":"null"}]},"bindingId":{"oneOf":[{"$ref":"#/components/schemas/Uuid"},{"type":"null"}]},"evidence":{"type":["string","null"],"enum":["exact","reviewed_variant","accepted_family",null]}}}, "ChapterReferenceContextProjection": {"type":"object","additionalProperties":false,"required":["schemaVersion","chapterId","revision","baseline","counts","placements","memberships","selections","scopes","bindings","references","effectiveEndpoints"],"properties":{"schemaVersion":{"const":1},"chapterId":{"$ref":"#/components/schemas/Uuid"},"revision":{"type":"integer","minimum":0},"baseline":{"$ref":"#/components/schemas/ChapterReferenceBaseline"},"counts":{"type":"object","additionalProperties":false,"required":["placements","memberships","selections","scopes","bindings","references","effectiveEndpoints"],"properties":{"placements":{"type":"integer","minimum":0},"memberships":{"type":"integer","minimum":0},"selections":{"type":"integer","minimum":0},"scopes":{"type":"integer","minimum":0},"bindings":{"type":"integer","minimum":0},"references":{"type":"integer","minimum":0},"effectiveEndpoints":{"type":"integer","minimum":0}}},"placements":{"type":"array","maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReferencePlacement"}},"memberships":{"type":"array","maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReferenceMembership"}},"selections":{"type":"array","maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReferenceSelection"}},"scopes":{"type":"array","maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReferenceScope"}},"bindings":{"type":"array","maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReferenceBinding"}},"references":{"type":"array","maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReference"}},"effectiveEndpoints":{"type":"array","maxItems":100000,"items":{"$ref":"#/components/schemas/ChapterReferenceEffectiveEndpoint"}}}}, "ChapterReferenceContextResourceIdentity": {"type":"object","additionalProperties":false,"required":["kind","contextId","chapterId"],"properties":{"kind":{"const":"chapter_reference_context"},"contextId":{"$ref":"#/components/schemas/Uuid"},"chapterId":{"$ref":"#/components/schemas/Uuid"}}}, "ChapterReferenceContextAvailableResponse": {"type":"object","additionalProperties":false,"required":["requestId","operationId","operationRevisionId","resultState","stateContext","releaseContext","resource","data","page"],"properties":{"requestId":{"$ref":"#/components/schemas/Uuid"},"operationId":{"const":"chapter_reference_context_get"},"operationRevisionId":{"$ref":"#/components/schemas/Uuid"},"resultState":{"const":"available"},"stateContext":{"$ref":"#/components/schemas/AvailableStateContext"},"releaseContext":{"$ref":"#/components/schemas/ContentReleaseContext"},"resource":{"$ref":"#/components/schemas/ChapterReferenceContextResourceIdentity"},"data":{"$ref":"#/components/schemas/ChapterReferenceContextProjection"},"page":{"type":"null"}}}, "ChapterReferenceContextUnavailableResponse": {"type":"object","additionalProperties":false,"required":["requestId","operationId","operationRevisionId","resultState","stateContext","releaseContext","resource","data","page"],"properties":{"requestId":{"$ref":"#/components/schemas/Uuid"},"operationId":{"const":"chapter_reference_context_get"},"operationRevisionId":{"$ref":"#/components/schemas/Uuid"},"resultState":{"const":"unavailable"},"stateContext":{"$ref":"#/components/schemas/UnavailableStateContext"},"releaseContext":{"$ref":"#/components/schemas/ContentReleaseContext"},"resource":{"$ref":"#/components/schemas/ChapterReferenceContextResourceIdentity"},"data":{"type":"null"},"page":{"type":"null"}}}, "ChapterReferenceContextOperationResponse": {"oneOf":[{"$ref":"#/components/schemas/ChapterReferenceContextAvailableResponse"},{"$ref":"#/components/schemas/ChapterReferenceContextUnavailableResponse"}]}, "ManagedPassageCatalogIdentity": { "type": "object", "additionalProperties": false, "required": ["identityId", "identityKind", "label"], "properties": { "identityId": { "$ref": "#/components/schemas/Uuid" }, "identityKind": { "enum": ["passage", "compositional_unit"] }, "label": { "type": ["string", "null"] } } }, "ManagedPassageCatalogPlacement": { "type": "object", "additionalProperties": false, "required": ["placementId", "selectionId", "identityId", "chapterId", "bookId", "applicability"], "properties": { "placementId": { "$ref": "#/components/schemas/Uuid" }, "selectionId": { "$ref": "#/components/schemas/Uuid" }, "identityId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "applicability": { "enum": ["whole", "excerpt_only"] } } }, "ManagedPassageCatalogProjection": { "type": "object", "additionalProperties": false, "description": "Current active memberships joined to active placements on the fixed chapter reference baseline. Unreferenced identities are permitted. No retired placements, prior memberships or management history are included.", "required": ["baseline", "revision", "identities", "placements"], "properties": { "baseline": { "$ref": "#/components/schemas/ChapterReferenceBaseline" }, "revision": { "type": "integer", "minimum": 0 }, "identities": { "type": "array", "maxItems": 100000, "items": { "$ref": "#/components/schemas/ManagedPassageCatalogIdentity" } }, "placements": { "type": "array", "maxItems": 100000, "items": { "$ref": "#/components/schemas/ManagedPassageCatalogPlacement" } } } }, "ManagedPassageCatalogResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId"], "properties": { "kind": { "const": "managed_passage_catalog" }, "contextId": { "$ref": "#/components/schemas/Uuid" } } }, "ManagedPassageCatalogAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "managed_passage_catalog_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ManagedPassageCatalogResourceIdentity" }, "data": { "$ref": "#/components/schemas/ManagedPassageCatalogProjection" }, "page": { "type": "null" } } }, "ManagedPassageCatalogUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "managed_passage_catalog_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ManagedPassageCatalogResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ManagedPassageCatalogOperationResponse": { "oneOf": [{ "$ref": "#/components/schemas/ManagedPassageCatalogAvailableResponse" }, { "$ref": "#/components/schemas/ManagedPassageCatalogUnavailableResponse" }] }, "ReadingWorksCatalog": { "type": "object", "additionalProperties": false, "required": ["contract", "schemaVersion", "source", "works"], "properties": { "contract": { "const": "munderecat.reading-works.v1" }, "schemaVersion": { "const": 1 }, "source": { "$ref": "#/components/schemas/ReadingWorkSourceRelease" }, "works": { "type": "array", "items": { "$ref": "#/components/schemas/ReadingWork" } } } }, "ReadingWorksResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId"], "properties": { "kind": { "const": "reading_works" }, "contextId": { "$ref": "#/components/schemas/Uuid" } } }, "ReadingWorksAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "reading_works_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ReadingWorksResourceIdentity" }, "data": { "$ref": "#/components/schemas/ReadingWorksCatalog" }, "page": { "type": "null" } } }, "ReadingWorksUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "reading_works_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ReadingWorksResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ReadingWorksOperationResponse": { "oneOf": [{ "$ref": "#/components/schemas/ReadingWorksAvailableResponse" }, { "$ref": "#/components/schemas/ReadingWorksUnavailableResponse" }] }, "PassageMapResourceIdentity": { "type": "object", "additionalProperties": false, "required": ["kind", "contextId", "passageReleaseId"], "properties": { "kind": { "const": "passage_map" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "passageReleaseId": { "$ref": "#/components/schemas/Uuid" } } }, "PassageMapAvailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "passage_map_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/PassageMapResourceIdentity" }, "data": { "$ref": "#/components/schemas/PassageMapProjection" }, "page": { "type": "null" } } }, "PassageMapUnavailableResponse": { "type": "object", "additionalProperties": false, "required": ["requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page"], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "passage_map_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/PassageMapResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "PassageMapOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/PassageMapAvailableResponse" }, { "$ref": "#/components/schemas/PassageMapUnavailableResponse" } ] }, "PassageReleaseRef": { "type": "object", "additionalProperties": false, "required": [ "releaseId", "releaseRoot" ], "properties": { "releaseId": { "$ref": "#/components/schemas/Uuid" }, "releaseRoot": { "$ref": "#/components/schemas/Sha256" } }, "description": "Separately pinned accepted passage reader release and its published package root. Independent of content context and target bindings." }, "PassageIdentityKind": { "type": "string", "enum": [ "passage", "compositional_unit" ] }, "PassagePlacement": { "type": "object", "additionalProperties": false, "required": [ "placementId", "identityId", "identityKind", "selectionId", "startSentenceId", "endSentenceId", "memberCount", "exactText" ], "properties": { "placementId": { "$ref": "#/components/schemas/Uuid" }, "identityId": { "$ref": "#/components/schemas/Uuid" }, "identityKind": { "$ref": "#/components/schemas/PassageIdentityKind" }, "selectionId": { "$ref": "#/components/schemas/Uuid" }, "startSentenceId": { "$ref": "#/components/schemas/Uuid" }, "endSentenceId": { "$ref": "#/components/schemas/Uuid" }, "memberCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "exactText": { "type": "string", "minLength": 1, "maxLength": 2000000 } }, "description": "Exact text of this local placement only. Membership in the same accepted identity does not imply exact textual equality or a canonical primary." }, "PassageIdentityPlacement": { "type": "object", "additionalProperties": false, "required": [ "placementId", "identityId", "identityKind", "selectionId", "startSentenceId", "endSentenceId", "memberCount", "exactText", "bookId", "chapterId" ], "properties": { "placementId": { "$ref": "#/components/schemas/Uuid" }, "identityId": { "$ref": "#/components/schemas/Uuid" }, "identityKind": { "$ref": "#/components/schemas/PassageIdentityKind" }, "selectionId": { "$ref": "#/components/schemas/Uuid" }, "startSentenceId": { "$ref": "#/components/schemas/Uuid" }, "endSentenceId": { "$ref": "#/components/schemas/Uuid" }, "memberCount": { "type": "integer", "minimum": 1, "maximum": 100000 }, "exactText": { "type": "string", "minLength": 1, "maxLength": 2000000 }, "bookId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" } } }, "PassageEdge": { "type": "object", "additionalProperties": false, "required": [ "edgeId", "sourcePlacementId", "sourceChapterId", "derivedPlacementId", "derivedChapterId", "relationKind" ], "properties": { "edgeId": { "$ref": "#/components/schemas/Uuid" }, "sourcePlacementId": { "$ref": "#/components/schemas/Uuid" }, "sourceChapterId": { "$ref": "#/components/schemas/Uuid" }, "derivedPlacementId": { "$ref": "#/components/schemas/Uuid" }, "derivedChapterId": { "$ref": "#/components/schemas/Uuid" }, "relationKind": { "type": "string", "enum": [ "republished_as", "adapted_as", "excerpted_as", "included_as" ] } } }, "PassageCompilationMember": { "type": "object", "additionalProperties": false, "required": [ "position", "placementId", "identityId" ], "properties": { "position": { "type": "integer", "minimum": 0, "maximum": 100000 }, "placementId": { "$ref": "#/components/schemas/Uuid" }, "identityId": { "$ref": "#/components/schemas/Uuid" } } }, "PassageCompilationRegion": { "type": "object", "additionalProperties": false, "required": [ "position", "selectionId", "regionRole", "memberPosition" ], "properties": { "position": { "type": "integer", "minimum": 0, "maximum": 100000 }, "selectionId": { "$ref": "#/components/schemas/Uuid" }, "regionRole": { "type": "string", "enum": [ "component_exact", "component_variant", "local_original", "local_transition", "local_wrapper" ] }, "memberPosition": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100000 } } }, "PassageCompilationMap": { "type": "object", "additionalProperties": false, "required": [ "mapId", "scopeKind", "memberCount", "regionCount", "members", "regions" ], "properties": { "mapId": { "$ref": "#/components/schemas/Uuid" }, "scopeKind": { "type": "string", "enum": [ "book", "chapter", "passage_placement" ] }, "memberCount": { "type": "integer", "minimum": 0, "maximum": 100000 }, "regionCount": { "type": "integer", "minimum": 0, "maximum": 100000 }, "members": { "type": "array", "maxItems": 309, "items": { "$ref": "#/components/schemas/PassageCompilationMember" } }, "regions": { "type": "array", "maxItems": 816, "items": { "$ref": "#/components/schemas/PassageCompilationRegion" } } } }, "ChapterPassagesProjection": { "type": "object", "additionalProperties": false, "required": [ "chapterId", "passageRelease", "placements", "edges", "compilationMaps" ], "properties": { "chapterId": { "$ref": "#/components/schemas/Uuid" }, "passageRelease": { "$ref": "#/components/schemas/PassageReleaseRef" }, "placements": { "type": "array", "maxItems": 309, "items": { "$ref": "#/components/schemas/PassagePlacement" } }, "edges": { "type": "array", "maxItems": 84, "items": { "$ref": "#/components/schemas/PassageEdge" } }, "compilationMaps": { "type": "array", "maxItems": 24, "items": { "$ref": "#/components/schemas/PassageCompilationMap" } } } }, "PassageIdentityProjection": { "type": "object", "additionalProperties": false, "required": [ "identityId", "identityKind", "passageRelease", "placements" ], "properties": { "identityId": { "$ref": "#/components/schemas/Uuid" }, "identityKind": { "$ref": "#/components/schemas/PassageIdentityKind" }, "passageRelease": { "$ref": "#/components/schemas/PassageReleaseRef" }, "placements": { "type": "array", "maxItems": 309, "items": { "$ref": "#/components/schemas/PassageIdentityPlacement" }, "minItems": 1 } } }, "ChapterPassagesResourceIdentity": { "type": "object", "additionalProperties": false, "required": [ "kind", "contextId", "chapterId", "passageReleaseId" ], "properties": { "kind": { "const": "chapter_passages" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "chapterId": { "$ref": "#/components/schemas/Uuid" }, "passageReleaseId": { "$ref": "#/components/schemas/Uuid" } } }, "ChapterPassagesAvailableResponse": { "type": "object", "additionalProperties": false, "required": [ "requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page" ], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_passages_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterPassagesResourceIdentity" }, "data": { "$ref": "#/components/schemas/ChapterPassagesProjection" }, "page": { "type": "null" } } }, "ChapterPassagesUnavailableResponse": { "type": "object", "additionalProperties": false, "required": [ "requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page" ], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "chapter_passages_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/ChapterPassagesResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "ChapterPassagesOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/ChapterPassagesAvailableResponse" }, { "$ref": "#/components/schemas/ChapterPassagesUnavailableResponse" } ] }, "PassageIdentityResourceIdentity": { "type": "object", "additionalProperties": false, "required": [ "kind", "contextId", "identityId", "passageReleaseId" ], "properties": { "kind": { "const": "passage_identity" }, "contextId": { "$ref": "#/components/schemas/Uuid" }, "identityId": { "$ref": "#/components/schemas/Uuid" }, "passageReleaseId": { "$ref": "#/components/schemas/Uuid" } } }, "PassageIdentityAvailableResponse": { "type": "object", "additionalProperties": false, "required": [ "requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page" ], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "passage_identity_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "available" }, "stateContext": { "$ref": "#/components/schemas/AvailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/PassageIdentityResourceIdentity" }, "data": { "$ref": "#/components/schemas/PassageIdentityProjection" }, "page": { "type": "null" } } }, "PassageIdentityUnavailableResponse": { "type": "object", "additionalProperties": false, "required": [ "requestId", "operationId", "operationRevisionId", "resultState", "stateContext", "releaseContext", "resource", "data", "page" ], "properties": { "requestId": { "$ref": "#/components/schemas/Uuid" }, "operationId": { "const": "passage_identity_get" }, "operationRevisionId": { "$ref": "#/components/schemas/Uuid" }, "resultState": { "const": "unavailable" }, "stateContext": { "$ref": "#/components/schemas/UnavailableStateContext" }, "releaseContext": { "$ref": "#/components/schemas/ContentReleaseContext" }, "resource": { "$ref": "#/components/schemas/PassageIdentityResourceIdentity" }, "data": { "type": "null" }, "page": { "type": "null" } } }, "PassageIdentityOperationResponse": { "oneOf": [ { "$ref": "#/components/schemas/PassageIdentityAvailableResponse" }, { "$ref": "#/components/schemas/PassageIdentityUnavailableResponse" } ] } } } }