@rathnasgala2/schemas 2.15.0 → 2.16.0

package/README.md

@@ -91,6 +91,27 @@ calls `postMembershipInvitationsByTokenAccept`; its non-enumerating failure
 states collapse onto that operation's single declared `INVALID_SOURCE_STATE`
 problem, which covers an expired, already-used or unknown token alike.
 
+SCHEMA-2.16.0 corrects a fault SCHEMA-2.14.0 introduced:
+`POST .../repository-changes/{changeId}:bring-up-to-date`'s
+`x-gala-state-guards` admitted only `REQUESTED|PLANNED|AWAITING_CONFIRMATION`,
+and its `409` wording said an already-committed change was refused -- which
+defeated the operation's purpose, since a person's saved change IS committed (it
+carries a `proposedRevision`, and it was reviewed and approved) and it is
+exactly that change a publish refuses `SOURCE_OUT_OF_DATE`. The guard now also
+admits `COMMITTED`:
+`RepositoryChange:REQUESTED|PLANNED|AWAITING_CONFIRMATION|COMMITTED -> PLANNED (new change)`.
+Not admitted, and now stated as such: a change with a commit in flight
+(`COMMIT_REQUESTED`/`COMMITTING`/`UNKNOWN_RECONCILING`), one that already failed
+or was cancelled (`FAILED_NO_CHANGE`/`CANCELLED`), or one already published. Two
+smaller additions travel in the same release: `GET .../repository/setup`
+declares `503 CAPABILITY_UNAVAILABLE`/`DEPENDENCY_UNAVAILABLE` exactly as
+`POST .../repository:set-up` already does, since both depend on the same
+configured GitHub App identity; and repository creation's operation description
+now states that with `startFrom: USER_TEMPLATE` an unreachable
+`rathnasgala2/user-template` GitHub template is the existing
+`503 DEPENDENCY_UNAVAILABLE` this operation has declared since 2.13.0 (no new
+status was needed).
+
 SCHEMA-2.15.0 closes a Content-list gap SCHEMA-2.14.0 left: with `kind` the only
 fact the inventory carried about a flat file, a row could not show title, kind,
 status or last-changed, and a client could not check web-address uniqueness,

package/THIRD_PARTY_LICENSES.json

@@ -1,6 +1,6 @@
 {
   "schemaVersion": 1,
-  "package": "@rathnasgala2/schemas@2.15.0",
+  "package": "@rathnasgala2/schemas@2.16.0",
   "source": "package-lock.json",
   "dependencies": [
     {

package/docs/catalogs/schema-inventory.json

@@ -209,9 +209,9 @@
       "version": "2.0.0",
       "path": "openapi/openapi.yaml",
       "materialized": true,
-      "sourceDigest": "sha256:ca5cf80a6fc7b91e4a029d9962efc0da84b31a267b0e1a7bbaaba731d426dffc",
+      "sourceDigest": "sha256:c4ee38c241c9207f7778e7d142ea7f1e2d5435162cbf3220cfba5441ab4637a1",
       "typescriptRootType": null
     }
   ],
-  "digest": "sha256:fe8e29466fbeaafd38b28e6d09f94a4f9e05045aaa4af954431d5b493a13ba14"
+  "digest": "sha256:027f532a4b422dca7de3ca594133ebd4c8b3f2dce43d3a670b6adf2b3c781671"
 }

package/openapi/http-catalog.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": "2.0.0",
   "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
-  "openApiDigest": "sha256:ca5cf80a6fc7b91e4a029d9962efc0da84b31a267b0e1a7bbaaba731d426dffc",
+  "openApiDigest": "sha256:c4ee38c241c9207f7778e7d142ea7f1e2d5435162cbf3220cfba5441ab4637a1",
   "operations": [
     {
       "operationId": "getInternalHealth",
@@ -1049,5 +1049,5 @@
       "sourceFragment": "workloads"
     }
   ],
-  "digest": "sha256:f4c2d4b69632958faefc39a1a229877a70a60b86a22b9e891bbecb1924878c68"
+  "digest": "sha256:c7191c307118e240ea21d6f2ea967748c5a32324b6637cb5076e5566bf04072a"
 }

package/openapi/openapi.yaml

@@ -13406,6 +13406,14 @@ paths:
       x-gala-success-category: query
       x-gala-tenant-scope: NONE
     post:
+      description: |
+        With `startFrom: USER_TEMPLATE` (the default), the created
+        repository generates from the `rathnasgala2/user-template` GitHub
+        template; if that template is unreachable, this is `503
+        DEPENDENCY_UNAVAILABLE`, retryable, exactly the same declared
+        failure an unreachable GitHub for the create itself already answers.
+        A repository name already taken on the resolved account is `409
+        INVALID_SOURCE_STATE` pointed at `/name`, as already declared.
       operationId: postGithubInstallationsByInstallationIdRepositories
       parameters:
         - $ref: "#/components/parameters/XCorrelationId"
