@rathnasgala2/schemas 3.8.0 → 3.9.0

package/generated/typescript/contracts/problem.d.ts

@@ -11,7 +11,16 @@ export type ProblemExtensionKey = string;
 
 export type ProblemFieldError = Readonly<{
   readonly code: ProblemProblemCode;
+  readonly paths?: ReadonlyArray<string>;
   readonly pointer: string;
+  readonly reason?:
+    | 'AUTHOR_EDITED'
+    | 'BRANCH_PROTECTION'
+    | 'REPOSITORY_ARCHIVED'
+    | 'INSTALLATION_SUSPENDED'
+    | 'WORKFLOWS_PERMISSION_MISSING'
+    | 'AUTHORIZATION_LOST'
+    | 'FORBIDDEN';
 }>;
 
 export type ProblemGitObjectId = string;

package/openapi/http-catalog.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": "2.0.0",
   "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
-  "openApiDigest": "sha256:e6fd6235d1b1a32d1f17ff8f6badc5db21f91e4b1aa3622b5fd8376faace3654",
+  "openApiDigest": "sha256:9612379eda4997a04a0e3d0bcb4c3e7d68c5ba76688d4c733ab2b91520a914f7",
   "operations": [
     {
       "operationId": "getInternalHealth",
@@ -2121,5 +2121,5 @@
       "sourceFragment": "workloads"
     }
   ],
-  "digest": "sha256:d1e44a2e15a91541e28f86087dbe9a2369669cac422c4ce7570dd0b2e60c0c67"
+  "digest": "sha256:e203c10513b422926292b5ed11f582de9ad4522fcdb824eed3fc332f639a819f"
 }

package/openapi/openapi.yaml

@@ -12796,10 +12796,30 @@ components:
       properties:
         code:
           $ref: "#/components/schemas/PortableProblemProblemCode"
+        paths:
+          description: "SCHEMA-3.9.0, optional: the managed repository file paths the error is about, as the App lists them. Absent from older servers."
+          items:
+            maxLength: 512
+            minLength: 1
+            type: string
+          maxItems: 50
+          minItems: 0
+          type: array
         pointer:
           maxLength: 1024
           minLength: 1
           type: string
+        reason:
+          description: "SCHEMA-3.9.0, optional: why a REPOSITORY_NEEDS_UPDATE error needs the author. AUTHOR_EDITED: a managed file was changed in a way only the author may resolve. BRANCH_PROTECTION: GitHub refused Galascribe's own commit. REPOSITORY_ARCHIVED: the repository is archived. INSTALLATION_SUSPENDED: the GitHub App installation is suspended. WORKFLOWS_PERMISSION_MISSING: the installation has not accepted the workflows permission. AUTHORIZATION_LOST: Galascribe lost its GitHub authorization. FORBIDDEN: GitHub refused for another permission reason. Absent from older servers and for other codes; a client shows a generic sentence for a value it does not know."
+          enum:
+            - AUTHOR_EDITED
+            - BRANCH_PROTECTION
+            - REPOSITORY_ARCHIVED
+            - INSTALLATION_SUSPENDED
+            - WORKFLOWS_PERMISSION_MISSING
+            - AUTHORIZATION_LOST
+            - FORBIDDEN
+          type: string
       required:
         - pointer
         - code
@@ -17403,7 +17423,7 @@ components:
       type: object
     SiteAttentionItem:
       additionalProperties: false
