@rathnasgala2/schemas 3.17.0 → 3.18.0

package/THIRD_PARTY_LICENSES.json

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

package/docs/catalogs/schema-inventory.json

@@ -229,9 +229,9 @@
       "version": "2.0.0",
       "path": "openapi/openapi.yaml",
       "materialized": true,
-      "sourceDigest": "sha256:724c2017e5453ced56aa0d283b317babf8f41431b8b32caa5e8c7173a6484bad",
+      "sourceDigest": "sha256:873e58c1c5cff984dbee260f215f8c6f3fd10c8623889ba4618b832814b043a9",
       "typescriptRootType": null
     }
   ],
-  "digest": "sha256:549dd989c3e26227b981a8d431c1b358b4908d667379a74d8c0dcc8063b6ec2a"
+  "digest": "sha256:19ca85ce1d415203baa408ab0d2f560b2f2d185b8c2da61dc0f6a8c3c2551d58"
 }

package/openapi/http-catalog.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": "2.0.0",
   "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
-  "openApiDigest": "sha256:724c2017e5453ced56aa0d283b317babf8f41431b8b32caa5e8c7173a6484bad",
+  "openApiDigest": "sha256:873e58c1c5cff984dbee260f215f8c6f3fd10c8623889ba4618b832814b043a9",
   "operations": [
     {
       "operationId": "getInternalHealth",
@@ -120,6 +120,19 @@
       "apiKeyScope": null,
       "sourceFragment": "callbacks"
     },
+    {
+      "operationId": "postCallbacksStripe",
+      "method": "POST",
+      "path": "/v2/callbacks/stripe",
+      "purpose": "accept an authenticated Stripe billing event",
+      "capabilityKey": null,
+      "conditionalCapabilityKeys": [],
+      "activationGate": "MVP",
+      "assuranceClass": "SESSION",
+      "actionGrant": "none",
+      "apiKeyScope": null,
+      "sourceFragment": "callbacks"
+    },
     {
       "operationId": "getClaimsByToken",
       "method": "GET",
@@ -2686,5 +2699,5 @@
       "sourceFragment": "workloads"
     }
   ],
-  "digest": "sha256:7958a1b4349e014c35b83eae61aa2298e0079280957989654536abf109b19a5b"
+  "digest": "sha256:7c2a102c264904a42607e573f34c5c4db46e498fc068c3778e2b5f8c9f023607"
 }

package/openapi/openapi.yaml

@@ -14269,6 +14269,22 @@ components:
       required:
         - accepted
       type: object
+    PostCallbacksStripeRequest:
+      additionalProperties: true
+      description: Raw Stripe event JSON authenticated over the exact received bytes by the required Stripe-Signature header; the event object is opaque to the contract.
+      type: object
+    PostCallbacksStripeResponse:
+      additionalProperties: false
+      properties:
+        accepted:
+          not:
+            enum:
+              - false
+          type: boolean
+          x-gala-const: true
+      required:
+        - accepted
+      type: object
     PostClaimsByTokenAcceptResponse:
       additionalProperties: false
       properties:
@@ -19445,6 +19461,10 @@ components:
       bearerFormat: Opaque publication-scoped reader token
       scheme: bearer
       type: http
+    stripeWebhookSignature:
+      in: header
+      name: Stripe-Signature
+      type: apiKey
 info:
   description: Executable Galascribe MVP HTTP contract.
   title: Galascribe API
@@ -20569,6 +20589,103 @@ paths:
         - NONE
       x-gala-success-category: oauth-callback
       x-gala-tenant-scope: NONE
+  /v2/callbacks/stripe:
+    post:
+      description: |
+        Stripe billing webhook. The body is the raw Stripe event JSON, opaque to this contract, authenticated by the `Stripe-Signature` header over the exact received bytes (`t=<unix>,v1=<hex>`, HMAC-SHA256 of `<t>.<raw body>`, five-minute tolerance). `200` means the event was accepted, including a duplicate delivery and an event type that is ignored. `400` is a malformed body or a missing, bad or expired signature. `503` means billing is not configured on this deployment.
+      operationId: postCallbacksStripe
+      parameters:
+        - $ref: "#/components/parameters/XCorrelationId"
+        - example: t=1700000000,v1=0000000000000000000000000000000000000000000000000000000000000000
+          in: header
+          name: Stripe-Signature
+          required: true
+          schema:
+            maxLength: 1024
+            minLength: 1
+            type: string
+      requestBody:
+        content:
+          application/json:
+            examples:
+              nominal:
+                summary: Nominal valid request
+                value: {}
+            schema:
+              $ref: "#/components/schemas/PostCallbacksStripeRequest"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              examples:
+                nominal:
+                  summary: Nominal successful response
+                  value:
+                    accepted: true
+              schema:
+                $ref: "#/components/schemas/PostCallbacksStripeResponse"
+          description: accept an authenticated Stripe billing event succeeded
+          headers:
+            Cache-Control:
+              $ref: "#/components/headers/CacheControlNoStore"
+            X-Correlation-Id:
+              $ref: "#/components/headers/XCorrelationId"
+        "400":
+          $ref: "#/components/responses/ValidationFailed"
+        "413":
+          $ref: "#/components/responses/RequestTooLarge"
+        "415":
+          $ref: "#/components/responses/UnsupportedMediaType"
+        "503":
+          content:
+            application/problem+json:
+              examples:
+                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: DEPENDENCY_UNAVAILABLE
+          headers:
+            Cache-Control:
+              $ref: "#/components/headers/CacheControlNoStore"
+            X-Correlation-Id:
+              $ref: "#/components/headers/XCorrelationId"
+          x-gala-problem-codes:
+            - DEPENDENCY_UNAVAILABLE
+      security:
+        - stripeWebhookSignature: []
+      summary: accept an authenticated Stripe billing event
+      tags:
+        - callbacks
+      x-gala-activation-gate: MVP
+      x-gala-activation-guards:
+        - NONE
+      x-gala-capability-key: null
+      x-gala-concurrency: provider-event-id-idempotency-and-event-time-ordering
+      x-gala-conditional-capabilities: []
+      x-gala-example-profile: NOMINAL_SUCCESS_AND_EACH_REACHABLE_PROBLEM
+      x-gala-nullability: required-and-nullable-are-explicit
+      x-gala-purpose: accept an authenticated Stripe billing event
+      x-gala-reachable-problems:
+        - DEPENDENCY_UNAVAILABLE
+        - VALIDATION_FAILED
+      x-gala-replay-identity: stripe-event-id
+      x-gala-state-guards:
+        - NONE
+      x-gala-success-category: billing-callback
+      x-gala-tenant-scope: NONE
   /v2/claims/{token}:
     get:
       description: |

package/package.json

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