@@ -13718,7 +13726,7 @@ paths:
                   value:
                     code: DEPENDENCY_UNAVAILABLE
                     correlationId: 018f0000-0000-7000-8000-000000000001
-                    detail: See the operation contract.
+                    detail: GitHub did not answer the create. With startFrom USER_TEMPLATE this also covers the rathnasgala2/user-template GitHub template itself being unreachable. Retryable. See the operation contract.
                     errors: []
                     retryable: true
                     schemaId: urn:gala:schema:problem:2.0.0
@@ -24858,7 +24866,15 @@ paths:
         (`changeId`'s `proposedRevision`), Theirs (the head named by
         `X-Gala-Current-Head`) -- merges in the browser, and submits a new
         `content-changes:plan` with `baseRevision` set to that head (journey
-        state P4). `changeId` itself is untouched either way.
+        state P4). `changeId` itself is untouched either way. `changeId` may
+        be `AWAITING_CONFIRMATION` or already `COMMITTED`: a saved,
+        reviewed and approved change is exactly the case a publish refuses
+        `SOURCE_OUT_OF_DATE`, and it is that change bring-up-to-date must
+        admit. Not admitted: a change with a commit in flight
+        (`COMMIT_REQUESTED`, `COMMITTING`, `UNKNOWN_RECONCILING`), one that
+        already failed or was cancelled (`FAILED_NO_CHANGE`, `CANCELLED`),
+        or one already published (its `publishId` names a publish that
+        produced a live deployment).
       operationId: postOrganizationsByOrganizationIdPublicationsByPublicationIdRepositoryChangesByChangeIdBringUpToDate
       parameters:
         - $ref: "#/components/parameters/XCorrelationId"
@@ -25065,7 +25081,7 @@ paths:
                   value:
                     code: INVALID_SOURCE_STATE
                     correlationId: 018f0000-0000-7000-8000-000000000001
-                    detail: "One or more paths conflict at file level between changeId and the current main head: nothing was written and no change was created. Read each named path through the document or asset read at baseRevision (Before), proposedRevision (Yours) and X-Gala-Current-Head (Theirs), merge in the browser, and submit a new content-changes:plan. This code is also used, with an empty errors[], when changeId is no longer in a state bring-up-to-date admits (already committed or cancelled). See the operation contract."
+                    detail: "One or more paths conflict at file level between changeId and the current main head: nothing was written and no change was created. Read each named path through the document or asset read at baseRevision (Before), proposedRevision (Yours) and X-Gala-Current-Head (Theirs), merge in the browser, and submit a new content-changes:plan. This code is also used, with an empty errors[], when the change is in flight, failed, cancelled or already published. See the operation contract."
                     errors:
                       - code: CONTENT_CONFLICT
                         pointer: /documents/content~1articles~1example.md
@@ -25187,7 +25203,7 @@ paths:
         - VALIDATION_FAILED
       x-gala-replay-identity: idempotency-key
       x-gala-state-guards:
-        - RepositoryChange:REQUESTED|PLANNED|AWAITING_CONFIRMATION -> PLANNED (new change)
+        - RepositoryChange:REQUESTED|PLANNED|AWAITING_CONFIRMATION|COMMITTED -> PLANNED (new change)
       x-gala-success-category: create
       x-gala-tenant-scope: ORGANIZATION_AND_PUBLICATION_PATH
   /v2/organizations/{organizationId}/publications/{publicationId}/repository-changes/{changeId}:confirm:
@@ -25797,9 +25813,11 @@ paths:
       description: |
         Whether the linked repository already carries the user template files
         `POST .../repository:set-up` adds. `missing` names the user template
-        files
-        not yet present; `conflicts` names ones present with different content,
-        populated only while `state` is `CONFLICT`.
+        files not yet present; `conflicts` names ones present with different
+        content, populated only while `state` is `CONFLICT`. Computing this
+        reads the linked repository through the same configured GitHub App
+        identity `POST .../repository:set-up` depends on, so the two
+        operations answer the same `503` the same way.
       operationId: getOrganizationsByOrganizationIdPublicationsByPublicationIdRepositorySetup
       parameters:
         - $ref: "#/components/parameters/XCorrelationId"
@@ -25946,6 +25964,47 @@ paths:
               $ref: "#/components/headers/XCorrelationId"
           x-gala-problem-codes:
             - RESOURCE_NOT_FOUND