-      description: "Something that needs a person to act. The list is empty when nothing does. SCHEMA-3.3.0: `SCHEDULED_PUBLISH_FAILED` means a scheduled publish could not start at its time; `relatedPublishId` names the schedule and `reasonCode` the first precondition that failed (a client maps the values it knows to a sentence and shows a generic one otherwise); nothing was merged. `DOMAIN_PUBLISH_REQUIRED` means a custom domain is live and the next publish moves the site's address to it. `DOMAIN_DEGRADED` means a live custom domain stopped working; `reasonCode` names why and the domain read carries the next step."
+      description: "Something that needs a person to act. The list is empty when nothing does. SCHEMA-3.3.0: `SCHEDULED_PUBLISH_FAILED` means a scheduled publish could not start at its time; `relatedPublishId` names the schedule and `reasonCode` the first precondition that failed (a client maps the values it knows to a sentence and shows a generic one otherwise); nothing was merged. `DOMAIN_PUBLISH_REQUIRED` means a custom domain is live and the next publish moves the site's address to it. `DOMAIN_DEGRADED` means a live custom domain stopped working; `reasonCode` names why and the domain read carries the next step. SCHEMA-3.9.0: on `REPOSITORY_NEEDS_UPDATE`, `reason` names the cause and `paths` the managed repository files involved, so a client can say what to do and list the files (both are absent from older servers and for other codes; show a generic sentence for a `reason` you do not know). `AUTHOR_EDITED`: a managed file differs from the version Galascribe manages and only the author may resolve it. `BRANCH_PROTECTION`: GitHub refused Galascribe's own repair commit. `REPOSITORY_ARCHIVED`: the repository is archived. `INSTALLATION_SUSPENDED`: the GitHub App installation is suspended. `WORKFLOWS_PERMISSION_MISSING`: the installation has not accepted the workflows permission. `AUTHORIZATION_LOST`: Galascribe lost its GitHub authorization. `FORBIDDEN`: GitHub refused for another permission reason. The same `reason` and `paths` ride on the `REPOSITORY_NEEDS_UPDATE` entry of a publish refusal's `errors`."
       properties:
         code:
           enum:
@@ -17422,6 +17442,26 @@ components:
             - DOMAIN_PUBLISH_REQUIRED
             - DOMAIN_DEGRADED
           type: string
+        paths:
+          description: SCHEMA-3.9.0. The managed repository files a `REPOSITORY_NEEDS_UPDATE` is about; may be empty when the cause is not about a file.
+          items:
+            maxLength: 512
+            minLength: 1
+            type: string
+          maxItems: 50
+          minItems: 0
+          type: array
+        reason:
+          description: SCHEMA-3.9.0. Why a `REPOSITORY_NEEDS_UPDATE` needs the author.
+          enum:
+            - AUTHOR_EDITED
+            - BRANCH_PROTECTION
+            - REPOSITORY_ARCHIVED
+            - INSTALLATION_SUSPENDED
+            - WORKFLOWS_PERMISSION_MISSING
+            - AUTHORIZATION_LOST
+            - FORBIDDEN
+          type: string
         reasonCode:
           maxLength: 80
           minLength: 1

package/package.json

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

package/schemas/problem.schema.json

@@ -186,7 +186,27 @@
       "required": ["pointer", "code"],
       "properties": {
         "pointer": { "type": "string", "minLength": 1, "maxLength": 1024 },
-        "code": { "$ref": "#/$defs/problemCode" }
+        "code": { "$ref": "#/$defs/problemCode" },
+        "reason": {
+          "type": "string",
+          "enum": [
+            "AUTHOR_EDITED",
+            "BRANCH_PROTECTION",
+            "REPOSITORY_ARCHIVED",
+            "INSTALLATION_SUSPENDED",
+            "WORKFLOWS_PERMISSION_MISSING",
+            "AUTHORIZATION_LOST",
+            "FORBIDDEN"
+          ],
+          "description": "SCHEMA-3.9.0, optional: why a REPOSITORY_NEEDS_UPDATE error needs the author. AUTHOR_EDITED: a managed file was changed in a way only the author may resolve. BRANCH_PROTECTION: GitHub refused Galascribe's own commit. REPOSITORY_ARCHIVED: the repository is archived. INSTALLATION_SUSPENDED: the GitHub App installation is suspended. WORKFLOWS_PERMISSION_MISSING: the installation has not accepted the workflows permission. AUTHORIZATION_LOST: Galascribe lost its GitHub authorization. FORBIDDEN: GitHub refused for another permission reason. Absent from older servers and for other codes; a client shows a generic sentence for a value it does not know."
+        },
+        "paths": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1, "maxLength": 512 },
+          "minItems": 0,
+          "maxItems": 50,
+          "description": "SCHEMA-3.9.0, optional: the managed repository file paths the error is about, as the App lists them. Absent from older servers."
+        }
       },
       "additionalProperties": false
     }