@epistola.app/epistola-client 1.4.0 → 2.0.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +82 -0
- package/README.md +137 -33
- package/dist/collect/resultCollector.d.ts +4 -4
- package/dist/collect/resultCollector.d.ts.map +1 -1
- package/dist/collect/resultCollector.js +9 -9
- package/dist/collect/resultCollector.js.map +1 -1
- package/dist/error/problemDetailException.d.ts +93 -2
- package/dist/error/problemDetailException.d.ts.map +1 -1
- package/dist/error/problemDetailException.js +136 -1
- package/dist/error/problemDetailException.js.map +1 -1
- package/dist/generated/api/apis/AttributesApi.d.ts +168 -30
- package/dist/generated/api/apis/AttributesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/AttributesApi.js +111 -62
- package/dist/generated/api/apis/AttributesApi.js.map +1 -1
- package/dist/generated/api/apis/CatalogsApi.d.ts +1005 -79
- package/dist/generated/api/apis/CatalogsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/CatalogsApi.js +1234 -134
- package/dist/generated/api/apis/CatalogsApi.js.map +1 -1
- package/dist/generated/api/apis/CodeListsApi.d.ts +267 -43
- package/dist/generated/api/apis/CodeListsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/CodeListsApi.js +194 -115
- package/dist/generated/api/apis/CodeListsApi.js.map +1 -1
- package/dist/generated/api/apis/ConsumersApi.d.ts +42 -34
- package/dist/generated/api/apis/ConsumersApi.d.ts.map +1 -1
- package/dist/generated/api/apis/ConsumersApi.js +58 -79
- package/dist/generated/api/apis/ConsumersApi.js.map +1 -1
- package/dist/generated/api/apis/EnvironmentsApi.d.ts +215 -26
- package/dist/generated/api/apis/EnvironmentsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/EnvironmentsApi.js +287 -56
- package/dist/generated/api/apis/EnvironmentsApi.js.map +1 -1
- package/dist/generated/api/apis/FontsApi.d.ts +64 -12
- package/dist/generated/api/apis/FontsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/FontsApi.js +45 -27
- package/dist/generated/api/apis/FontsApi.js.map +1 -1
- package/dist/generated/api/apis/GenerationApi.d.ts +59 -37
- package/dist/generated/api/apis/GenerationApi.d.ts.map +1 -1
- package/dist/generated/api/apis/GenerationApi.js +70 -91
- package/dist/generated/api/apis/GenerationApi.js.map +1 -1
- package/dist/generated/api/apis/ImagesApi.d.ts +130 -30
- package/dist/generated/api/apis/ImagesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/ImagesApi.js +91 -57
- package/dist/generated/api/apis/ImagesApi.js.map +1 -1
- package/dist/generated/api/apis/StencilsApi.d.ts +309 -298
- package/dist/generated/api/apis/StencilsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/StencilsApi.js +259 -529
- package/dist/generated/api/apis/StencilsApi.js.map +1 -1
- package/dist/generated/api/apis/SystemApi.d.ts +4 -4
- package/dist/generated/api/apis/SystemApi.d.ts.map +1 -1
- package/dist/generated/api/apis/SystemApi.js +15 -5
- package/dist/generated/api/apis/SystemApi.js.map +1 -1
- package/dist/generated/api/apis/TemplatesApi.d.ts +255 -46
- package/dist/generated/api/apis/TemplatesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/TemplatesApi.js +208 -89
- package/dist/generated/api/apis/TemplatesApi.js.map +1 -1
- package/dist/generated/api/apis/TenantsApi.d.ts +22 -14
- package/dist/generated/api/apis/TenantsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/TenantsApi.js +25 -37
- package/dist/generated/api/apis/TenantsApi.js.map +1 -1
- package/dist/generated/api/apis/ThemesApi.d.ts +178 -40
- package/dist/generated/api/apis/ThemesApi.d.ts.map +1 -1
- package/dist/generated/api/apis/ThemesApi.js +124 -75
- package/dist/generated/api/apis/ThemesApi.js.map +1 -1
- package/dist/generated/api/apis/VariantsApi.d.ts +333 -244
- package/dist/generated/api/apis/VariantsApi.d.ts.map +1 -1
- package/dist/generated/api/apis/VariantsApi.js +278 -496
- package/dist/generated/api/apis/VariantsApi.js.map +1 -1
- package/dist/generated/api/apis/index.d.ts +0 -2
- package/dist/generated/api/apis/index.d.ts.map +1 -1
- package/dist/generated/api/apis/index.js +0 -2
- package/dist/generated/api/apis/index.js.map +1 -1
- package/dist/generated/api/models/ApproveConsumerRequest.d.ts +2 -2
- package/dist/generated/api/models/ApproveConsumerRequest.js +2 -2
- package/dist/generated/api/models/AttributeDto.d.ts +20 -37
- package/dist/generated/api/models/AttributeDto.d.ts.map +1 -1
- package/dist/generated/api/models/AttributeDto.js +16 -21
- package/dist/generated/api/models/AttributeDto.js.map +1 -1
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts +13 -9
- package/dist/generated/api/models/AttributeDtoCodeListBinding.d.ts.map +1 -1
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js +8 -8
- package/dist/generated/api/models/AttributeDtoCodeListBinding.js.map +1 -1
- package/dist/generated/api/models/AttributeListResponse.d.ts +2 -2
- package/dist/generated/api/models/AttributeListResponse.js +2 -2
- package/dist/generated/api/models/AvailableCatalogReleases.d.ts +52 -0
- package/dist/generated/api/models/AvailableCatalogReleases.d.ts.map +1 -0
- package/dist/generated/api/models/AvailableCatalogReleases.js +58 -0
- package/dist/generated/api/models/AvailableCatalogReleases.js.map +1 -0
- package/dist/generated/api/models/AvailableReleaseDependencyDto.d.ts +51 -0
- package/dist/generated/api/models/AvailableReleaseDependencyDto.d.ts.map +1 -0
- package/dist/generated/api/models/AvailableReleaseDependencyDto.js +61 -0
- package/dist/generated/api/models/AvailableReleaseDependencyDto.js.map +1 -0
- package/dist/generated/api/models/AvailableReleaseDto.d.ts +52 -0
- package/dist/generated/api/models/AvailableReleaseDto.d.ts.map +1 -0
- package/dist/generated/api/models/AvailableReleaseDto.js +59 -0
- package/dist/generated/api/models/AvailableReleaseDto.js.map +1 -0
- package/dist/generated/api/models/BatchGenerationItem.d.ts +37 -14
- package/dist/generated/api/models/BatchGenerationItem.d.ts.map +1 -1
- package/dist/generated/api/models/BatchGenerationItem.js +20 -14
- package/dist/generated/api/models/BatchGenerationItem.js.map +1 -1
- package/dist/generated/api/models/BehindReleaseDto.d.ts +38 -0
- package/dist/generated/api/models/BehindReleaseDto.d.ts.map +1 -0
- package/dist/generated/api/models/BehindReleaseDto.js +50 -0
- package/dist/generated/api/models/BehindReleaseDto.js.map +1 -0
- package/dist/generated/api/models/BlockStylePreset.d.ts +2 -2
- package/dist/generated/api/models/BlockStylePreset.js +2 -2
- package/dist/generated/api/models/CatalogChangesDto.d.ts +71 -0
- package/dist/generated/api/models/CatalogChangesDto.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogChangesDto.js +61 -0
- package/dist/generated/api/models/CatalogChangesDto.js.map +1 -0
- package/dist/generated/api/models/CatalogDependencyDto.d.ts +73 -0
- package/dist/generated/api/models/CatalogDependencyDto.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDependencyDto.js +67 -0
- package/dist/generated/api/models/CatalogDependencyDto.js.map +1 -0
- package/dist/generated/api/models/CatalogDependencyListResponse.d.ts +32 -0
- package/dist/generated/api/models/CatalogDependencyListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDependencyListResponse.js +46 -0
- package/dist/generated/api/models/CatalogDependencyListResponse.js.map +1 -0
- package/dist/generated/api/models/CatalogDependencyRequirement.d.ts +73 -0
- package/dist/generated/api/models/CatalogDependencyRequirement.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDependencyRequirement.js +57 -0
- package/dist/generated/api/models/CatalogDependencyRequirement.js.map +1 -0
- package/dist/generated/api/models/CatalogDraftMergePreview.d.ts +94 -0
- package/dist/generated/api/models/CatalogDraftMergePreview.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDraftMergePreview.js +73 -0
- package/dist/generated/api/models/CatalogDraftMergePreview.js.map +1 -0
- package/dist/generated/api/models/CatalogDraftMergeResource.d.ts +102 -0
- package/dist/generated/api/models/CatalogDraftMergeResource.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDraftMergeResource.js +80 -0
- package/dist/generated/api/models/CatalogDraftMergeResource.js.map +1 -0
- package/dist/generated/api/models/CatalogDraftMergeSides.d.ts +69 -0
- package/dist/generated/api/models/CatalogDraftMergeSides.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDraftMergeSides.js +59 -0
- package/dist/generated/api/models/CatalogDraftMergeSides.js.map +1 -0
- package/dist/generated/api/models/CatalogDraftReleasePreview.d.ts +70 -0
- package/dist/generated/api/models/CatalogDraftReleasePreview.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogDraftReleasePreview.js +65 -0
- package/dist/generated/api/models/CatalogDraftReleasePreview.js.map +1 -0
- package/dist/generated/api/models/CatalogDto.d.ts +65 -23
- package/dist/generated/api/models/CatalogDto.d.ts.map +1 -1
- package/dist/generated/api/models/CatalogDto.js +29 -15
- package/dist/generated/api/models/CatalogDto.js.map +1 -1
- package/dist/generated/api/models/CatalogLevelChangeDto.d.ts +61 -0
- package/dist/generated/api/models/CatalogLevelChangeDto.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogLevelChangeDto.js +61 -0
- package/dist/generated/api/models/CatalogLevelChangeDto.js.map +1 -0
- package/dist/generated/api/models/CatalogListResponse.d.ts +2 -2
- package/dist/generated/api/models/CatalogListResponse.js +2 -2
- package/dist/generated/api/models/CatalogMergeBaseRef.d.ts +46 -0
- package/dist/generated/api/models/CatalogMergeBaseRef.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogMergeBaseRef.js +51 -0
- package/dist/generated/api/models/CatalogMergeBaseRef.js.map +1 -0
- package/dist/generated/api/models/CatalogMergeOutcome.d.ts +35 -0
- package/dist/generated/api/models/CatalogMergeOutcome.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogMergeOutcome.js +53 -0
- package/dist/generated/api/models/CatalogMergeOutcome.js.map +1 -0
- package/dist/generated/api/models/CatalogMergeSide.d.ts +28 -0
- package/dist/generated/api/models/CatalogMergeSide.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogMergeSide.js +46 -0
- package/dist/generated/api/models/CatalogMergeSide.js.map +1 -0
- package/dist/generated/api/models/CatalogPresetDto.d.ts +41 -0
- package/dist/generated/api/models/CatalogPresetDto.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogPresetDto.js +51 -0
- package/dist/generated/api/models/CatalogPresetDto.js.map +1 -0
- package/dist/generated/api/models/CatalogReadOnlyProblemDetail.d.ts +56 -0
- package/dist/generated/api/models/CatalogReadOnlyProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogReadOnlyProblemDetail.js +60 -0
- package/dist/generated/api/models/CatalogReadOnlyProblemDetail.js.map +1 -0
- package/dist/generated/api/models/CatalogReadOnlyReason.d.ts +32 -0
- package/dist/generated/api/models/CatalogReadOnlyReason.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogReadOnlyReason.js +50 -0
- package/dist/generated/api/models/CatalogReadOnlyReason.js.map +1 -0
- package/dist/generated/api/models/CatalogReleaseDto.d.ts +153 -0
- package/dist/generated/api/models/CatalogReleaseDto.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogReleaseDto.js +90 -0
- package/dist/generated/api/models/CatalogReleaseDto.js.map +1 -0
- package/dist/generated/api/models/CatalogReleaseListResponse.d.ts +37 -0
- package/dist/generated/api/models/CatalogReleaseListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogReleaseListResponse.js +51 -0
- package/dist/generated/api/models/{StencilVersionListResponse.js.map → CatalogReleaseListResponse.js.map} +1 -1
- package/dist/generated/api/models/CatalogReleaseStatus.d.ts +30 -0
- package/dist/generated/api/models/CatalogReleaseStatus.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogReleaseStatus.js +48 -0
- package/dist/generated/api/models/CatalogReleaseStatus.js.map +1 -0
- package/dist/generated/api/models/CatalogRenderingDefaultsTooNewProblemDetail.d.ts +59 -0
- package/dist/generated/api/models/CatalogRenderingDefaultsTooNewProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogRenderingDefaultsTooNewProblemDetail.js +61 -0
- package/dist/generated/api/models/CatalogRenderingDefaultsTooNewProblemDetail.js.map +1 -0
- package/dist/generated/api/models/CatalogThemeReference.d.ts +43 -0
- package/dist/generated/api/models/CatalogThemeReference.d.ts.map +1 -0
- package/dist/generated/api/models/CatalogThemeReference.js +47 -0
- package/dist/generated/api/models/CatalogThemeReference.js.map +1 -0
- package/dist/generated/api/models/CodeListDto.d.ts +36 -33
- package/dist/generated/api/models/CodeListDto.d.ts.map +1 -1
- package/dist/generated/api/models/CodeListDto.js +24 -27
- package/dist/generated/api/models/CodeListDto.js.map +1 -1
- package/dist/generated/api/models/CodeListEntriesResponse.d.ts +2 -2
- package/dist/generated/api/models/CodeListEntriesResponse.js +2 -2
- package/dist/generated/api/models/CodeListEntryDto.d.ts +2 -2
- package/dist/generated/api/models/CodeListEntryDto.js +2 -2
- package/dist/generated/api/models/CodeListListResponse.d.ts +2 -2
- package/dist/generated/api/models/CodeListListResponse.js +2 -2
- package/dist/generated/api/models/CollectMeta.d.ts +6 -4
- package/dist/generated/api/models/CollectMeta.d.ts.map +1 -1
- package/dist/generated/api/models/CollectMeta.js +5 -5
- package/dist/generated/api/models/CollectMeta.js.map +1 -1
- package/dist/generated/api/models/CollectRequest.d.ts +2 -2
- package/dist/generated/api/models/CollectRequest.js +2 -2
- package/dist/generated/api/models/ConsumerDto.d.ts +13 -12
- package/dist/generated/api/models/ConsumerDto.d.ts.map +1 -1
- package/dist/generated/api/models/ConsumerDto.js +9 -7
- package/dist/generated/api/models/ConsumerDto.js.map +1 -1
- package/dist/generated/api/models/ConsumerListResponse.d.ts +2 -2
- package/dist/generated/api/models/ConsumerListResponse.js +2 -2
- package/dist/generated/api/models/ConsumerNodeDto.d.ts +2 -2
- package/dist/generated/api/models/ConsumerNodeDto.js +2 -2
- package/dist/generated/api/models/ConsumerPermissions.d.ts +16 -23
- package/dist/generated/api/models/ConsumerPermissions.d.ts.map +1 -1
- package/dist/generated/api/models/ConsumerPermissions.js +4 -13
- package/dist/generated/api/models/ConsumerPermissions.js.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequest.d.ts +7 -3
- package/dist/generated/api/models/CreateAttributeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequest.js +2 -2
- package/dist/generated/api/models/CreateAttributeRequest.js.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts +11 -5
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.d.ts.map +1 -1
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js +7 -9
- package/dist/generated/api/models/CreateAttributeRequestCodeListBinding.js.map +1 -1
- package/dist/generated/api/models/CreateCatalogReleaseRequest.d.ts +42 -0
- package/dist/generated/api/models/CreateCatalogReleaseRequest.d.ts.map +1 -0
- package/dist/generated/api/models/CreateCatalogReleaseRequest.js +47 -0
- package/dist/generated/api/models/CreateCatalogReleaseRequest.js.map +1 -0
- package/dist/generated/api/models/CreateCodeListRequest.d.ts +15 -11
- package/dist/generated/api/models/CreateCodeListRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateCodeListRequest.js +10 -10
- package/dist/generated/api/models/CreateCodeListRequest.js.map +1 -1
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts +10 -4
- package/dist/generated/api/models/CreateEnvironmentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateEnvironmentRequest.js +7 -5
- package/dist/generated/api/models/CreateEnvironmentRequest.js.map +1 -1
- package/dist/generated/api/models/CreateStencilRequest.d.ts +7 -7
- package/dist/generated/api/models/CreateStencilRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateStencilRequest.js +5 -5
- package/dist/generated/api/models/CreateStencilRequest.js.map +1 -1
- package/dist/generated/api/models/CreateTemplateRequest.d.ts +10 -4
- package/dist/generated/api/models/CreateTemplateRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateTemplateRequest.js +7 -5
- package/dist/generated/api/models/CreateTemplateRequest.js.map +1 -1
- package/dist/generated/api/models/CreateTenantRequest.d.ts +4 -6
- package/dist/generated/api/models/CreateTenantRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateTenantRequest.js +5 -5
- package/dist/generated/api/models/CreateTenantRequest.js.map +1 -1
- package/dist/generated/api/models/CreateThemeRequest.d.ts +5 -5
- package/dist/generated/api/models/CreateThemeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateThemeRequest.js +5 -5
- package/dist/generated/api/models/CreateThemeRequest.js.map +1 -1
- package/dist/generated/api/models/CreateVariantRequest.d.ts +4 -4
- package/dist/generated/api/models/CreateVariantRequest.d.ts.map +1 -1
- package/dist/generated/api/models/CreateVariantRequest.js +5 -5
- package/dist/generated/api/models/CreateVariantRequest.js.map +1 -1
- package/dist/generated/api/models/DataExampleDto.d.ts +6 -4
- package/dist/generated/api/models/DataExampleDto.d.ts.map +1 -1
- package/dist/generated/api/models/DataExampleDto.js +5 -5
- package/dist/generated/api/models/DataExampleDto.js.map +1 -1
- package/dist/generated/api/models/DataModelValidationError.d.ts +2 -2
- package/dist/generated/api/models/DataModelValidationError.js +2 -2
- package/dist/generated/api/models/DataModelValidationProblemDetail.d.ts +2 -2
- package/dist/generated/api/models/DataModelValidationProblemDetail.js +2 -2
- package/dist/generated/api/models/DeploymentDto.d.ts +88 -0
- package/dist/generated/api/models/DeploymentDto.d.ts.map +1 -0
- package/dist/generated/api/models/DeploymentDto.js +82 -0
- package/dist/generated/api/models/DeploymentDto.js.map +1 -0
- package/dist/generated/api/models/DeploymentEventDto.d.ts +90 -0
- package/dist/generated/api/models/DeploymentEventDto.d.ts.map +1 -0
- package/dist/generated/api/models/DeploymentEventDto.js +88 -0
- package/dist/generated/api/models/DeploymentEventDto.js.map +1 -0
- package/dist/generated/api/models/DeploymentHistoryResponse.d.ts +37 -0
- package/dist/generated/api/models/DeploymentHistoryResponse.d.ts.map +1 -0
- package/dist/generated/api/models/DeploymentHistoryResponse.js +51 -0
- package/dist/generated/api/models/DeploymentHistoryResponse.js.map +1 -0
- package/dist/generated/api/models/DeploymentListResponse.d.ts +32 -0
- package/dist/generated/api/models/{ActivationListResponse.d.ts.map → DeploymentListResponse.d.ts.map} +1 -1
- package/dist/generated/api/models/DeploymentListResponse.js +46 -0
- package/dist/generated/api/models/{ActivationListResponse.js.map → DeploymentListResponse.js.map} +1 -1
- package/dist/generated/api/models/DocumentDto.d.ts +43 -11
- package/dist/generated/api/models/DocumentDto.d.ts.map +1 -1
- package/dist/generated/api/models/DocumentDto.js +30 -14
- package/dist/generated/api/models/DocumentDto.js.map +1 -1
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts +43 -14
- package/dist/generated/api/models/DocumentGenerationItemDto.d.ts.map +1 -1
- package/dist/generated/api/models/DocumentGenerationItemDto.js +32 -16
- package/dist/generated/api/models/DocumentGenerationItemDto.js.map +1 -1
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts +10 -10
- package/dist/generated/api/models/DocumentGenerationJobDto.d.ts.map +1 -1
- package/dist/generated/api/models/DocumentGenerationJobDto.js +12 -12
- package/dist/generated/api/models/DocumentGenerationJobDto.js.map +1 -1
- package/dist/generated/api/models/DocumentListResponse.d.ts +2 -2
- package/dist/generated/api/models/DocumentListResponse.js +2 -2
- package/dist/generated/api/models/EnvironmentDto.d.ts +13 -19
- package/dist/generated/api/models/EnvironmentDto.d.ts.map +1 -1
- package/dist/generated/api/models/EnvironmentDto.js +12 -10
- package/dist/generated/api/models/EnvironmentDto.js.map +1 -1
- package/dist/generated/api/models/EnvironmentListResponse.d.ts +2 -2
- package/dist/generated/api/models/EnvironmentListResponse.js +2 -2
- package/dist/generated/api/models/FontDto.d.ts +25 -23
- package/dist/generated/api/models/FontDto.d.ts.map +1 -1
- package/dist/generated/api/models/FontDto.js +15 -18
- package/dist/generated/api/models/FontDto.js.map +1 -1
- package/dist/generated/api/models/FontListResponse.d.ts +2 -2
- package/dist/generated/api/models/FontListResponse.js +2 -2
- package/dist/generated/api/models/FontVariantDto.d.ts +2 -2
- package/dist/generated/api/models/FontVariantDto.js +2 -2
- package/dist/generated/api/models/GenerateBatchRequest.d.ts +2 -2
- package/dist/generated/api/models/GenerateBatchRequest.js +2 -2
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts +37 -14
- package/dist/generated/api/models/GenerateDocumentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/GenerateDocumentRequest.js +20 -14
- package/dist/generated/api/models/GenerateDocumentRequest.js.map +1 -1
- package/dist/generated/api/models/GenerationJobDetail.d.ts +2 -2
- package/dist/generated/api/models/GenerationJobDetail.js +2 -2
- package/dist/generated/api/models/GenerationJobListResponse.d.ts +2 -2
- package/dist/generated/api/models/GenerationJobListResponse.js +2 -2
- package/dist/generated/api/models/GenerationJobResponse.d.ts +10 -10
- package/dist/generated/api/models/GenerationJobResponse.d.ts.map +1 -1
- package/dist/generated/api/models/GenerationJobResponse.js +12 -12
- package/dist/generated/api/models/GenerationJobResponse.js.map +1 -1
- package/dist/generated/api/models/GenerationResult.d.ts +40 -11
- package/dist/generated/api/models/GenerationResult.d.ts.map +1 -1
- package/dist/generated/api/models/GenerationResult.js +27 -11
- package/dist/generated/api/models/GenerationResult.js.map +1 -1
- package/dist/generated/api/models/ImageDto.d.ts +23 -20
- package/dist/generated/api/models/ImageDto.d.ts.map +1 -1
- package/dist/generated/api/models/ImageDto.js +18 -21
- package/dist/generated/api/models/ImageDto.js.map +1 -1
- package/dist/generated/api/models/ImageListResponse.d.ts +2 -2
- package/dist/generated/api/models/ImageListResponse.js +2 -2
- package/dist/generated/api/models/ImportCatalogResponse.d.ts +31 -20
- package/dist/generated/api/models/ImportCatalogResponse.d.ts.map +1 -1
- package/dist/generated/api/models/ImportCatalogResponse.js +20 -16
- package/dist/generated/api/models/ImportCatalogResponse.js.map +1 -1
- package/dist/generated/api/models/InstallCatalogReleaseResponse.d.ts +74 -0
- package/dist/generated/api/models/InstallCatalogReleaseResponse.d.ts.map +1 -0
- package/dist/generated/api/models/InstallCatalogReleaseResponse.js +69 -0
- package/dist/generated/api/models/InstallCatalogReleaseResponse.js.map +1 -0
- package/dist/generated/api/models/InvalidDataField.d.ts +2 -2
- package/dist/generated/api/models/InvalidDataField.js +2 -2
- package/dist/generated/api/models/Margins.d.ts +2 -2
- package/dist/generated/api/models/Margins.js +2 -2
- package/dist/generated/api/models/MarkStencilReadyResponse.d.ts +43 -0
- package/dist/generated/api/models/MarkStencilReadyResponse.d.ts.map +1 -0
- package/dist/generated/api/models/MarkStencilReadyResponse.js +51 -0
- package/dist/generated/api/models/MarkStencilReadyResponse.js.map +1 -0
- package/dist/generated/api/models/MergeBaseMissingProblemDetail.d.ts +59 -0
- package/dist/generated/api/models/MergeBaseMissingProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/MergeBaseMissingProblemDetail.js +61 -0
- package/dist/generated/api/models/MergeBaseMissingProblemDetail.js.map +1 -0
- package/dist/generated/api/models/MergeConflictsUnresolvedProblemDetail.d.ts +55 -0
- package/dist/generated/api/models/MergeConflictsUnresolvedProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/MergeConflictsUnresolvedProblemDetail.js +59 -0
- package/dist/generated/api/models/MergeConflictsUnresolvedProblemDetail.js.map +1 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftRequest.d.ts +77 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftRequest.d.ts.map +1 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftRequest.js +52 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftRequest.js.map +1 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftResponse.d.ts +59 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftResponse.d.ts.map +1 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftResponse.js +59 -0
- package/dist/generated/api/models/MergeIntoCatalogDraftResponse.js.map +1 -0
- package/dist/generated/api/models/MissingDataField.d.ts +2 -2
- package/dist/generated/api/models/MissingDataField.js +2 -2
- package/dist/generated/api/models/MissingReleaseDependency.d.ts +52 -0
- package/dist/generated/api/models/MissingReleaseDependency.d.ts.map +1 -0
- package/dist/generated/api/models/MissingReleaseDependency.js +62 -0
- package/dist/generated/api/models/MissingReleaseDependency.js.map +1 -0
- package/dist/generated/api/models/MissingReleaseDependencyReason.d.ts +29 -0
- package/dist/generated/api/models/MissingReleaseDependencyReason.d.ts.map +1 -0
- package/dist/generated/api/models/MissingReleaseDependencyReason.js +47 -0
- package/dist/generated/api/models/MissingReleaseDependencyReason.js.map +1 -0
- package/dist/generated/api/models/Node.d.ts +3 -3
- package/dist/generated/api/models/Node.js +2 -2
- package/dist/generated/api/models/Orientation.d.ts +2 -2
- package/dist/generated/api/models/Orientation.js +2 -2
- package/dist/generated/api/models/PageFormat.d.ts +2 -2
- package/dist/generated/api/models/PageFormat.js +2 -2
- package/dist/generated/api/models/PageMeta.d.ts +3 -3
- package/dist/generated/api/models/PageMeta.d.ts.map +1 -1
- package/dist/generated/api/models/PageMeta.js +5 -5
- package/dist/generated/api/models/PageMeta.js.map +1 -1
- package/dist/generated/api/models/PageSettings.d.ts +2 -2
- package/dist/generated/api/models/PageSettings.js +2 -2
- package/dist/generated/api/models/PartitionAssignment.d.ts +14 -20
- package/dist/generated/api/models/PartitionAssignment.d.ts.map +1 -1
- package/dist/generated/api/models/PartitionAssignment.js +2 -2
- package/dist/generated/api/models/PartitionAssignment.js.map +1 -1
- package/dist/generated/api/models/PingRequest.d.ts +2 -2
- package/dist/generated/api/models/PingRequest.js +2 -2
- package/dist/generated/api/models/PongDetailsDto.d.ts +6 -5
- package/dist/generated/api/models/PongDetailsDto.d.ts.map +1 -1
- package/dist/generated/api/models/PongDetailsDto.js +2 -2
- package/dist/generated/api/models/PongDetailsDto.js.map +1 -1
- package/dist/generated/api/models/PongResponse.d.ts +7 -7
- package/dist/generated/api/models/PongResponse.js +4 -4
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts +45 -14
- package/dist/generated/api/models/PreviewDocumentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/PreviewDocumentRequest.js +22 -14
- package/dist/generated/api/models/PreviewDocumentRequest.js.map +1 -1
- package/dist/generated/api/models/ProblemDetail.d.ts +2 -2
- package/dist/generated/api/models/ProblemDetail.js +2 -2
- package/dist/generated/api/models/PublishReleaseToRegistryRequest.d.ts +31 -0
- package/dist/generated/api/models/PublishReleaseToRegistryRequest.d.ts.map +1 -0
- package/dist/generated/api/models/PublishReleaseToRegistryRequest.js +45 -0
- package/dist/generated/api/models/PublishReleaseToRegistryRequest.js.map +1 -0
- package/dist/generated/api/models/RegisterConsumerRequest.d.ts +2 -2
- package/dist/generated/api/models/RegisterConsumerRequest.js +2 -2
- package/dist/generated/api/models/RegistryReleaseDto.d.ts +57 -0
- package/dist/generated/api/models/RegistryReleaseDto.d.ts.map +1 -0
- package/dist/generated/api/models/RegistryReleaseDto.js +56 -0
- package/dist/generated/api/models/RegistryReleaseDto.js.map +1 -0
- package/dist/generated/api/models/RegistryReleaseListResponse.d.ts +54 -0
- package/dist/generated/api/models/RegistryReleaseListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/RegistryReleaseListResponse.js +62 -0
- package/dist/generated/api/models/RegistryReleaseListResponse.js.map +1 -0
- package/dist/generated/api/models/RejectConsumerRequest.d.ts +2 -2
- package/dist/generated/api/models/RejectConsumerRequest.js +2 -2
- package/dist/generated/api/models/ReleaseCatalogDraftRequest.d.ts +57 -0
- package/dist/generated/api/models/ReleaseCatalogDraftRequest.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseCatalogDraftRequest.js +49 -0
- package/dist/generated/api/models/ReleaseCatalogDraftRequest.js.map +1 -0
- package/dist/generated/api/models/ReleaseCatalogDraftResponse.d.ts +54 -0
- package/dist/generated/api/models/ReleaseCatalogDraftResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseCatalogDraftResponse.js +59 -0
- package/dist/generated/api/models/ReleaseCatalogDraftResponse.js.map +1 -0
- package/dist/generated/api/models/ReleaseDependenciesMissingProblemDetail.d.ts +56 -0
- package/dist/generated/api/models/ReleaseDependenciesMissingProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseDependenciesMissingProblemDetail.js +60 -0
- package/dist/generated/api/models/ReleaseDependenciesMissingProblemDetail.js.map +1 -0
- package/dist/generated/api/models/ReleaseDependenciesUnreleasedProblemDetail.d.ts +56 -0
- package/dist/generated/api/models/ReleaseDependenciesUnreleasedProblemDetail.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseDependenciesUnreleasedProblemDetail.js +60 -0
- package/dist/generated/api/models/ReleaseDependenciesUnreleasedProblemDetail.js.map +1 -0
- package/dist/generated/api/models/ReleaseDependencyDto.d.ts +66 -0
- package/dist/generated/api/models/ReleaseDependencyDto.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseDependencyDto.js +67 -0
- package/dist/generated/api/models/ReleaseDependencyDto.js.map +1 -0
- package/dist/generated/api/models/ReleasePublicationDto.d.ts +46 -0
- package/dist/generated/api/models/ReleasePublicationDto.d.ts.map +1 -0
- package/dist/generated/api/models/ReleasePublicationDto.js +56 -0
- package/dist/generated/api/models/ReleasePublicationDto.js.map +1 -0
- package/dist/generated/api/models/ReleasePublicationStatus.d.ts +35 -0
- package/dist/generated/api/models/ReleasePublicationStatus.d.ts.map +1 -0
- package/dist/generated/api/models/ReleasePublicationStatus.js +53 -0
- package/dist/generated/api/models/ReleasePublicationStatus.js.map +1 -0
- package/dist/generated/api/models/ReleaseRegistryDto.d.ts +38 -0
- package/dist/generated/api/models/ReleaseRegistryDto.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseRegistryDto.js +50 -0
- package/dist/generated/api/models/ReleaseRegistryDto.js.map +1 -0
- package/dist/generated/api/models/ReleaseRegistryKind.d.ts +33 -0
- package/dist/generated/api/models/ReleaseRegistryKind.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseRegistryKind.js +51 -0
- package/dist/generated/api/models/ReleaseRegistryKind.js.map +1 -0
- package/dist/generated/api/models/ReleaseRegistryListResponse.d.ts +34 -0
- package/dist/generated/api/models/ReleaseRegistryListResponse.d.ts.map +1 -0
- package/dist/generated/api/models/ReleaseRegistryListResponse.js +46 -0
- package/dist/generated/api/models/ReleaseRegistryListResponse.js.map +1 -0
- package/dist/generated/api/models/ReleasedChangeDto.d.ts +50 -0
- package/dist/generated/api/models/ReleasedChangeDto.d.ts.map +1 -0
- package/dist/generated/api/models/ReleasedChangeDto.js +61 -0
- package/dist/generated/api/models/ReleasedChangeDto.js.map +1 -0
- package/dist/generated/api/models/ReleasedDependencyDto.d.ts +49 -0
- package/dist/generated/api/models/ReleasedDependencyDto.d.ts.map +1 -0
- package/dist/generated/api/models/ReleasedDependencyDto.js +61 -0
- package/dist/generated/api/models/ReleasedDependencyDto.js.map +1 -0
- package/dist/generated/api/models/ResourceChangeDto.d.ts +64 -0
- package/dist/generated/api/models/ResourceChangeDto.d.ts.map +1 -0
- package/dist/generated/api/models/ResourceChangeDto.js +64 -0
- package/dist/generated/api/models/ResourceChangeDto.js.map +1 -0
- package/dist/generated/api/models/ResourceStatus.d.ts +38 -0
- package/dist/generated/api/models/ResourceStatus.d.ts.map +1 -0
- package/dist/generated/api/models/ResourceStatus.js +56 -0
- package/dist/generated/api/models/ResourceStatus.js.map +1 -0
- package/dist/generated/api/models/RotatePublicKeyRequest.d.ts +2 -2
- package/dist/generated/api/models/RotatePublicKeyRequest.js +2 -2
- package/dist/generated/api/models/Slot.d.ts +2 -2
- package/dist/generated/api/models/Slot.js +2 -2
- package/dist/generated/api/models/StencilContentDto.d.ts +56 -0
- package/dist/generated/api/models/StencilContentDto.d.ts.map +1 -0
- package/dist/generated/api/models/StencilContentDto.js +63 -0
- package/dist/generated/api/models/StencilContentDto.js.map +1 -0
- package/dist/generated/api/models/StencilDto.d.ts +15 -24
- package/dist/generated/api/models/StencilDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilDto.js +12 -14
- package/dist/generated/api/models/StencilDto.js.map +1 -1
- package/dist/generated/api/models/StencilListResponse.d.ts +2 -2
- package/dist/generated/api/models/StencilListResponse.js +2 -2
- package/dist/generated/api/models/StencilSummaryDto.d.ts +9 -20
- package/dist/generated/api/models/StencilSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilSummaryDto.js +12 -13
- package/dist/generated/api/models/StencilSummaryDto.js.map +1 -1
- package/dist/generated/api/models/StencilUsageDto.d.ts +15 -11
- package/dist/generated/api/models/StencilUsageDto.d.ts.map +1 -1
- package/dist/generated/api/models/StencilUsageDto.js +14 -14
- package/dist/generated/api/models/StencilUsageDto.js.map +1 -1
- package/dist/generated/api/models/StencilUsageListResponse.d.ts +3 -3
- package/dist/generated/api/models/StencilUsageListResponse.js +2 -2
- package/dist/generated/api/models/TemplateDataValidationError.d.ts +2 -2
- package/dist/generated/api/models/TemplateDataValidationError.js +2 -2
- package/dist/generated/api/models/TemplateDataValidationProblemDetail.d.ts +2 -2
- package/dist/generated/api/models/TemplateDataValidationProblemDetail.js +2 -2
- package/dist/generated/api/models/TemplateDataValidationResult.d.ts +3 -3
- package/dist/generated/api/models/TemplateDataValidationResult.js +2 -2
- package/dist/generated/api/models/TemplateDocument.d.ts +2 -2
- package/dist/generated/api/models/TemplateDocument.js +2 -2
- package/dist/generated/api/models/TemplateDto.d.ts +12 -18
- package/dist/generated/api/models/TemplateDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateDto.js +10 -10
- package/dist/generated/api/models/TemplateDto.js.map +1 -1
- package/dist/generated/api/models/TemplateListResponse.d.ts +2 -2
- package/dist/generated/api/models/TemplateListResponse.js +2 -2
- package/dist/generated/api/models/TemplateSummaryDto.d.ts +12 -18
- package/dist/generated/api/models/TemplateSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/TemplateSummaryDto.js +10 -10
- package/dist/generated/api/models/TemplateSummaryDto.js.map +1 -1
- package/dist/generated/api/models/TenantDto.d.ts +4 -16
- package/dist/generated/api/models/TenantDto.d.ts.map +1 -1
- package/dist/generated/api/models/TenantDto.js +5 -7
- package/dist/generated/api/models/TenantDto.js.map +1 -1
- package/dist/generated/api/models/TenantListResponse.d.ts +2 -2
- package/dist/generated/api/models/TenantListResponse.js +2 -2
- package/dist/generated/api/models/ThemeDto.d.ts +12 -20
- package/dist/generated/api/models/ThemeDto.d.ts.map +1 -1
- package/dist/generated/api/models/ThemeDto.js +8 -10
- package/dist/generated/api/models/ThemeDto.js.map +1 -1
- package/dist/generated/api/models/ThemeListResponse.d.ts +2 -2
- package/dist/generated/api/models/ThemeListResponse.js +2 -2
- package/dist/generated/api/models/ThemeRef.d.ts +5 -5
- package/dist/generated/api/models/ThemeRef.d.ts.map +1 -1
- package/dist/generated/api/models/ThemeRef.js +4 -4
- package/dist/generated/api/models/ThemeRef.js.map +1 -1
- package/dist/generated/api/models/UnreleasedCatalogDependency.d.ts +51 -0
- package/dist/generated/api/models/UnreleasedCatalogDependency.d.ts.map +1 -0
- package/dist/generated/api/models/UnreleasedCatalogDependency.js +61 -0
- package/dist/generated/api/models/UnreleasedCatalogDependency.js.map +1 -0
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts +13 -5
- package/dist/generated/api/models/UpdateAttributeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateAttributeRequest.js +4 -2
- package/dist/generated/api/models/UpdateAttributeRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts +12 -5
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js +7 -9
- package/dist/generated/api/models/UpdateAttributeRequestCodeListBinding.js.map +1 -1
- package/dist/generated/api/models/UpdateCatalogDependenciesRequest.d.ts +34 -0
- package/dist/generated/api/models/UpdateCatalogDependenciesRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateCatalogDependenciesRequest.js +46 -0
- package/dist/generated/api/models/UpdateCatalogDependenciesRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateCatalogReleaseRequest.d.ts +58 -0
- package/dist/generated/api/models/UpdateCatalogReleaseRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateCatalogReleaseRequest.js +51 -0
- package/dist/generated/api/models/UpdateCatalogReleaseRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateCodeListEntryHiddenRequest.js +2 -2
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts +7 -6
- package/dist/generated/api/models/UpdateCodeListRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateCodeListRequest.js +5 -5
- package/dist/generated/api/models/UpdateCodeListRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts +20 -6
- package/dist/generated/api/models/UpdateConsumerRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateConsumerRequest.js +4 -2
- package/dist/generated/api/models/UpdateConsumerRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts +9 -2
- package/dist/generated/api/models/UpdateEnvironmentRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateEnvironmentRequest.js +4 -2
- package/dist/generated/api/models/UpdateEnvironmentRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateStencilContentRequest.d.ts +46 -0
- package/dist/generated/api/models/UpdateStencilContentRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateStencilContentRequest.js +46 -0
- package/dist/generated/api/models/{CreateStencilVersionRequest.js.map → UpdateStencilContentRequest.js.map} +1 -1
- package/dist/generated/api/models/UpdateStencilRequest.d.ts +6 -3
- package/dist/generated/api/models/UpdateStencilRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateStencilRequest.js +2 -2
- package/dist/generated/api/models/UpdateStencilRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts +10 -6
- package/dist/generated/api/models/UpdateTemplateRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateTemplateRequest.js +4 -4
- package/dist/generated/api/models/UpdateTemplateRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateTenantRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateTenantRequest.js +2 -2
- package/dist/generated/api/models/UpdateThemeRequest.d.ts +15 -6
- package/dist/generated/api/models/UpdateThemeRequest.d.ts.map +1 -1
- package/dist/generated/api/models/UpdateThemeRequest.js +2 -2
- package/dist/generated/api/models/UpdateThemeRequest.js.map +1 -1
- package/dist/generated/api/models/UpdateVariantContentRequest.d.ts +32 -0
- package/dist/generated/api/models/UpdateVariantContentRequest.d.ts.map +1 -0
- package/dist/generated/api/models/UpdateVariantContentRequest.js +46 -0
- package/dist/generated/api/models/UpdateVariantContentRequest.js.map +1 -0
- package/dist/generated/api/models/UpdateVariantRequest.d.ts +2 -2
- package/dist/generated/api/models/UpdateVariantRequest.js +2 -2
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts +14 -12
- package/dist/generated/api/models/ValidateTemplateDataRequest.d.ts.map +1 -1
- package/dist/generated/api/models/ValidateTemplateDataRequest.js +8 -8
- package/dist/generated/api/models/ValidateTemplateDataRequest.js.map +1 -1
- package/dist/generated/api/models/ValidationError.d.ts +2 -2
- package/dist/generated/api/models/ValidationError.js +2 -2
- package/dist/generated/api/models/ValidationProblemDetail.d.ts +2 -2
- package/dist/generated/api/models/ValidationProblemDetail.js +2 -2
- package/dist/generated/api/models/VariantContentDto.d.ts +50 -0
- package/dist/generated/api/models/VariantContentDto.d.ts.map +1 -0
- package/dist/generated/api/models/VariantContentDto.js +61 -0
- package/dist/generated/api/models/VariantContentDto.js.map +1 -0
- package/dist/generated/api/models/VariantDto.d.ts +10 -25
- package/dist/generated/api/models/VariantDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantDto.js +12 -17
- package/dist/generated/api/models/VariantDto.js.map +1 -1
- package/dist/generated/api/models/VariantListResponse.d.ts +2 -2
- package/dist/generated/api/models/VariantListResponse.js +2 -2
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts +13 -16
- package/dist/generated/api/models/VariantSelectionAttribute.d.ts.map +1 -1
- package/dist/generated/api/models/VariantSelectionAttribute.js +4 -4
- package/dist/generated/api/models/VariantSelectionAttribute.js.map +1 -1
- package/dist/generated/api/models/VariantSummaryDto.d.ts +7 -22
- package/dist/generated/api/models/VariantSummaryDto.d.ts.map +1 -1
- package/dist/generated/api/models/VariantSummaryDto.js +9 -14
- package/dist/generated/api/models/VariantSummaryDto.js.map +1 -1
- package/dist/generated/api/models/index.d.ts +61 -34
- package/dist/generated/api/models/index.d.ts.map +1 -1
- package/dist/generated/api/models/index.js +61 -34
- package/dist/generated/api/models/index.js.map +1 -1
- package/dist/generated/api/runtime.d.ts +2 -2
- package/dist/generated/api/runtime.js +2 -2
- package/dist/generated/contractMediaTypes.d.ts +2 -2
- package/dist/generated/contractMediaTypes.js +2 -2
- package/dist/generated/contractOperations.d.ts +1 -1
- package/dist/generated/contractOperations.d.ts.map +1 -1
- package/dist/generated/contractOperations.js +104 -101
- package/dist/generated/contractOperations.js.map +1 -1
- package/dist/generated/contractVersion.d.ts +1 -1
- package/dist/generated/contractVersion.d.ts.map +1 -1
- package/dist/generated/contractVersion.js +1 -1
- package/dist/generated/contractVersion.js.map +1 -1
- package/dist/generated/knownProblemSlugs.d.ts +46 -0
- package/dist/generated/knownProblemSlugs.d.ts.map +1 -1
- package/dist/generated/knownProblemSlugs.js +46 -0
- package/dist/generated/knownProblemSlugs.js.map +1 -1
- package/dist/generated/modelValidation.d.ts +89 -33
- package/dist/generated/modelValidation.d.ts.map +1 -1
- package/dist/generated/modelValidation.js +524 -196
- package/dist/generated/modelValidation.js.map +1 -1
- package/dist/index.d.ts +4 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -1
- package/dist/validation/modelValidationException.d.ts +2 -2
- package/dist/validation/modelValidationException.d.ts.map +1 -1
- package/dist/validation/modelValidationException.js +1 -1
- package/dist/validation/serverTemplateDataValidator.d.ts +89 -0
- package/dist/validation/serverTemplateDataValidator.d.ts.map +1 -0
- package/dist/validation/serverTemplateDataValidator.js +106 -0
- package/dist/validation/serverTemplateDataValidator.js.map +1 -0
- package/dist/validation/templateDataValidator.d.ts +94 -0
- package/dist/validation/templateDataValidator.d.ts.map +1 -0
- package/dist/validation/templateDataValidator.js +23 -0
- package/dist/validation/templateDataValidator.js.map +1 -0
- package/dist/validation/templateSchemaValidator.d.ts +57 -61
- package/dist/validation/templateSchemaValidator.d.ts.map +1 -1
- package/dist/validation/templateSchemaValidator.js +97 -103
- package/dist/validation/templateSchemaValidator.js.map +1 -1
- package/package.json +1 -13
- package/dist/generated/api/apis/ContractsApi.d.ts +0 -144
- package/dist/generated/api/apis/ContractsApi.d.ts.map +0 -1
- package/dist/generated/api/apis/ContractsApi.js +0 -260
- package/dist/generated/api/apis/ContractsApi.js.map +0 -1
- package/dist/generated/api/apis/VersionsApi.d.ts +0 -248
- package/dist/generated/api/apis/VersionsApi.d.ts.map +0 -1
- package/dist/generated/api/apis/VersionsApi.js +0 -382
- package/dist/generated/api/apis/VersionsApi.js.map +0 -1
- package/dist/generated/api/models/ActivationDto.d.ts +0 -43
- package/dist/generated/api/models/ActivationDto.d.ts.map +0 -1
- package/dist/generated/api/models/ActivationDto.js +0 -57
- package/dist/generated/api/models/ActivationDto.js.map +0 -1
- package/dist/generated/api/models/ActivationListResponse.d.ts +0 -32
- package/dist/generated/api/models/ActivationListResponse.js +0 -46
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts +0 -43
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.d.ts.map +0 -1
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js +0 -57
- package/dist/generated/api/models/ApplyStencilUpgradeRequest.js.map +0 -1
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts +0 -50
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.d.ts.map +0 -1
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js +0 -54
- package/dist/generated/api/models/ApplyStencilUpgradeResponse.js.map +0 -1
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts +0 -53
- package/dist/generated/api/models/CatalogInstallResultDto.d.ts.map +0 -1
- package/dist/generated/api/models/CatalogInstallResultDto.js +0 -64
- package/dist/generated/api/models/CatalogInstallResultDto.js.map +0 -1
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts +0 -67
- package/dist/generated/api/models/CatalogUpgradeDiff.d.ts.map +0 -1
- package/dist/generated/api/models/CatalogUpgradeDiff.js +0 -79
- package/dist/generated/api/models/CatalogUpgradeDiff.js.map +0 -1
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts +0 -50
- package/dist/generated/api/models/ContractBreakingChangeDto.d.ts.map +0 -1
- package/dist/generated/api/models/ContractBreakingChangeDto.js +0 -63
- package/dist/generated/api/models/ContractBreakingChangeDto.js.map +0 -1
- package/dist/generated/api/models/ContractVersionListResponse.d.ts +0 -32
- package/dist/generated/api/models/ContractVersionListResponse.d.ts.map +0 -1
- package/dist/generated/api/models/ContractVersionListResponse.js +0 -46
- package/dist/generated/api/models/ContractVersionListResponse.js.map +0 -1
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts +0 -51
- package/dist/generated/api/models/ContractVersionSummaryDto.d.ts.map +0 -1
- package/dist/generated/api/models/ContractVersionSummaryDto.js +0 -62
- package/dist/generated/api/models/ContractVersionSummaryDto.js.map +0 -1
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts +0 -42
- package/dist/generated/api/models/CreateContractDraftResponse.d.ts.map +0 -1
- package/dist/generated/api/models/CreateContractDraftResponse.js +0 -57
- package/dist/generated/api/models/CreateContractDraftResponse.js.map +0 -1
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts +0 -41
- package/dist/generated/api/models/CreateStencilVersionRequest.d.ts.map +0 -1
- package/dist/generated/api/models/CreateStencilVersionRequest.js +0 -46
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts +0 -35
- package/dist/generated/api/models/DroppedStencilFillDto.d.ts.map +0 -1
- package/dist/generated/api/models/DroppedStencilFillDto.js +0 -49
- package/dist/generated/api/models/DroppedStencilFillDto.js.map +0 -1
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts +0 -62
- package/dist/generated/api/models/ImportTemplateResultDto.d.ts.map +0 -1
- package/dist/generated/api/models/ImportTemplateResultDto.js +0 -66
- package/dist/generated/api/models/ImportTemplateResultDto.js.map +0 -1
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts +0 -39
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.d.ts.map +0 -1
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js +0 -53
- package/dist/generated/api/models/IncompatibleTemplateVersionDto.js.map +0 -1
- package/dist/generated/api/models/PublishContractRequest.d.ts +0 -31
- package/dist/generated/api/models/PublishContractRequest.d.ts.map +0 -1
- package/dist/generated/api/models/PublishContractRequest.js +0 -43
- package/dist/generated/api/models/PublishContractRequest.js.map +0 -1
- package/dist/generated/api/models/PublishContractResponse.d.ts +0 -45
- package/dist/generated/api/models/PublishContractResponse.d.ts.map +0 -1
- package/dist/generated/api/models/PublishContractResponse.js +0 -55
- package/dist/generated/api/models/PublishContractResponse.js.map +0 -1
- package/dist/generated/api/models/PublishVersionRequest.d.ts +0 -31
- package/dist/generated/api/models/PublishVersionRequest.d.ts.map +0 -1
- package/dist/generated/api/models/PublishVersionRequest.js +0 -45
- package/dist/generated/api/models/PublishVersionRequest.js.map +0 -1
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts +0 -35
- package/dist/generated/api/models/ReleaseCatalogRequest.d.ts.map +0 -1
- package/dist/generated/api/models/ReleaseCatalogRequest.js +0 -47
- package/dist/generated/api/models/ReleaseCatalogRequest.js.map +0 -1
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts +0 -47
- package/dist/generated/api/models/ReleaseCatalogResponse.d.ts.map +0 -1
- package/dist/generated/api/models/ReleaseCatalogResponse.js +0 -59
- package/dist/generated/api/models/ReleaseCatalogResponse.js.map +0 -1
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts +0 -35
- package/dist/generated/api/models/RemovedCatalogResourceDto.d.ts.map +0 -1
- package/dist/generated/api/models/RemovedCatalogResourceDto.js +0 -49
- package/dist/generated/api/models/RemovedCatalogResourceDto.js.map +0 -1
- package/dist/generated/api/models/StencilVersionDto.d.ts +0 -79
- package/dist/generated/api/models/StencilVersionDto.d.ts.map +0 -1
- package/dist/generated/api/models/StencilVersionDto.js +0 -74
- package/dist/generated/api/models/StencilVersionDto.js.map +0 -1
- package/dist/generated/api/models/StencilVersionListResponse.d.ts +0 -37
- package/dist/generated/api/models/StencilVersionListResponse.d.ts.map +0 -1
- package/dist/generated/api/models/StencilVersionListResponse.js +0 -51
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts +0 -56
- package/dist/generated/api/models/StencilVersionSummaryDto.d.ts.map +0 -1
- package/dist/generated/api/models/StencilVersionSummaryDto.js +0 -65
- package/dist/generated/api/models/StencilVersionSummaryDto.js.map +0 -1
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts +0 -42
- package/dist/generated/api/models/UpdateContractDraftRequest.d.ts.map +0 -1
- package/dist/generated/api/models/UpdateContractDraftRequest.js +0 -48
- package/dist/generated/api/models/UpdateContractDraftRequest.js.map +0 -1
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts +0 -50
- package/dist/generated/api/models/UpdateContractDraftResponse.d.ts.map +0 -1
- package/dist/generated/api/models/UpdateContractDraftResponse.js +0 -63
- package/dist/generated/api/models/UpdateContractDraftResponse.js.map +0 -1
- package/dist/generated/api/models/UpdateDraftRequest.d.ts +0 -32
- package/dist/generated/api/models/UpdateDraftRequest.d.ts.map +0 -1
- package/dist/generated/api/models/UpdateDraftRequest.js +0 -44
- package/dist/generated/api/models/UpdateDraftRequest.js.map +0 -1
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts +0 -44
- package/dist/generated/api/models/UpdateStencilDraftRequest.d.ts.map +0 -1
- package/dist/generated/api/models/UpdateStencilDraftRequest.js +0 -46
- package/dist/generated/api/models/UpdateStencilDraftRequest.js.map +0 -1
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts +0 -44
- package/dist/generated/api/models/UpgradeCatalogRequest.d.ts.map +0 -1
- package/dist/generated/api/models/UpgradeCatalogRequest.js +0 -43
- package/dist/generated/api/models/UpgradeCatalogRequest.js.map +0 -1
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts +0 -49
- package/dist/generated/api/models/UpgradeCatalogResponse.d.ts.map +0 -1
- package/dist/generated/api/models/UpgradeCatalogResponse.js +0 -61
- package/dist/generated/api/models/UpgradeCatalogResponse.js.map +0 -1
- package/dist/generated/api/models/UpgradePreviewDto.d.ts +0 -56
- package/dist/generated/api/models/UpgradePreviewDto.d.ts.map +0 -1
- package/dist/generated/api/models/UpgradePreviewDto.js +0 -70
- package/dist/generated/api/models/UpgradePreviewDto.js.map +0 -1
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts +0 -32
- package/dist/generated/api/models/UpgradePreviewListResponse.d.ts.map +0 -1
- package/dist/generated/api/models/UpgradePreviewListResponse.js +0 -46
- package/dist/generated/api/models/UpgradePreviewListResponse.js.map +0 -1
- package/dist/generated/api/models/VersionDto.d.ts +0 -65
- package/dist/generated/api/models/VersionDto.d.ts.map +0 -1
- package/dist/generated/api/models/VersionDto.js +0 -72
- package/dist/generated/api/models/VersionDto.js.map +0 -1
- package/dist/generated/api/models/VersionListResponse.d.ts +0 -37
- package/dist/generated/api/models/VersionListResponse.d.ts.map +0 -1
- package/dist/generated/api/models/VersionListResponse.js +0 -51
- package/dist/generated/api/models/VersionListResponse.js.map +0 -1
- package/dist/generated/api/models/VersionSummaryDto.d.ts +0 -60
- package/dist/generated/api/models/VersionSummaryDto.d.ts.map +0 -1
- package/dist/generated/api/models/VersionSummaryDto.js +0 -69
- package/dist/generated/api/models/VersionSummaryDto.js.map +0 -1
- package/dist/validation/ajvLoader.d.ts +0 -52
- package/dist/validation/ajvLoader.d.ts.map +0 -1
- package/dist/validation/ajvLoader.js +0 -60
- package/dist/validation/ajvLoader.js.map +0 -1
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
//
|
|
3
3
|
// SPDX-License-Identifier: EUPL-1.2
|
|
4
4
|
import { ResponseError } from '../generated/api/runtime.js';
|
|
5
|
+
import { KnownProblemSlugs, ProblemExtensionMembers } from '../generated/knownProblemSlugs.js';
|
|
5
6
|
import { BLANK_TYPE, slugFor } from './problemTypes.js';
|
|
6
7
|
/**
|
|
7
8
|
* A {@link ResponseError} carrying a parsed [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)
|
|
@@ -15,7 +16,11 @@ import { BLANK_TYPE, slugFor } from './problemTypes.js';
|
|
|
15
16
|
* The machine-readable discriminator is the problem {@link type} URI; switch on {@link typeSlug}.
|
|
16
17
|
* Field-level validation errors (the `ValidationProblemDetail` shape) are surfaced via
|
|
17
18
|
* {@link errors}; per-example data-model validation failures (the `DataModelValidationProblemDetail`
|
|
18
|
-
* shape, `data-model-validation-error`) via {@link validationErrors}
|
|
19
|
+
* shape, `data-model-validation-error`) via {@link validationErrors}; the releases a deployment lacks
|
|
20
|
+
* (`release-dependencies-missing`) via {@link missingDependencies}; the drafts of other catalogs a
|
|
21
|
+
* release would need released first (`release-dependencies-unreleased`) via
|
|
22
|
+
* {@link unreleasedDependencies}; why a catalog cannot be changed (`catalog-read-only`) via
|
|
23
|
+
* {@link readOnlyReason}. Any *other* member a problem
|
|
19
24
|
* body carries — one the contract does not name, such as `catalog-schema-too-old`'s `version` /
|
|
20
25
|
* `baselineVersion` — is in {@link extensions}.
|
|
21
26
|
*/
|
|
@@ -92,6 +97,136 @@ export class ProblemDetailException extends ResponseError {
|
|
|
92
97
|
get isDataModelValidationProblem() {
|
|
93
98
|
return Object.keys(this.validationErrors).length > 0;
|
|
94
99
|
}
|
|
100
|
+
/**
|
|
101
|
+
* Absent fields reported by a `template-data-invalid` problem; empty for any other.
|
|
102
|
+
*
|
|
103
|
+
* Each `path` is a JSON Pointer into the request's `data`, and `schema` is the contract's schema
|
|
104
|
+
* for that field, so a caller can ask for exactly what is missing. An entry whose `required` is
|
|
105
|
+
* false is informational: the resolved version's template reads the field, but leaving it out
|
|
106
|
+
* does not make the data invalid.
|
|
107
|
+
*
|
|
108
|
+
* Read off {@link extensions}, which already carries every member the base problem does not
|
|
109
|
+
* model, so this is a typed view rather than extra parsing.
|
|
110
|
+
*/
|
|
111
|
+
get missingFields() {
|
|
112
|
+
return objectsAt(this.extensions, ProblemExtensionMembers.MISSING_FIELDS);
|
|
113
|
+
}
|
|
114
|
+
/** Supplied values the template's data contract rejected; empty for any other problem. */
|
|
115
|
+
get invalidFields() {
|
|
116
|
+
return objectsAt(this.extensions, ProblemExtensionMembers.INVALID_FIELDS);
|
|
117
|
+
}
|
|
118
|
+
/** True when this problem described template data field by field. */
|
|
119
|
+
get isTemplateDataProblem() {
|
|
120
|
+
return this.missingFields.length > 0 || this.invalidFields.length > 0;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* The releases a `release-dependencies-missing` problem (409, from `deployCatalogRelease`) reports cannot
|
|
124
|
+
* be had, in the order the server listed them; empty for any other problem.
|
|
125
|
+
*
|
|
126
|
+
* These are the releases the deployed release pins that the tenant does not have and that could
|
|
127
|
+
* not be fetched or verified. Each
|
|
128
|
+
* {@link MissingDependency.reason} is kept as the string the server sent, so a reason the
|
|
129
|
+
* contract adds later is not lost. An entry that does not carry all five members as strings is
|
|
130
|
+
* dropped rather than guessed at.
|
|
131
|
+
*/
|
|
132
|
+
get missingDependencies() {
|
|
133
|
+
return objectsAt(this.extensions, ProblemExtensionMembers.MISSING_DEPENDENCIES).filter(isMissingDependency);
|
|
134
|
+
}
|
|
135
|
+
/** True when this problem listed releases a deployment is missing. */
|
|
136
|
+
get isReleaseDependenciesMissingProblem() {
|
|
137
|
+
return this.missingDependencies.length > 0;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* The drafts of other catalogs a `release-dependencies-unreleased` problem (409, from
|
|
141
|
+
* `releaseCatalogDraft`) reports the released draft's dependency declarations name, directly or
|
|
142
|
+
* through another such draft, in the order the server listed them; empty for any other problem.
|
|
143
|
+
*
|
|
144
|
+
* Release them first, or along with the draft (`releaseDependencies`). An entry that does not
|
|
145
|
+
* carry all five members as strings is dropped rather than guessed at.
|
|
146
|
+
*/
|
|
147
|
+
get unreleasedDependencies() {
|
|
148
|
+
return objectsAt(this.extensions, ProblemExtensionMembers.UNRELEASED_DEPENDENCIES).filter(isUnreleasedDependency);
|
|
149
|
+
}
|
|
150
|
+
/** True when this problem listed dependency drafts a release would need released first. */
|
|
151
|
+
get isReleaseDependenciesUnreleasedProblem() {
|
|
152
|
+
return this.unreleasedDependencies.length > 0;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* Why the catalog cannot be changed, from a `catalog-read-only` problem (409, from any write to
|
|
156
|
+
* a catalog whose `CatalogDto.editable` is false): `editing-disabled` (the installation only
|
|
157
|
+
* receives and runs releases) or `supplied-by-epistola` (the server supplies the catalog). Kept
|
|
158
|
+
* as the string the server sent, so a reason a later contract adds is surfaced; `undefined` for
|
|
159
|
+
* any other problem, and when the member is not a string.
|
|
160
|
+
*/
|
|
161
|
+
get readOnlyReason() {
|
|
162
|
+
const value = this.extensions[ProblemExtensionMembers.READ_ONLY_REASON];
|
|
163
|
+
return typeof value === 'string' ? value : undefined;
|
|
164
|
+
}
|
|
165
|
+
/** True when this problem said the catalog cannot be changed, and why. */
|
|
166
|
+
get isCatalogReadOnlyProblem() {
|
|
167
|
+
return this.readOnlyReason !== undefined;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* The conflicts a `merge-conflicts-unresolved` problem (409, from `mergeIntoCatalogDraft`,
|
|
171
|
+
* alpha) lists without a resolution, each as `resourceType/resourceKey`, in the order the server
|
|
172
|
+
* listed them; empty for any other problem. An entry that is not a string is dropped.
|
|
173
|
+
*/
|
|
174
|
+
get unresolvedConflicts() {
|
|
175
|
+
const value = this.extensions[ProblemExtensionMembers.UNRESOLVED_CONFLICTS];
|
|
176
|
+
return Array.isArray(value) ? value.filter((entry) => typeof entry === 'string') : [];
|
|
177
|
+
}
|
|
178
|
+
/** True when this problem listed merge conflicts that need a resolution. */
|
|
179
|
+
get isMergeConflictsUnresolvedProblem() {
|
|
180
|
+
return this.unresolvedConflicts.length > 0;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* The version of the release a `merge-base-missing` problem (409, from `mergeIntoCatalogDraft`,
|
|
184
|
+
* alpha) asks to get first: the merge base, which this installation does not have. Read from the
|
|
185
|
+
* `version` member of that problem only, since other problems use the name for other things;
|
|
186
|
+
* `undefined` for any other problem, and when the member is not a string.
|
|
187
|
+
*/
|
|
188
|
+
get missingBaseVersion() {
|
|
189
|
+
return this.mergeBaseMissingMember(ProblemExtensionMembers.VERSION);
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* That release's catalog fingerprint (`v5:<hex>`), from the `fingerprint` member of a
|
|
193
|
+
* `merge-base-missing` problem; `undefined` for any other problem, and when it is not a string.
|
|
194
|
+
*/
|
|
195
|
+
get missingBaseFingerprint() {
|
|
196
|
+
return this.mergeBaseMissingMember(ProblemExtensionMembers.FINGERPRINT);
|
|
197
|
+
}
|
|
198
|
+
/** True when this problem named a merge base this installation does not have. */
|
|
199
|
+
get isMergeBaseMissingProblem() {
|
|
200
|
+
return this.missingBaseVersion !== undefined;
|
|
201
|
+
}
|
|
202
|
+
mergeBaseMissingMember(member) {
|
|
203
|
+
if (this.typeSlug !== KnownProblemSlugs.MERGE_BASE_MISSING)
|
|
204
|
+
return undefined;
|
|
205
|
+
const value = this.extensions[member];
|
|
206
|
+
return typeof value === 'string' ? value : undefined;
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
const MISSING_DEPENDENCY_MEMBERS = ['registry', 'namespace', 'catalogKey', 'version', 'reason'];
|
|
210
|
+
function isMissingDependency(entry) {
|
|
211
|
+
const record = entry;
|
|
212
|
+
return MISSING_DEPENDENCY_MEMBERS.every((member) => typeof record[member] === 'string');
|
|
213
|
+
}
|
|
214
|
+
const UNRELEASED_DEPENDENCY_MEMBERS = ['registry', 'namespace', 'catalogKey', 'releaseId', 'releaseName'];
|
|
215
|
+
function isUnreleasedDependency(entry) {
|
|
216
|
+
const record = entry;
|
|
217
|
+
return UNRELEASED_DEPENDENCY_MEMBERS.every((member) => typeof record[member] === 'string');
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* One extension member's array of objects, or empty when absent or malformed. Entries of an
|
|
221
|
+
* unexpected shape are dropped rather than guessed at: a malformed problem body should not become a
|
|
222
|
+
* confident claim about a particular field.
|
|
223
|
+
*/
|
|
224
|
+
function objectsAt(extensions, member) {
|
|
225
|
+
const value = extensions[member];
|
|
226
|
+
if (!Array.isArray(value)) {
|
|
227
|
+
return [];
|
|
228
|
+
}
|
|
229
|
+
return value.filter((entry) => entry !== null && typeof entry === 'object' && !Array.isArray(entry));
|
|
95
230
|
}
|
|
96
231
|
function buildMessage(status, problem) {
|
|
97
232
|
const title = problem.title || String(status);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"problemDetailException.js","sourceRoot":"","sources":["../../src/error/problemDetailException.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,oCAAoC;
|
|
1
|
+
{"version":3,"file":"problemDetailException.js","sourceRoot":"","sources":["../../src/error/problemDetailException.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,oCAAoC;AAapC,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAA;AAC9F,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,sBAAuB,SAAQ,aAAa;IAG5C,OAAO;IAEP,MAAM;IAKN,gBAAgB;IAMhB,UAAU;IAEV,UAAU;IAEV,OAAO;IAnBlB;IACE,iFAAiF;IACxE,OAAsB;IAC/B,+FAA+F;IACtF,MAAkC;IAC3C;;;OAGG;IACM,gBAA+E;IACxF;;;;OAIG;IACM,UAA6C;IACtD,6CAA6C;IACpC,UAAkB;IAC3B,qCAAqC;IAC5B,OAAe,EACxB,QAAkB;QAElB,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAA;uBApBzC,OAAO;sBAEP,MAAM;gCAKN,gBAAgB;0BAMhB,UAAU;0BAEV,UAAU;uBAEV,OAAO;IAIlB,CAAC;IAED,+DAA+D;IAC/D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,UAAU,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAED,2EAA2E;IAC3E,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,uFAAuF;IACvF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,mGAAmG;IACnG,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;IAC9B,CAAC;IAED,oEAAoE;IACpE,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED,iFAAiF;IACjF,IAAI,4BAA4B;QAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IACtD,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,aAAa;QACf,OAAO,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAuB,CAAC,cAAc,CAAgC,CAAA;IAC1G,CAAC;IAED,0FAA0F;IAC1F,IAAI,aAAa;QACf,OAAO,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAuB,CAAC,cAAc,CAAgC,CAAA;IAC1G,CAAC;IAED,qEAAqE;IACrE,IAAI,qBAAqB;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAA;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,mBAAmB;QACrB,OAAO,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAA;IAC7G,CAAC;IAED,sEAAsE;IACtE,IAAI,mCAAmC;QACrC,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAA;IAC5C,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,sBAAsB;QACxB,OAAO,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAuB,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAA;IACnH,CAAC;IAED,2FAA2F;IAC3F,IAAI,sCAAsC;QACxC,OAAO,IAAI,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,IAAI,cAAc;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAA;QACvE,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IACtD,CAAC;IAED,0EAA0E;IAC1E,IAAI,wBAAwB;QAC1B,OAAO,IAAI,CAAC,cAAc,KAAK,SAAS,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACH,IAAI,mBAAmB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAA;QAC3E,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IACxG,CAAC;IAED,4EAA4E;IAC5E,IAAI,iCAAiC;QACnC,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAA;IAC5C,CAAC;IAED;;;;;OAKG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAA;IACrE,CAAC;IAED;;;OAGG;IACH,IAAI,sBAAsB;QACxB,OAAO,IAAI,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAA;IACzE,CAAC;IAED,iFAAiF;IACjF,IAAI,yBAAyB;QAC3B,OAAO,IAAI,CAAC,kBAAkB,KAAK,SAAS,CAAA;IAC9C,CAAC;IAEO,sBAAsB,CAAC,MAAc;QAC3C,IAAI,IAAI,CAAC,QAAQ,KAAK,iBAAiB,CAAC,kBAAkB;YAAE,OAAO,SAAS,CAAA;QAC5E,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IACtD,CAAC;CACF;AAYD,MAAM,0BAA0B,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAA;AAExG,SAAS,mBAAmB,CAAC,KAAa;IACxC,MAAM,MAAM,GAAG,KAAgC,CAAA;IAC/C,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAA;AACzF,CAAC;AAQD,MAAM,6BAA6B,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,CAAU,CAAA;AAElH,SAAS,sBAAsB,CAAC,KAAa;IAC3C,MAAM,MAAM,GAAG,KAAgC,CAAA;IAC/C,OAAO,6BAA6B,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAA;AAC5F,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,UAA6C,EAAE,MAAc;IAC9E,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;AACvH,CAAC;AAED,SAAS,YAAY,CAAC,MAAc,EAAE,OAAsB;IAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,CAAA;IAC7C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,KAAK,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,KAAK,EAAE,CAAA;AACxF,CAAC"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Epistola API
|
|
3
|
-
* Document template management API for Epistola Suite. ## Versioning This API uses header-based versioning via the Accept header. Use `application/vnd.epistola.v1+json` for API version 1. ## Authentication The API accepts authentication through the `Authorization` header: - **API key**: `Authorization: ApiKey <key>` for static tenant API keys. This is the supported method. A tenant manager issues each key for one tenant with a set of tenant roles. - **Bearer JWT** (**experimental**): `Authorization: Bearer <jwt>`, either issued by an OAuth 2.0 identity provider or self-signed with a key pair registered through the Consumers API. Epistola Suite may not implement the consumer model these rely on yet, and the flow may still change. The legacy `X-API-Key` header remains supported for existing integrations, but is deprecated. New API-key integrations should use `Authorization: ApiKey <key>`. See the [Authentication Guide](/docs/auth.md) for details. ## Client Identity All requests must include the following headers for client identification: - **`User-Agent`** (required) — identifies the client software stack using standard [RFC 9110 §10.1.5](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens. The first token **must** be `epistola-contract/{version}` indicating the contract version the client was built against. Additional product/version pairs can be appended to describe the full software stack. Example: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0` - **`X-EP-Node-Id`** (required) — identifies the specific client node. Use the Kubernetes pod name, container ID, or hostname. In local/dev environments, the machine hostname is acceptable. The generated Epistola client libraries set both headers automatically — `User-Agent` with the contract version, and `X-EP-Node-Id` with the hostname. Consumers wrapping the client library can append additional product tokens to `User-Agent` for their own software and override the node ID as needed. ## Error Responses The API uses [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) for error responses. Error responses have `Content-Type: application/problem+json` and include the following fields: - `type` (string, URI) — identifies the problem type; the stable, machine-readable discriminator clients should switch on - `title` (string) — short human-readable summary - `status` (integer) — HTTP status code - `detail` (string, optional) — human-readable explanation of this occurrence - `instance` (string, URI, optional) — identifies this specific occurrence Problem `type` URIs use the `https://epistola.app/errors/{slug}` namespace and resolve to human-readable HTML documentation for that problem type. A response may also carry domain-specific extension members as top-level fields; clients should ignore members they do not recognize. For validation errors (`type: .../validation-error`), the response also includes an `errors` array with field-level details. The canonical problem `type` slugs are registered in [`docs/error-types.md`](docs/error-types.md); the machine-readable registry is this document\'s top-level `x-problem-types` extension. ## Authorization Access is controlled via Suite permissions such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE`, and `CATALOG_MANAGE`. Tenant permissions are derived from the Suite tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`) or from the roles stored on an API key. Platform-only tenant management uses the `TENANT_MANAGER` platform role.
|
|
3
|
+
* Epistola generates documents, PDFs, from templates. Authors design the templates; applications send data and get documents back. This API manages templates and the catalogs that hold them, and generates documents from them, asynchronously and at volume. ## Glossary - **Tenant**: an organisation, isolated from every other. Everything else lives in one, under `/tenants/{tenantKey}`. - **Catalog**: a set of templates and everything they use, released as a whole. A catalog is named by three parts together: a **registry**, the DNS name of where it is published (`exchange.epistola.app`, or a domain that publishes its own, `acme.com`); a **namespace**, its publisher within that registry (`acme-corp`); and its key (`letters`). In a path, `~` stands for the server\'s default registry. The registry `local` names catalogs that never leave the organisation: valid within its own installations, refused by an Exchange. - **Release**: the catalog as a whole at one point, in one of two statuses. A **draft release**, or **draft**, is editable and has no version; a **released** release is immutable and has a version. \"Release `1.4.0`\" means the released one. - **Version**: the number of a released release, its `version` (`1.4.0`), a SemVer core version, or a patch release number (`1.3.1-gemeente-x.1`, see \"Versions and version ranges\"). A **version range**, `versionRange` (`^1.4.0`), selects the highest release that satisfies it, for a request that renders; it never matches a draft. - **Content hash**: what identifies a released release, its `contentHash` (`v6:…`), a hash of its content alone, not of its name or number: two releases with one content hash are the same release, whatever they are called. Names and numbers point at content hashes. - **Releasing**: turning a draft into a released release, as a version. A release keeps its id, its `releaseId`, assigned by the server, and its name when it is released, so a draft released as `1.4.1` is the same release, addressed by its `releaseId` or by `1.4.1`. - **Publishing**: making a catalog available in a registry, for other tenants and installations to install from. Only released releases are ever published; releasing is not publishing. - **Base**: the release a draft started from; its changes are measured against it. A draft is **behind** a release whose changes it may lack (see \"Releases\"). A changed resource is **ready** once someone marks it reviewed; a draft is released only when it changed something and all its changes are (`getCatalogChanges`). - **Editable** catalogs: every catalog has releases and drafts, wherever its releases come from (its **source**: an exchange, a registry, a file, or the server itself). Whether a catalog can be changed depends on the installation, which may only receive and run releases, and on whether the server supplies the catalog itself (`CatalogDto.editable`, `readOnlyReason`). - **Environment**: where documents are generated for a purpose, such as `staging` or `production`. A **deployment** makes an environment serve a release of a catalog; a request through the environment renders what it serves. - **Template**: one kind of document, with its data contract (the JSON Schema its data must meet) and data examples. A **variant** is one rendering of a template, for a language or a brand, chosen by its key or by **attributes** (such as `locale`); an attribute\'s values may come from a **code list** of `{code, label}` entries. A **stencil** is reusable template content, a **theme** a reusable set of styles, and a **preset** a named block style a catalog declares and its themes style. - **Consumer** (experimental): an application registered in a tenant, with its own permissions. ## Getting started 1. **Get an API key** from a tenant manager. A key belongs to one tenant and carries the roles it was issued with: `CONTENT_VIEWER` to find templates and read jobs and documents, and `DOCUMENT_GENERATOR` to generate. 2. **Send these headers** on every request (the client libraries set all but the key): ``` Authorization: ApiKey <key> Accept: application/vnd.epistola.v2+json Content-Type: application/vnd.epistola.v2+json (with a request body) User-Agent: epistola-contract/2.0.0 your-app/1.0 X-EP-Node-Id: <this host or pod> ``` 3. **Find your template.** `GET /tenants/{tenantKey}/catalogs` lists the catalogs, each with its `registry`, `namespace`, `catalogKey` and `highestVersion`. `GET /tenants/{tenantKey}/catalogs/{registry}/{namespace}/{catalogKey}/releases/{release}/templates`, with that version as `{release}`, lists that release\'s templates, and `getTemplate` shows a template\'s data contract. 4. **Generate.** `POST /tenants/{tenantKey}/documents/generate` with the template and its data: ```json {\"namespace\": \"acme-corp\", \"catalogKey\": \"letters\", \"templateKey\": \"invoice\", \"variantKey\": \"english\", \"data\": {\"customer\": {\"name\": \"Jane Smith\"}}} ``` It answers `202` with a `requestId` and, in `Location`, the job\'s address. Without a `versionRange` or an `environmentKey`, the catalog\'s highest release renders. 5. **Poll the job**, `GET /tenants/{tenantKey}/documents/jobs/{requestId}`, until `request.status` is `completed` (or `failed` or `cancelled`). Each item names its `documentId`. 6. **Download** the PDF: `GET /tenants/{tenantKey}/documents/{documentId}`. `validateTemplateData` checks data against a template\'s contract before you submit it, and `previewDocument` renders one document synchronously, for previews only. For high volume, poll no jobs: collect finished results as a stream instead (`collectGenerationResults`), each delivered to the node that asked for it and acknowledged when handled. That is the advanced path; the client libraries\' result collectors implement it. ## Media types The media type carries the API\'s major version. Contract 2.x uses `application/vnd.epistola.v2+json`, and `application/vnd.epistola.v2+ndjson` for the result stream, in `Accept` and in `Content-Type`. Problems are `application/problem+json`. ## Client identity Every request identifies the client with two headers: - **`User-Agent`** (required): [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110#name-user-agent) product tokens, the first of which **must** be `epistola-contract/{version}`, the contract version the client was built against. Further tokens describe the rest of the stack: `epistola-contract/x.y.z valtimo-epistola-plugin/1.2.0 gzac/5.0.0`. - **`X-EP-Node-Id`** (required): the client node, such as its Kubernetes pod name, container id or hostname. The client libraries set both, the contract version and the hostname; an application can append its own product tokens and override the node id. ## Releases A catalog consists of releases, addressed as `/catalogs/{registry}/{namespace}/{catalogKey}/releases/{release}`, with the catalog\'s resources below each. A draft is addressed by its `releaseId`; a released release by its `releaseId` or its version, which address the same release. Every write to a released release is refused with 409. - A catalog that can be changed has **any number of drafts**, each named, each started from a released release (its base) or from another draft (`createCatalogRelease`). The base never moves. `listCatalogReleases` lists a catalog\'s releases, drafts included, each with its `status` (`?status=draft` for the drafts only) and, once released, its `contentHash` (`?contentHash=` for the releases with that content); a catalog (`CatalogDto`) does not list them. - **Any draft can be released.** Its version follows from the kind of change against its base: fixes raise the patch, additions the minor, anything that breaks callers the major (`previewCatalogDraftRelease`). The author may choose a higher version, never a lower one or one another release has. A fix to an older line is a draft from a release of that line: from `1.4.0`, while `1.5.0` and `2.0.0` exist, it is released as `1.4.1`. - **Drafts are independent copies**: releasing one changes no other. A draft is **behind** each release whose version is between its base and the version it would get, and each release released after it was started whose version is below that one; it lacks their changes unless an author applied them by hand. `getCatalogRelease` lists them, and releasing a draft that is behind must acknowledge them. - **Merging a release into a draft** (alpha, `x-experimental`): `previewCatalogDraftMerge` shows, per resource, per catalog setting (default theme and presets, entries of type `catalog`) and per catalog used (entries of type `catalogDependency`), each with the entries it goes with (`needs`), against the merge base (the closest release both descend from), what only the draft changed (`ours`), what only the release changed (`theirs`) and what both changed differently (`conflict`); `mergeIntoCatalogDraft` takes theirs and applies a resolution, `ours` or `theirs`, per conflict. The draft then contains the release and is no longer behind it; its base does not move. The preview\'s `token`, sent back as `expectedToken`, makes the merge apply what the preview showed or nothing (`merge-preview-outdated`). A conflict can also be resolved to content combined from its sides (`getCatalogDraftMergeSides`, then `mergedContent`), reviewed before the draft is released. The merge needs the merge base installed; the preview names one that is not (`missingBase`), and the merge is refused with `merge-base-missing`. - **Release registries** (alpha, `x-experimental`, ADR 0008) move releases between installations: an Epistola Exchange the installation is connected to, or a container registry it is configured with (`listReleaseRegistries`). A released release is published to one (`publishReleaseToRegistry`), and another installation lists the releases of a catalog there (`listRegistryReleases`) and installs one (`installRegistryRelease`) as an import does. A release registry is named by the installation; it is not the `{registry}` of a catalog\'s name. Documents are rendered from releases, and a version range never matches a draft. A draft renders only in a preview that names its `releaseId`, and in an environment it is deployed to. Importing a catalog archive (`importCatalog`) installs the release the archive carries, at its version, beside the releases the tenant already has; it never creates or changes a draft. A catalog with a source (`CatalogDto.source`) installs releases from it the same way (`installCatalogRelease`), and `listAvailableCatalogReleases` lists those the tenant does not have yet, older lines included. Nothing is updated in place or removed: deploying decides what an environment serves. A release keeps its id and number wherever it moves, so it is the same release in every installation. There are no catalog types: receiving releases works whether or not the catalog can be changed, and every write to one that cannot is refused with 409 `catalog-read-only`. ## Deploying An environment serves releases of catalogs (`deployCatalogRelease`): released ones, several of one catalog if need be, and at most one draft per catalog, rendered live. A request through the environment (`environmentKey`) renders: - with **no `versionRange`**: the catalog\'s deployed draft if there is one, else the highest release the environment serves; - with a **range or an exact version**: the highest served release that satisfies it. A draft never matches: it has no version. Rollback is undeploying the newer release. Deploying a draft replaces the draft the environment served for that catalog, and an environment marked **production** (`EnvironmentDto.production`) serves no draft. A document rendered from a draft carries the draft\'s `releaseId` and its name at render time (`draftLabel`), with a null `version`, and its PDF a preview watermark. Releasing a deployed draft keeps its `releaseId`, so the environment then serves it as released; discarding the draft ends the deployment. ## Versions and version ranges A version (`ReleaseVersion`) is a SemVer core version, `MAJOR.MINOR.PATCH` without leading zeros, as the holder of the catalog\'s namespace issues it, or a **patch release** number, `MAJOR.MINOR.PATCH-<namespace>.<N>`, at most 128 characters. Wherever the contract names one exact version it has that form, and is called `version`; every member called `version` is one. A patch release is how someone who does not hold a catalog\'s namespace fixes a release of it (a municipality fixing a supplier\'s catalog): it is labelled with a namespace they hold, and numbered from 1, `1.3.1-gemeente-x.1`. As a SemVer pre-release it sorts below its core and above every release below that, `1.3.0` < `1.3.1-gemeente-x.1` < `1.3.1`, so the holder\'s next release supersedes it, and the two never collide: the holder never uses a label, the patcher never issues a plain number (contract ADR 0003). Which namespaces a tenant holds is the installation\'s to know; the contract checks the shape. \"Highest\" always means by this order, a patch release included. A request that selects a release to render or check (generation, preview, validation) takes a version range, `versionRange`, in the npm SemVer range grammar: an exact version (`1.4.0`), a caret (`^1.4.0`), a tilde (`~1.4.0`), comparators (`>=1.0.0 <2.0.0`), a hyphen range (`1.0.0 - 2.0.0`), or a `||` union of these. The highest release that satisfies it renders, and responses name the exact release used. A range is at most 256 characters, so an exact release number (at most 128) always fits, and a comparator pair of patch release numbers usually does. A range matches a patch release as npm matches a pre-release: only when one of its comparators names a pre-release of the same `MAJOR.MINOR.PATCH`, such as the exact number (`1.3.1-gemeente-x.1`) or `>=1.3.1-gemeente-x.1 <1.4.0`; `^1.3.0` never selects one. ## Catalog dependencies A catalog that uses another catalog\'s resources declares that catalog once, with the exact release of it that it renders with (`version`), never a range. References into the other catalog name the catalog but no version, so a release renders with exactly the releases its declarations pin. In a draft, a declaration may name a draft of the other catalog instead (`releaseId`), to build on work that is not released yet. A released release pins only released releases: releasing such a draft is refused (`release-dependencies-unreleased`) unless the request releases those drafts along with it (`releaseDependencies`), in one transaction. ## Catalog identity A catalog\'s key alone is not unique: two publishers can each publish `letters`. The registry and the namespace complete its name, and the same namespace in two registries is two namespaces. Which registry is a server\'s default is configuration; in a path, `/catalogs/~/acme-corp/letters/…` and `/catalogs/exchange.epistola.app/acme-corp/letters/…` address the same catalog when `exchange.epistola.app` is the default, and `~` may be sent percent-encoded as `%7E`. In a body, a catalog is named by separate `registry`, `namespace` and `catalogKey` members, and a reference into another catalog by an alias: 1. **A request that names a catalog** (a generation or preview target, a dependency declaration) may omit `registry`, or send null, for the default registry. (An import\'s `registry` defaults to the one the archive names.) 2. **A reference from one catalog\'s release to a resource of another** names that catalog by the **alias** the release\'s dependency declarations give it (`CatalogAlias`, in the member `catalogKey`), never by registry or namespace: a template model\'s `themeRef`, its stencil and image nodes, a `fontFamily` (catalog content, portable catalog wire v8, contract ADR 0003), and the references this API reads and writes beside it, a release\'s default theme (`CatalogThemeReference`), an attribute\'s code-list binding and an attribute criterion in variant selection (`VariantSelectionAttribute`, resolved through the release that renders). Omitted or null, or the catalog\'s own key, is the catalog itself. A declaration (`CatalogDependencyDto`, `listCatalogDependencies`) maps each alias to the catalog\'s full name and the release it pins; that is where a client finds the name. Because content names the alias, it means the same in every installation and under any name, and pinning another release changes no content. An alias is by default the catalog\'s key (`CatalogDependencyRequirement.alias`). Responses write every registry in full, by its name, never `~`, so a value read from one installation means the same catalog on another. Content documents are returned as stored. ## Concurrency Updates can be made conditional. Templates, variants, themes, stencils, code lists, attributes, releases, environments, tenants and consumers carry a revision, which reading or updating one returns as a strong `ETag` header: a quoted decimal integer such as `\"7\"`. Send it back as `If-Match` on an update: if the resource changed since you read it, the update is refused with 412 `resource-modified` and nothing changes; read it again, reapply your change and retry. Without `If-Match` an update applies unconditionally, and the last write wins. What a revision covers: - a template: its own properties, data contract and data examples; - a variant: its title, description, attributes and template model, so `getVariant` and `getVariantContent` return the same `ETag`, and `updateVariant` and `updateVariantContent` take either; - a release: its name, default theme, presets and dependency declarations, so `getCatalogRelease` and `listCatalogDependencies` return the same `ETag`, and `updateCatalogRelease` and `updateCatalogDependencies` take either; - a code list: its properties and entries, whether each is hidden included, so `updateCodeListEntryHidden` takes the code list\'s `ETag`; - an environment: its name and production mark, not what it serves. ## Authentication Credentials go in the `Authorization` header: - **API key**, `Authorization: ApiKey <key>`: the supported method. A tenant manager issues each key for one tenant, with a set of tenant roles. The scheme name is case-insensitive. - **Bearer JWT** (**experimental**), `Authorization: Bearer <jwt>`: issued by an OAuth 2.0 identity provider, or self-signed with a key pair registered through the Consumers API. The [authentication guide](https://github.com/epistola-app/epistola-contract/blob/main/contracts/api/docs/auth.md) has the details. ## Authorization Each operation names the permissions it requires (`x-required-permissions`), such as `TEMPLATE_VIEW`, `TEMPLATE_EDIT`, `DOCUMENT_GENERATE` and `CATALOG_MANAGE`. A caller has them through its tenant roles (`CONTENT_VIEWER`, `CONTENT_AUTHOR`, `DOCUMENT_GENERATOR`, `CONTENT_PUBLISHER`, `TENANT_ADMINISTRATOR`), the roles stored on its API key. Managing tenants needs the platform role `TENANT_MANAGER`. ## Errors Errors are [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem details, with `Content-Type: application/problem+json`: - `type` (URI): what went wrong, the stable value to switch on. It is `https://epistola.app/errors/{slug}`, which documents the problem type; - `title`: a short summary; - `status`: the HTTP status code; - `detail` (optional): what happened this time; - `instance` (optional): this occurrence. A problem may add members of its own, such as the field-level `errors` of a `validation-error`; ignore members you do not recognize. The problem types are listed, machine-readably, in this document\'s `x-problem-types` extension, and in the [error type registry](https://github.com/epistola-app/epistola-contract/blob/main/contracts/api/docs/error-types.md). New types may be added in a minor version, so keep a fallback when switching on them. ## Experimental parts and server support Operations and members marked `x-experimental: true`, the consumer model (Bearer JWT and the Consumers API) among them, may still change. Epistola Suite, the server that implements this contract, may not implement them yet, nor every part of the rest: deploying a draft, installing missing dependency releases when deploying, and recording who requested a document among them.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0-alpha.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -16,13 +16,39 @@ import { type CreateAttributeRequest } from '../models/CreateAttributeRequest.js
|
|
|
16
16
|
import { type UpdateAttributeRequest } from '../models/UpdateAttributeRequest.js';
|
|
17
17
|
export interface CreateAttributeOperationRequest {
|
|
18
18
|
/**
|
|
19
|
-
* Unique
|
|
19
|
+
* Unique key of the tenant (e.g., "acme-corp")
|
|
20
20
|
*/
|
|
21
|
-
|
|
21
|
+
tenantKey: string;
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Registry of the catalog: the exchange (`exchange.epistola.app`) or the domain that publishes
|
|
24
|
+
* it (`acme.com`), in normal domain order, or `local` for a name that never leaves the
|
|
25
|
+
* organisation.
|
|
26
|
+
*
|
|
27
|
+
* `~` means the installation's **default registry**, which the server configures; it is not part
|
|
28
|
+
* of this contract. The default registry may also be named in full, and both address the same
|
|
29
|
+
* catalog. A client may send `~` as it is or percent-encoded as `%7E`; the server accepts both.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
registry: string;
|
|
33
|
+
/**
|
|
34
|
+
* Namespace of the catalog, within its registry. The same namespace in two registries is two
|
|
35
|
+
* different namespaces.
|
|
36
|
+
*
|
|
37
|
+
*/
|
|
38
|
+
namespace: string;
|
|
39
|
+
/**
|
|
40
|
+
* Key of the catalog, unique within its registry and namespace
|
|
24
41
|
*/
|
|
25
|
-
|
|
42
|
+
catalogKey: string;
|
|
43
|
+
/**
|
|
44
|
+
* A release of the catalog, by its `releaseId` (`CatalogReleaseId`) or, once it is released, by
|
|
45
|
+
* its exact version: both address the same release. A draft has no version until it is released,
|
|
46
|
+
* so it is addressed by its `releaseId` alone; releasing it keeps the id. Once it is released,
|
|
47
|
+
* every write to it is refused with 409, whichever way it is addressed. A `releaseId` never
|
|
48
|
+
* contains a dot, so the two cannot be confused. A discarded draft's id addresses nothing (404).
|
|
49
|
+
*
|
|
50
|
+
*/
|
|
51
|
+
release: string;
|
|
26
52
|
/**
|
|
27
53
|
*
|
|
28
54
|
*/
|
|
@@ -30,13 +56,39 @@ export interface CreateAttributeOperationRequest {
|
|
|
30
56
|
}
|
|
31
57
|
export interface DeleteAttributeRequest {
|
|
32
58
|
/**
|
|
33
|
-
* Unique
|
|
59
|
+
* Unique key of the tenant (e.g., "acme-corp")
|
|
34
60
|
*/
|
|
35
|
-
|
|
61
|
+
tenantKey: string;
|
|
36
62
|
/**
|
|
37
|
-
*
|
|
63
|
+
* Registry of the catalog: the exchange (`exchange.epistola.app`) or the domain that publishes
|
|
64
|
+
* it (`acme.com`), in normal domain order, or `local` for a name that never leaves the
|
|
65
|
+
* organisation.
|
|
66
|
+
*
|
|
67
|
+
* `~` means the installation's **default registry**, which the server configures; it is not part
|
|
68
|
+
* of this contract. The default registry may also be named in full, and both address the same
|
|
69
|
+
* catalog. A client may send `~` as it is or percent-encoded as `%7E`; the server accepts both.
|
|
70
|
+
*
|
|
38
71
|
*/
|
|
39
|
-
|
|
72
|
+
registry: string;
|
|
73
|
+
/**
|
|
74
|
+
* Namespace of the catalog, within its registry. The same namespace in two registries is two
|
|
75
|
+
* different namespaces.
|
|
76
|
+
*
|
|
77
|
+
*/
|
|
78
|
+
namespace: string;
|
|
79
|
+
/**
|
|
80
|
+
* Key of the catalog, unique within its registry and namespace
|
|
81
|
+
*/
|
|
82
|
+
catalogKey: string;
|
|
83
|
+
/**
|
|
84
|
+
* A release of the catalog, by its `releaseId` (`CatalogReleaseId`) or, once it is released, by
|
|
85
|
+
* its exact version: both address the same release. A draft has no version until it is released,
|
|
86
|
+
* so it is addressed by its `releaseId` alone; releasing it keeps the id. Once it is released,
|
|
87
|
+
* every write to it is refused with 409, whichever way it is addressed. A `releaseId` never
|
|
88
|
+
* contains a dot, so the two cannot be confused. A discarded draft's id addresses nothing (404).
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
release: string;
|
|
40
92
|
/**
|
|
41
93
|
* The attribute key (e.g., "language", "brand")
|
|
42
94
|
*/
|
|
@@ -44,13 +96,39 @@ export interface DeleteAttributeRequest {
|
|
|
44
96
|
}
|
|
45
97
|
export interface GetAttributeRequest {
|
|
46
98
|
/**
|
|
47
|
-
* Unique
|
|
99
|
+
* Unique key of the tenant (e.g., "acme-corp")
|
|
100
|
+
*/
|
|
101
|
+
tenantKey: string;
|
|
102
|
+
/**
|
|
103
|
+
* Registry of the catalog: the exchange (`exchange.epistola.app`) or the domain that publishes
|
|
104
|
+
* it (`acme.com`), in normal domain order, or `local` for a name that never leaves the
|
|
105
|
+
* organisation.
|
|
106
|
+
*
|
|
107
|
+
* `~` means the installation's **default registry**, which the server configures; it is not part
|
|
108
|
+
* of this contract. The default registry may also be named in full, and both address the same
|
|
109
|
+
* catalog. A client may send `~` as it is or percent-encoded as `%7E`; the server accepts both.
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
112
|
+
registry: string;
|
|
113
|
+
/**
|
|
114
|
+
* Namespace of the catalog, within its registry. The same namespace in two registries is two
|
|
115
|
+
* different namespaces.
|
|
116
|
+
*
|
|
48
117
|
*/
|
|
49
|
-
|
|
118
|
+
namespace: string;
|
|
50
119
|
/**
|
|
51
|
-
*
|
|
120
|
+
* Key of the catalog, unique within its registry and namespace
|
|
52
121
|
*/
|
|
53
|
-
|
|
122
|
+
catalogKey: string;
|
|
123
|
+
/**
|
|
124
|
+
* A release of the catalog, by its `releaseId` (`CatalogReleaseId`) or, once it is released, by
|
|
125
|
+
* its exact version: both address the same release. A draft has no version until it is released,
|
|
126
|
+
* so it is addressed by its `releaseId` alone; releasing it keeps the id. Once it is released,
|
|
127
|
+
* every write to it is refused with 409, whichever way it is addressed. A `releaseId` never
|
|
128
|
+
* contains a dot, so the two cannot be confused. A discarded draft's id addresses nothing (404).
|
|
129
|
+
*
|
|
130
|
+
*/
|
|
131
|
+
release: string;
|
|
54
132
|
/**
|
|
55
133
|
* The attribute key (e.g., "language", "brand")
|
|
56
134
|
*/
|
|
@@ -58,13 +136,39 @@ export interface GetAttributeRequest {
|
|
|
58
136
|
}
|
|
59
137
|
export interface ListAttributesRequest {
|
|
60
138
|
/**
|
|
61
|
-
* Unique
|
|
139
|
+
* Unique key of the tenant (e.g., "acme-corp")
|
|
140
|
+
*/
|
|
141
|
+
tenantKey: string;
|
|
142
|
+
/**
|
|
143
|
+
* Registry of the catalog: the exchange (`exchange.epistola.app`) or the domain that publishes
|
|
144
|
+
* it (`acme.com`), in normal domain order, or `local` for a name that never leaves the
|
|
145
|
+
* organisation.
|
|
146
|
+
*
|
|
147
|
+
* `~` means the installation's **default registry**, which the server configures; it is not part
|
|
148
|
+
* of this contract. The default registry may also be named in full, and both address the same
|
|
149
|
+
* catalog. A client may send `~` as it is or percent-encoded as `%7E`; the server accepts both.
|
|
150
|
+
*
|
|
62
151
|
*/
|
|
63
|
-
|
|
152
|
+
registry: string;
|
|
64
153
|
/**
|
|
65
|
-
*
|
|
154
|
+
* Namespace of the catalog, within its registry. The same namespace in two registries is two
|
|
155
|
+
* different namespaces.
|
|
156
|
+
*
|
|
157
|
+
*/
|
|
158
|
+
namespace: string;
|
|
159
|
+
/**
|
|
160
|
+
* Key of the catalog, unique within its registry and namespace
|
|
161
|
+
*/
|
|
162
|
+
catalogKey: string;
|
|
163
|
+
/**
|
|
164
|
+
* A release of the catalog, by its `releaseId` (`CatalogReleaseId`) or, once it is released, by
|
|
165
|
+
* its exact version: both address the same release. A draft has no version until it is released,
|
|
166
|
+
* so it is addressed by its `releaseId` alone; releasing it keeps the id. Once it is released,
|
|
167
|
+
* every write to it is refused with 409, whichever way it is addressed. A `releaseId` never
|
|
168
|
+
* contains a dot, so the two cannot be confused. A discarded draft's id addresses nothing (404).
|
|
169
|
+
*
|
|
66
170
|
*/
|
|
67
|
-
|
|
171
|
+
release: string;
|
|
68
172
|
/**
|
|
69
173
|
* Page number (0-based)
|
|
70
174
|
*/
|
|
@@ -89,13 +193,39 @@ export interface ListAttributesRequest {
|
|
|
89
193
|
}
|
|
90
194
|
export interface UpdateAttributeOperationRequest {
|
|
91
195
|
/**
|
|
92
|
-
* Unique
|
|
196
|
+
* Unique key of the tenant (e.g., "acme-corp")
|
|
93
197
|
*/
|
|
94
|
-
|
|
198
|
+
tenantKey: string;
|
|
95
199
|
/**
|
|
96
|
-
*
|
|
200
|
+
* Registry of the catalog: the exchange (`exchange.epistola.app`) or the domain that publishes
|
|
201
|
+
* it (`acme.com`), in normal domain order, or `local` for a name that never leaves the
|
|
202
|
+
* organisation.
|
|
203
|
+
*
|
|
204
|
+
* `~` means the installation's **default registry**, which the server configures; it is not part
|
|
205
|
+
* of this contract. The default registry may also be named in full, and both address the same
|
|
206
|
+
* catalog. A client may send `~` as it is or percent-encoded as `%7E`; the server accepts both.
|
|
207
|
+
*
|
|
208
|
+
*/
|
|
209
|
+
registry: string;
|
|
210
|
+
/**
|
|
211
|
+
* Namespace of the catalog, within its registry. The same namespace in two registries is two
|
|
212
|
+
* different namespaces.
|
|
213
|
+
*
|
|
214
|
+
*/
|
|
215
|
+
namespace: string;
|
|
216
|
+
/**
|
|
217
|
+
* Key of the catalog, unique within its registry and namespace
|
|
97
218
|
*/
|
|
98
|
-
|
|
219
|
+
catalogKey: string;
|
|
220
|
+
/**
|
|
221
|
+
* A release of the catalog, by its `releaseId` (`CatalogReleaseId`) or, once it is released, by
|
|
222
|
+
* its exact version: both address the same release. A draft has no version until it is released,
|
|
223
|
+
* so it is addressed by its `releaseId` alone; releasing it keeps the id. Once it is released,
|
|
224
|
+
* every write to it is refused with 409, whichever way it is addressed. A `releaseId` never
|
|
225
|
+
* contains a dot, so the two cannot be confused. A discarded draft's id addresses nothing (404).
|
|
226
|
+
*
|
|
227
|
+
*/
|
|
228
|
+
release: string;
|
|
99
229
|
/**
|
|
100
230
|
* The attribute key (e.g., "language", "brand")
|
|
101
231
|
*/
|
|
@@ -104,6 +234,14 @@ export interface UpdateAttributeOperationRequest {
|
|
|
104
234
|
*
|
|
105
235
|
*/
|
|
106
236
|
updateAttributeRequest: UpdateAttributeRequest;
|
|
237
|
+
/**
|
|
238
|
+
* The `ETag` of the resource as you last read it, as the server returned it (a quoted revision,
|
|
239
|
+
* e.g. `"7"`). When given and the resource has changed since, the update is refused with 412
|
|
240
|
+
* `resource-modified` and nothing changes. When left out, the update is applied regardless of
|
|
241
|
+
* concurrent changes: the last write wins.
|
|
242
|
+
*
|
|
243
|
+
*/
|
|
244
|
+
ifMatch?: string;
|
|
107
245
|
}
|
|
108
246
|
/**
|
|
109
247
|
*
|
|
@@ -114,12 +252,12 @@ export declare class AttributesApi extends runtime.BaseAPI {
|
|
|
114
252
|
*/
|
|
115
253
|
createAttributeRequestOpts(requestParameters: CreateAttributeOperationRequest): Promise<runtime.RequestOpts>;
|
|
116
254
|
/**
|
|
117
|
-
* Create
|
|
255
|
+
* Create an attribute definition in the draft.
|
|
118
256
|
* Create a new attribute definition
|
|
119
257
|
*/
|
|
120
258
|
createAttributeRaw(requestParameters: CreateAttributeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AttributeDto>>;
|
|
121
259
|
/**
|
|
122
|
-
* Create
|
|
260
|
+
* Create an attribute definition in the draft.
|
|
123
261
|
* Create a new attribute definition
|
|
124
262
|
*/
|
|
125
263
|
createAttribute(requestParameters: CreateAttributeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AttributeDto>;
|
|
@@ -156,13 +294,13 @@ export declare class AttributesApi extends runtime.BaseAPI {
|
|
|
156
294
|
*/
|
|
157
295
|
listAttributesRequestOpts(requestParameters: ListAttributesRequest): Promise<runtime.RequestOpts>;
|
|
158
296
|
/**
|
|
159
|
-
* Retrieve
|
|
160
|
-
* List attribute definitions
|
|
297
|
+
* Retrieve the attribute definitions of this release. Attribute definitions describe the keys that can be used for variant selection.
|
|
298
|
+
* List the attribute definitions in a release of a catalog
|
|
161
299
|
*/
|
|
162
300
|
listAttributesRaw(requestParameters: ListAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AttributeListResponse>>;
|
|
163
301
|
/**
|
|
164
|
-
* Retrieve
|
|
165
|
-
* List attribute definitions
|
|
302
|
+
* Retrieve the attribute definitions of this release. Attribute definitions describe the keys that can be used for variant selection.
|
|
303
|
+
* List the attribute definitions in a release of a catalog
|
|
166
304
|
*/
|
|
167
305
|
listAttributes(requestParameters: ListAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AttributeListResponse>;
|
|
168
306
|
/**
|
|
@@ -170,12 +308,12 @@ export declare class AttributesApi extends runtime.BaseAPI {
|
|
|
170
308
|
*/
|
|
171
309
|
updateAttributeRequestOpts(requestParameters: UpdateAttributeOperationRequest): Promise<runtime.RequestOpts>;
|
|
172
310
|
/**
|
|
173
|
-
* Update
|
|
311
|
+
* Update an attribute definition\'s `displayName`, `description` and constraint: its inline `allowedValues`, or the code list it binds (`codeListBinding`). Omitted or null members are left as they are; `clearCodeListBinding: true` removes the binding. The constraint may switch kind, as `UpdateAttributeRequest` describes; mixing both kinds, or a `codeListBinding` together with `clearCodeListBinding`, is refused with 400 `validation-error`, and an attribute of a catalog that cannot be changed with 409 `catalog-read-only`. Send the `ETag` from a read as `If-Match` to have the update refused with 412 `resource-modified` if the resource changed since; without it, the last write wins.
|
|
174
312
|
* Update an attribute definition
|
|
175
313
|
*/
|
|
176
314
|
updateAttributeRaw(requestParameters: UpdateAttributeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AttributeDto>>;
|
|
177
315
|
/**
|
|
178
|
-
* Update
|
|
316
|
+
* Update an attribute definition\'s `displayName`, `description` and constraint: its inline `allowedValues`, or the code list it binds (`codeListBinding`). Omitted or null members are left as they are; `clearCodeListBinding: true` removes the binding. The constraint may switch kind, as `UpdateAttributeRequest` describes; mixing both kinds, or a `codeListBinding` together with `clearCodeListBinding`, is refused with 400 `validation-error`, and an attribute of a catalog that cannot be changed with 409 `catalog-read-only`. Send the `ETag` from a read as `If-Match` to have the update refused with 412 `resource-modified` if the resource changed since; without it, the last write wins.
|
|
179
317
|
* Update an attribute definition
|
|
180
318
|
*/
|
|
181
319
|
updateAttribute(requestParameters: UpdateAttributeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AttributeDto>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AttributesApi.d.ts","sourceRoot":"","sources":["../../../../src/generated/api/apis/AttributesApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EACH,KAAK,YAAY,EAGpB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACH,KAAK,qBAAqB,EAG7B,MAAM,oCAAoC,CAAC;
|
|
1
|
+
{"version":3,"file":"AttributesApi.d.ts","sourceRoot":"","sources":["../../../../src/generated/api/apis/AttributesApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EACH,KAAK,YAAY,EAGpB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACH,KAAK,qBAAqB,EAG7B,MAAM,oCAAoC,CAAC;AAM5C,OAAO,EACH,KAAK,sBAAsB,EAG9B,MAAM,qCAAqC,CAAC;AAM7C,OAAO,EACH,KAAK,sBAAsB,EAG9B,MAAM,qCAAqC,CAAC;AAO7C,MAAM,WAAW,+BAA+B;IAC5C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,sBAAsB,EAAE,sBAAsB,CAAC;CAClD;AAED,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,2BAA2B,CAAC;CAC3C;AAED,MAAM,WAAW,+BAA+B;IAC5C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,OAAO,CAAC,OAAO;IAE9C;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,+BAA+B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CA4EjH;IAED;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAKnL;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAG3J;IAED;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CA0ExG;IAED;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAKlK;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1I;IAED;;OAEG;IACG,uBAAuB,CAAC,iBAAiB,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CA0ElG;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAKpK;IAED;;;OAGG;IACG,YAAY,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAG5I;IAED;;OAEG;IACG,yBAAyB,CAAC,iBAAiB,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAkFtG;IAED;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAKjL;IAED;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAGzJ;IAED;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,+BAA+B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAwFjH;IAED;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAKnL;IAED;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAG3J;CAEJ;AAED;;GAEG;AACH,eAAO,MAAM,2BAA2B;aACpC,GAAG,EAAE,KAAK;aACV,IAAI,EAAE,MAAM;CACN,CAAC;AACX,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAC,MAAM,OAAO,2BAA2B,CAAC,CAAC"}
|