+        "503":
+          content:
+            application/problem+json:
+              examples:
+                CAPABILITY_UNAVAILABLE:
+                  summary: CAPABILITY_UNAVAILABLE
+                  value:
+                    code: CAPABILITY_UNAVAILABLE
+                    correlationId: 018f0000-0000-7000-8000-000000000001
+                    detail: See the operation contract.
+                    errors: []
+                    retryable: false
+                    schemaId: urn:gala:schema:problem:2.0.0
+                    schemaVersion: 2.0.0
+                    status: 503
+                    title: CAPABILITY_UNAVAILABLE
+                    type: urn:gala:problem:capability-unavailable
+                DEPENDENCY_UNAVAILABLE:
+                  summary: DEPENDENCY_UNAVAILABLE
+                  value:
+                    code: DEPENDENCY_UNAVAILABLE
+                    correlationId: 018f0000-0000-7000-8000-000000000001
+                    detail: See the operation contract.
+                    errors: []
+                    retryable: true
+                    schemaId: urn:gala:schema:problem:2.0.0
+                    schemaVersion: 2.0.0
+                    status: 503
+                    title: DEPENDENCY_UNAVAILABLE
+                    type: urn:gala:problem:dependency-unavailable
+              schema:
+                $ref: "#/components/schemas/Problem"
+          description: CAPABILITY_UNAVAILABLE, DEPENDENCY_UNAVAILABLE
+          headers:
+            Cache-Control:
+              $ref: "#/components/headers/CacheControlNoStore"
+            X-Correlation-Id:
+              $ref: "#/components/headers/XCorrelationId"
+          x-gala-problem-codes:
+            - CAPABILITY_UNAVAILABLE
+            - DEPENDENCY_UNAVAILABLE
       security:
         - browserSession: []
       summary: read this publication's repository set-up state
@@ -25953,7 +26012,7 @@ paths:
         - organizations
       x-gala-activation-gate: MVP
       x-gala-activation-guards:
-        - NONE
+        - Active repository binding and configured GitHub App identity capability
       x-gala-capability-key: publication.view
       x-gala-concurrency: binding-epoch
       x-gala-conditional-capabilities: []
@@ -25963,6 +26022,8 @@ paths:
       x-gala-reachable-problems:
         - AUTHENTICATION_REQUIRED
         - AUTHORIZATION_DENIED
+        - CAPABILITY_UNAVAILABLE
+        - DEPENDENCY_UNAVAILABLE
         - RESOURCE_NOT_FOUND
         - VALIDATION_FAILED
       x-gala-replay-identity: safe-query

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rathnasgala2/schemas",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "description": "Executable JSON Schema and OpenAPI contracts for Galascribe",
   "type": "module",
   "license": "Apache-2.0",

package/sbom.cdx.json

@@ -97,8 +97,8 @@
       "type": "library",
       "name": "schemas",
       "group": "@rathnasgala2",
-      "version": "2.15.0",
-      "bom-ref": "@rathnasgala2/schemas@2.15.0",
+      "version": "2.16.0",
+      "bom-ref": "@rathnasgala2/schemas@2.16.0",
       "description": "Executable JSON Schema and OpenAPI contracts for Galascribe",
       "licenses": [
         {
@@ -108,7 +108,7 @@
           }
         }
       ],
