@rathnasgala2/schemas 2.18.0 → 2.20.0

package/THIRD_PARTY_LICENSES.json

@@ -1,6 +1,6 @@
 {
   "schemaVersion": 1,
-  "package": "@rathnasgala2/schemas@2.17.0",
+  "package": "@rathnasgala2/schemas@2.20.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:f7384651f46757a1a8274b0ff26186e28f77ce114672c35f331518bc1e742d14",
+      "sourceDigest": "sha256:d7c302879abe45afa69b5c7fd889aec759c8182ec887f354a8c864094b8c50d0",
       "typescriptRootType": null
     }
   ],
-  "digest": "sha256:513bac6a6dfe82cfa3dae53b002ee237d551637ef5d5a561e5297d5153a5baa4"
+  "digest": "sha256:868ae1b9d4c5773da3e629b712104822985a2636eed634e37067c68286cdca2e"
 }

package/openapi/http-catalog.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": "2.0.0",
   "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
-  "openApiDigest": "sha256:f7384651f46757a1a8274b0ff26186e28f77ce114672c35f331518bc1e742d14",
+  "openApiDigest": "sha256:d7c302879abe45afa69b5c7fd889aec759c8182ec887f354a8c864094b8c50d0",
   "operations": [
     {
       "operationId": "getInternalHealth",
@@ -1049,5 +1049,5 @@
       "sourceFragment": "workloads"
     }
   ],
-  "digest": "sha256:5d5ea7eb78e21a892b0945d5cc18bccc798e79c8d1e43633d579f8bec7fde2cc"
+  "digest": "sha256:3ee96a2ed4fb6ac08153fc4d845956216910d2f2c641a4e2b32f8a97cead22d8"
 }

package/openapi/openapi.yaml

@@ -2058,6 +2058,55 @@ components:
         - PUBLIC_OR_PRIVATE
         - UNKNOWN
       type: string
+    GithubPullRequestSummary:
+      additionalProperties: false
+      description: |
+        GitHub's last authoritative observation of the pull request exposing
+        this exact candidate revision for review. The URL is always the
+        canonical web `github.com/{owner}/{repository}/pull/{number}` URL;
+        absence of this object means no pull request has been recorded yet.
+      properties:
+        baseRef:
+          description: The pull request's base branch name as reported by GitHub.
+          maxLength: 255
+          minLength: 1
+          type: string
+        headRef:
+          description: The pull request's head branch name as reported by GitHub.
+          maxLength: 255
+          minLength: 1
+          type: string
+        headRevision:
+          description: The exact commit observed at the pull request head.
+          pattern: ^(?:sha1:[0-9a-f]{40}|sha256:[0-9a-f]{64})$
+          type: string
+        number:
+          format: int64
+          minimum: 1
+          type: integer
+        observedAt:
+          $ref: "#/components/schemas/PortableProblemRfc3339"
+        state:
+          description: GitHub's normalized pull-request lifecycle state.
+          enum:
+            - OPEN
+            - CLOSED
+            - MERGED
+          type: string
+        url:
+          description: The canonical GitHub pull-request URL.
+          format: uri
+          pattern: ^https://github[.]com/[A-Za-z0-9][A-Za-z0-9-]{0,38}/[A-Za-z0-9_.-]{1,100}/pull/[1-9][0-9]*$
+          type: string
+      required:
+        - number
+        - url
+        - headRef
+        - baseRef
+        - headRevision
+        - state
+        - observedAt
+      type: object
     GithubRepositoryStartFrom:
       description: |
         What a created repository starts from. `USER_TEMPLATE` (the default)
@@ -10132,16 +10181,26 @@ components:
       type: object
     PostOrganizationsByOrganizationIdPublicationsByPublicationIdRepositoryChangesByChangeIdConfirmRequest:
       additionalProperties: false
+      description: |
+        Optional compatibility assertions for the persisted plan. When a
+        member is omitted, the server uses the corresponding fact already
+        stored on `changeId`; when supplied, it must exactly match that fact.
+        An empty object therefore confirms the server-persisted plan without
+        requiring a client to echo opaque digests it just received.
       properties:
         diffDigest:
+          description: |
+            Optional assertion of the persisted planned-diff digest. Omit to
+            use the digest stored on `changeId`.
           pattern: ^sha256:[0-9a-f]{64}$
           type: string
         expectedHead:
+          description: |
+            Optional assertion of the persisted expected Git head. Omit to
+            use the head stored on `changeId`.
           pattern: ^(?:sha1:[0-9a-f]{40}|sha256:[0-9a-f]{64})$
           type: string
-      required:
-        - expectedHead
-        - diffDigest
+      required: []
       type: object
     PostOrganizationsByOrganizationIdPublicationsByPublicationIdRepositoryChangesByChangeIdConfirmResponse:
       allOf:
@@ -11873,6 +11932,8 @@ components:
           format: uuid
           pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
           type: string
+        pullRequest:
+          $ref: "#/components/schemas/GithubPullRequestSummary"
         reviewId:
           format: uuid
           pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
@@ -13361,6 +13422,7 @@ paths:
                   value:
                     hasMore: false
                     items: []
+                    pagesVisibilityPolicy: UNKNOWN
               schema:
                 $ref: "#/components/schemas/GetGithubInstallationsByInstallationIdRepositoriesResponse"
           description: repositories this installation grants to the signed-in user succeeded
@@ -25429,6 +25491,11 @@ paths:
       x-gala-tenant-scope: ORGANIZATION_AND_PUBLICATION_PATH
   /v2/organizations/{organizationId}/publications/{publicationId}/repository-changes/{changeId}:confirm:
     post:
+      description: |
+        Confirm the persisted plan and enqueue creation of its candidate ref,
+        commit and GitHub pull request. `expectedHead` and `diffDigest` are
+        optional compatibility assertions: an omitted member is read from the
+        persisted plan, while a supplied member must match it exactly.
       operationId: postOrganizationsByOrganizationIdPublicationsByPublicationIdRepositoryChangesByChangeIdConfirm
       parameters:
         - $ref: "#/components/parameters/XCorrelationId"
@@ -25462,11 +25529,14 @@ paths:
         content:
           application/json:
             examples:
-              nominal:
-                summary: Nominal valid request
+              asserted:
+                summary: Confirm while asserting the echoed plan facts
                 value:
                   diffDigest: sha256:0000000000000000000000000000000000000000000000000000000000000000
                   expectedHead: sha1:0000000000000000000000000000000000000000
+              nominal:
+                summary: Confirm using the server-persisted plan facts
+                value: {}
             schema:
               $ref: "#/components/schemas/PostOrganizationsByOrganizationIdPublicationsByPublicationIdRepositoryChangesByChangeIdConfirmRequest"
         required: true
@@ -25485,7 +25555,7 @@ paths:
                     statusUrl: /v2/organizations/018f0000-0000-7000-8000-000000000001/operations/018f0000-0000-7000-8000-000000000002
               schema:
                 $ref: "#/components/schemas/PostOrganizationsByOrganizationIdPublicationsByPublicationIdRepositoryChangesByChangeIdConfirmResponse"
-          description: create candidate ref and commit after exact confirmation succeeded
+          description: candidate ref, commit and GitHub pull-request creation was accepted
           headers:
             Cache-Control:
               $ref: "#/components/headers/CacheControlNoStore"
@@ -25729,7 +25799,7 @@ paths:
         - organizations
       x-gala-activation-gate: MVP
       x-gala-activation-guards:
-        - Unchanged expected Git head, normalized reviewed diff, schema version, and actor confirmation
+        - Unchanged persisted expected Git head, normalized reviewed diff, schema version, and actor confirmation
       x-gala-capability-key: publication.source.write
       x-gala-concurrency: planned-change-digest-and-expected-git-head
       x-gala-conditional-capabilities: []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rathnasgala2/schemas",
-  "version": "2.18.0",
+  "version": "2.20.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.17.0",
-      "bom-ref": "@rathnasgala2/schemas@2.17.0",
+      "version": "2.20.0",
+      "bom-ref": "@rathnasgala2/schemas@2.20.0",
       "description": "Executable JSON Schema and OpenAPI contracts for Galascribe",
       "licenses": [
         {
@@ -108,7 +108,7 @@
           }
         }
       ],