-      "purl": "pkg:npm/%40rathnasgala2/schemas@2.15.0?vcs_url=git%2Bhttps%3A%2F%2Fgithub.com%2Frathnasgala2%2Fschema.git",
+      "purl": "pkg:npm/%40rathnasgala2/schemas@2.16.0?vcs_url=git%2Bhttps%3A%2F%2Fgithub.com%2Frathnasgala2%2Fschema.git",
       "externalReferences": [
         {
           "url": "https://github.com/rathnasgala2/schema/issues",
@@ -153,7 +153,7 @@
       "type": "library",
       "name": "ajv-formats",
       "version": "3.0.1",
-      "bom-ref": "@rathnasgala2/schemas@2.15.0|ajv-formats@3.0.1",
+      "bom-ref": "@rathnasgala2/schemas@2.16.0|ajv-formats@3.0.1",
       "licenses": [
         {
           "license": {
@@ -187,7 +187,7 @@
       "type": "library",
       "name": "ajv",
       "version": "8.20.0",
-      "bom-ref": "@rathnasgala2/schemas@2.15.0|ajv@8.20.0",
+      "bom-ref": "@rathnasgala2/schemas@2.16.0|ajv@8.20.0",
       "licenses": [
         {
           "license": {
@@ -221,7 +221,7 @@
       "type": "library",
       "name": "fast-deep-equal",
       "version": "3.1.3",
-      "bom-ref": "@rathnasgala2/schemas@2.15.0|fast-deep-equal@3.1.3",
+      "bom-ref": "@rathnasgala2/schemas@2.16.0|fast-deep-equal@3.1.3",
       "licenses": [
         {
           "license": {
@@ -255,7 +255,7 @@
       "type": "library",
       "name": "fast-uri",
       "version": "3.1.7",
-      "bom-ref": "@rathnasgala2/schemas@2.15.0|fast-uri@3.1.7",
+      "bom-ref": "@rathnasgala2/schemas@2.16.0|fast-uri@3.1.7",
       "licenses": [
         {
           "license": {
@@ -289,7 +289,7 @@
       "type": "library",
       "name": "json-schema-traverse",
       "version": "1.0.0",
-      "bom-ref": "@rathnasgala2/schemas@2.15.0|json-schema-traverse@1.0.0",
+      "bom-ref": "@rathnasgala2/schemas@2.16.0|json-schema-traverse@1.0.0",
       "licenses": [
         {
           "license": {
@@ -323,7 +323,7 @@
       "type": "library",
       "name": "require-from-string",
       "version": "2.0.2",
-      "bom-ref": "@rathnasgala2/schemas@2.15.0|require-from-string@2.0.2",
+      "bom-ref": "@rathnasgala2/schemas@2.16.0|require-from-string@2.0.2",
       "licenses": [
         {
           "license": {
@@ -1064,10 +1064,10 @@
   ],
   "dependencies": [
     {
-      "ref": "@rathnasgala2/schemas@2.15.0",
+      "ref": "@rathnasgala2/schemas@2.16.0",
       "dependsOn": [
-        "@rathnasgala2/schemas@2.15.0|ajv-formats@3.0.1",
-        "@rathnasgala2/schemas@2.15.0|ajv@8.20.0",
+        "@rathnasgala2/schemas@2.16.0|ajv-formats@3.0.1",
+        "@rathnasgala2/schemas@2.16.0|ajv@8.20.0",
         "pkg:npm/semver@7.8.5",
         "urn:gala:source-data:iana-ipv4-special-registry",
         "urn:gala:source-data:iana-ipv6-special-registry",
@@ -1089,31 +1089,31 @@
       ]
     },
     {
-      "ref": "@rathnasgala2/schemas@2.15.0|ajv-formats@3.0.1",
+      "ref": "@rathnasgala2/schemas@2.16.0|ajv-formats@3.0.1",
       "dependsOn": [
-        "@rathnasgala2/schemas@2.15.0|ajv@8.20.0"
+        "@rathnasgala2/schemas@2.16.0|ajv@8.20.0"
       ]
     },
     {
-      "ref": "@rathnasgala2/schemas@2.15.0|ajv@8.20.0",
+      "ref": "@rathnasgala2/schemas@2.16.0|ajv@8.20.0",
       "dependsOn": [
-        "@rathnasgala2/schemas@2.15.0|fast-deep-equal@3.1.3",
-        "@rathnasgala2/schemas@2.15.0|fast-uri@3.1.7",
-        "@rathnasgala2/schemas@2.15.0|json-schema-traverse@1.0.0",
-        "@rathnasgala2/schemas@2.15.0|require-from-string@2.0.2"
+        "@rathnasgala2/schemas@2.16.0|fast-deep-equal@3.1.3",
+        "@rathnasgala2/schemas@2.16.0|fast-uri@3.1.7",
+        "@rathnasgala2/schemas@2.16.0|json-schema-traverse@1.0.0",
+        "@rathnasgala2/schemas@2.16.0|require-from-string@2.0.2"
       ]
     },
     {
-      "ref": "@rathnasgala2/schemas@2.15.0|fast-deep-equal@3.1.3"
+      "ref": "@rathnasgala2/schemas@2.16.0|fast-deep-equal@3.1.3"
     },
     {
-      "ref": "@rathnasgala2/schemas@2.15.0|fast-uri@3.1.7"
+      "ref": "@rathnasgala2/schemas@2.16.0|fast-uri@3.1.7"
     },
     {
-      "ref": "@rathnasgala2/schemas@2.15.0|json-schema-traverse@1.0.0"
+      "ref": "@rathnasgala2/schemas@2.16.0|json-schema-traverse@1.0.0"
     },
     {
-      "ref": "@rathnasgala2/schemas@2.15.0|require-from-string@2.0.2"
+      "ref": "@rathnasgala2/schemas@2.16.0|require-from-string@2.0.2"
     },
     {
       "ref": "pkg:npm/semver@7.8.5"