-      "purl": "pkg:npm/%40rathnasgala2/schemas@2.17.0?vcs_url=git%2Bhttps%3A%2F%2Fgithub.com%2Frathnasgala2%2Fschema.git",
+      "purl": "pkg:npm/%40rathnasgala2/schemas@2.20.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.17.0|ajv-formats@3.0.1",
+      "bom-ref": "@rathnasgala2/schemas@2.20.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.17.0|ajv@8.20.0",
+      "bom-ref": "@rathnasgala2/schemas@2.20.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.17.0|fast-deep-equal@3.1.3",
+      "bom-ref": "@rathnasgala2/schemas@2.20.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.17.0|fast-uri@3.1.7",
+      "bom-ref": "@rathnasgala2/schemas@2.20.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.17.0|json-schema-traverse@1.0.0",
+      "bom-ref": "@rathnasgala2/schemas@2.20.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.17.0|require-from-string@2.0.2",
+      "bom-ref": "@rathnasgala2/schemas@2.20.0|require-from-string@2.0.2",
       "licenses": [
         {
           "license": {
@@ -1064,10 +1064,10 @@
   ],
   "dependencies": [
     {
-      "ref": "@rathnasgala2/schemas@2.17.0",
+      "ref": "@rathnasgala2/schemas@2.20.0",
       "dependsOn": [
-        "@rathnasgala2/schemas@2.17.0|ajv-formats@3.0.1",
-        "@rathnasgala2/schemas@2.17.0|ajv@8.20.0",
+        "@rathnasgala2/schemas@2.20.0|ajv-formats@3.0.1",
+        "@rathnasgala2/schemas@2.20.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.17.0|ajv-formats@3.0.1",
+      "ref": "@rathnasgala2/schemas@2.20.0|ajv-formats@3.0.1",
       "dependsOn": [
-        "@rathnasgala2/schemas@2.17.0|ajv@8.20.0"
+        "@rathnasgala2/schemas@2.20.0|ajv@8.20.0"
       ]
     },
     {
-      "ref": "@rathnasgala2/schemas@2.17.0|ajv@8.20.0",
+      "ref": "@rathnasgala2/schemas@2.20.0|ajv@8.20.0",
       "dependsOn": [
-        "@rathnasgala2/schemas@2.17.0|fast-deep-equal@3.1.3",
-        "@rathnasgala2/schemas@2.17.0|fast-uri@3.1.7",
-        "@rathnasgala2/schemas@2.17.0|json-schema-traverse@1.0.0",
-        "@rathnasgala2/schemas@2.17.0|require-from-string@2.0.2"
+        "@rathnasgala2/schemas@2.20.0|fast-deep-equal@3.1.3",
+        "@rathnasgala2/schemas@2.20.0|fast-uri@3.1.7",
+        "@rathnasgala2/schemas@2.20.0|json-schema-traverse@1.0.0",
+        "@rathnasgala2/schemas@2.20.0|require-from-string@2.0.2"
       ]
     },
     {
-      "ref": "@rathnasgala2/schemas@2.17.0|fast-deep-equal@3.1.3"
+      "ref": "@rathnasgala2/schemas@2.20.0|fast-deep-equal@3.1.3"
     },
     {
-      "ref": "@rathnasgala2/schemas@2.17.0|fast-uri@3.1.7"
+      "ref": "@rathnasgala2/schemas@2.20.0|fast-uri@3.1.7"
     },
     {
-      "ref": "@rathnasgala2/schemas@2.17.0|json-schema-traverse@1.0.0"
+      "ref": "@rathnasgala2/schemas@2.20.0|json-schema-traverse@1.0.0"
     },
     {
-      "ref": "@rathnasgala2/schemas@2.17.0|require-from-string@2.0.2"
+      "ref": "@rathnasgala2/schemas@2.20.0|require-from-string@2.0.2"
     },
     {
       "ref": "pkg:npm/semver@7.8.5"