@rathnasgala2/schemas 3.23.1 → 3.24.0

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.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
- "package": "@rathnasgala2/schemas@3.23.1",
3
+ "package": "@rathnasgala2/schemas@3.24.0",
4
4
  "source": "package-lock.json",
5
5
  "dependencies": [
6
6
  {
@@ -1803,7 +1803,8 @@
1803
1803
  "postOrganizationsByOrganizationIdPublicationsByPublicationIdRepositoryChangesByChangeIdDismiss",
1804
1804
  "postOrganizationsByOrganizationIdPublicationsByPublicationIdRepositorySetUp",
1805
1805
  "postOrganizationsByOrganizationIdPublicationsByPublicationIdReviews",
1806
- "postOrganizationsByOrganizationIdPublicationsByPublicationIdReviewsByReviewIdDecide"
1806
+ "postOrganizationsByOrganizationIdPublicationsByPublicationIdReviewsByReviewIdDecide",
1807
+ "postOrganizationsByOrganizationIdPublicationsByPublicationIdSitePublishUpdate"
1807
1808
  ],
1808
1809
  "componentIds": ["ValidationSummary"],
1809
1810
  "contentKeyIds": [
@@ -3409,5 +3410,5 @@
3409
3410
  ]
3410
3411
  }
3411
3412
  ],
3412
- "digest": "sha256:7a73811992f76729b79f218c6751fee909fd9a5641207299cf9e6cbbd23dd9dc"
3413
+ "digest": "sha256:320fe24513084f6e5b9b899d365dd4d07b57ab1128806d6e9764373745a05e37"
3413
3414
  }
@@ -229,9 +229,9 @@
229
229
  "version": "2.0.0",
230
230
  "path": "openapi/openapi.yaml",
231
231
  "materialized": true,
232
- "sourceDigest": "sha256:32541c3586ea15707042c3f8945bdf4ef1bbabb034fa33e055590392a968adf5",
232
+ "sourceDigest": "sha256:84db429fb73a76449703c1e6e5b7cb28114966f245b5fd20a0a1f5e049a584f1",
233
233
  "typescriptRootType": null
234
234
  }
235
235
  ],
236
- "digest": "sha256:1929f8942dea455258ad13faa747626641cbdb51dcb3cc79fa366a3d1df4abaa"
236
+ "digest": "sha256:478d4200dd758fabe5cd1cd218b97e9712fc30bdb2013819c17d193a998251f5"
237
237
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "schemaVersion": "2.0.0",
3
3
  "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
4
- "openApiDigest": "sha256:32541c3586ea15707042c3f8945bdf4ef1bbabb034fa33e055590392a968adf5",
4
+ "openApiDigest": "sha256:84db429fb73a76449703c1e6e5b7cb28114966f245b5fd20a0a1f5e049a584f1",
5
5
  "operations": [
6
6
  {
7
7
  "operationId": "getInternalHealth",
@@ -1827,6 +1827,19 @@
1827
1827
  "apiKeyScope": null,
1828
1828
  "sourceFragment": "organizations"
1829
1829
  },
1830
+ {
1831
+ "operationId": "postOrganizationsByOrganizationIdPublicationsByPublicationIdSitePublishUpdate",
1832
+ "method": "POST",
1833
+ "path": "/v2/organizations/{organizationId}/publications/{publicationId}/site:publish-update",
1834
+ "purpose": "publish the repository head as the update to the live site",
1835
+ "capabilityKey": "publication.publish",
1836
+ "conditionalCapabilityKeys": [],
1837
+ "activationGate": "MVP",
1838
+ "assuranceClass": "RECENT_AUTHENTICATION",
1839
+ "actionGrant": "none",
1840
+ "apiKeyScope": null,
1841
+ "sourceFragment": "organizations"
1842
+ },
1830
1843
  {
1831
1844
  "operationId": "postOrganizationsByOrganizationIdPublicationsByPublicationIdTransfers",
1832
1845
  "method": "POST",
@@ -3193,5 +3206,5 @@
3193
3206
  "sourceFragment": "workloads"
3194
3207
  }
3195
3208
  ],
3196
- "digest": "sha256:2fc6cbc01273975349298bafab194770e61fe6c1cf36ed2a4018b83911aa0c56"
3209
+ "digest": "sha256:717a75c038a3380c6082a97d3c58f935187915c612228c35ae2fa64aaf5a1741"
3197
3210
  }
@@ -4123,7 +4123,7 @@ components:
4123
4123
  then:
4124
4124
  required:
4125
4125
  - publishing
4126
- description: Everything a Home screen needs in one read. `url` is the live site address, `null` when nothing has been published. `lastPublished` is absent when `state` is `NEVER_PUBLISHED`. `publishing` is present exactly while `state` is `PUBLISHING`. `schedule` (SCHEMA-3.3.0, optional) is present while a scheduled publish is pending; a pending schedule never makes `state` `PUBLISHING` -- the site reads as it would without it until the schedule starts. `nextRelease` (SCHEMA-3.19.0, optional and nullable) is the scheduled draft that the staggered release will publish next, the one with the earliest `publishAfter` date; `null` or absent when there is none.
4126
+ description: Everything a Home screen needs in one read. `url` is the live site address, `null` when nothing has been published. `lastPublished` is absent when `state` is `NEVER_PUBLISHED`. `publishing` is present exactly while `state` is `PUBLISHING`. `schedule` (SCHEMA-3.3.0, optional) is present while a scheduled publish is pending; a pending schedule never makes `state` `PUBLISHING` -- the site reads as it would without it until the schedule starts. `nextRelease` (SCHEMA-3.19.0, optional and nullable) is the scheduled draft that the staggered release will publish next, the one with the earliest `publishAfter` date; `null` or absent when there is none. `liveUpdate` (SCHEMA-3.24.0, required) says whether the live version has fallen behind the repository's default branch and what publishing the update would put live; see `SiteLiveUpdate` and `POST .../site:publish-update`.
4127
4127
  properties:
4128
4128
  attention:
4129
4129
  items:
@@ -4132,6 +4132,8 @@ components:
4132
4132
  type: array
4133
4133
  lastPublished:
4134
4134
  $ref: "#/components/schemas/SiteLastPublished"
4135
+ liveUpdate:
4136
+ $ref: "#/components/schemas/SiteLiveUpdate"
4135
4137
  nextRelease:
4136
4138
  oneOf:
4137
4139
  - $ref: "#/components/schemas/SiteNextRelease"
@@ -4165,6 +4167,7 @@ components:
4165
4167
  - state
4166
4168
  - pendingChanges
4167
4169
  - attention
4170
+ - liveUpdate
4168
4171
  type: object
4169
4172
  GetOrganizationsByOrganizationIdPublicationsByPublicationIdTransfersByTransferIdResponse:
4170
4173
  allOf:
@@ -16667,6 +16670,21 @@ components:
16667
16670
  - statusUrl
16668
16671
  - reviewId
16669
16672
  type: object
16673
+ PostOrganizationsByOrganizationIdPublicationsByPublicationIdSitePublishUpdateRequest:
16674
+ additionalProperties: false
16675
+ description: |
16676
+ `headCommit` is the `liveUpdate.headCommit` the client read and the
16677
+ person confirmed. The server publishes that head only while it is still
16678
+ the repository's head.
16679
+ properties:
16680
+ headCommit:
16681
+ $ref: "#/components/schemas/PortableDeploymentIntentGitObjectId"
16682
+ required:
16683
+ - headCommit
16684
+ type: object
16685
+ PostOrganizationsByOrganizationIdPublicationsByPublicationIdSitePublishUpdateResponse:
16686
+ allOf:
16687
+ - $ref: "#/components/schemas/PostOrganizationsByOrganizationIdPublicationsByPublicationIdPublishesResponse"
16670
16688
  PostOrganizationsByOrganizationIdPublicationsByPublicationIdTransfersByTransferIdCancelRequest:
16671
16689
  additionalProperties: false
16672
16690
  properties:
@@ -20463,6 +20481,85 @@ components:
20463
20481
  - at
20464
20482
  - actor
20465
20483
  type: object
20484
+ SiteLiveUpdate:
20485
+ additionalProperties: false
20486
+ description: |
20487
+ SCHEMA-3.24.0. Whether the live version has fallen behind the
20488
+ repository's default branch, and what publishing the update would put
20489
+ live. `state` is `CURRENT` when the live version is the head, `BEHIND`
20490
+ when the head holds commits the live version lacks, and `UNKNOWN` when
20491
+ nothing has been published yet, the site has no repository binding, or
20492
+ GitHub could not be reached; a client shows nothing extra for `UNKNOWN`.
20493
+ `servedCommit` is the source commit of the live version and
20494
+ `headCommit` is the head the server compared it against, both `null`
20495
+ when they are not known. A client sends `headCommit` back as the body of
20496
+ `POST .../site:publish-update`. `waiting` counts the commits on the head
20497
+ that are not in the live version. `unreviewed` is true when the site
20498
+ requires review and `waiting.authorCommits` is above 0 or
20499
+ `waiting.truncated` is true (a cut-short comparison cannot rule out such
20500
+ commits): those commits never went through a Galascribe review, and a
20501
+ person's press of the publish action counts as their approval. `restored` is true when the
20502
+ live version is a restore of an older version rather than the newest
20503
+ publish; publishing the update replaces it. `publishing` is true while a
20504
+ publish of any kind is already in flight for the site, so a client shows
20505
+ its progress instead of the action.
20506
+ properties:
20507
+ headCommit:
20508
+ oneOf:
20509
+ - $ref: "#/components/schemas/PortableDeploymentIntentGitObjectId"
20510
+ - type: "null"
20511
+ publishing:
20512
+ type: boolean
20513
+ restored:
20514
+ type: boolean
20515
+ servedCommit:
20516
+ oneOf:
20517
+ - $ref: "#/components/schemas/PortableDeploymentIntentGitObjectId"
20518
+ - type: "null"
20519
+ state:
20520
+ enum:
20521
+ - CURRENT
20522
+ - BEHIND
20523
+ - UNKNOWN
20524
+ type: string
20525
+ unreviewed:
20526
+ type: boolean
20527
+ waiting:
20528
+ $ref: "#/components/schemas/SiteLiveUpdateWaiting"
20529
+ required:
20530
+ - state
20531
+ - servedCommit
20532
+ - headCommit
20533
+ - waiting
20534
+ - unreviewed
20535
+ - restored
20536
+ - publishing
20537
+ type: object
20538
+ SiteLiveUpdateWaiting:
20539
+ additionalProperties: false
20540
+ description: |
20541
+ What the repository's default branch holds that the live version does
20542
+ not: the commits on the head that are not in the live version, split by
20543
+ who made them. `authorCommits` are commits a person made outside
20544
+ Galascribe (a push, the GitHub web editor); `galascribeCommits` are
20545
+ Galascribe's own system commits (set-up, Update now and toolchain
20546
+ updates). Both are 0 when the state is `CURRENT` or `UNKNOWN`.
20547
+ `truncated` is true when the comparison was cut short, in which case
20548
+ the counts are lower bounds.
20549
+ properties:
20550
+ authorCommits:
20551
+ minimum: 0
20552
+ type: integer
20553
+ galascribeCommits:
20554
+ minimum: 0
20555
+ type: integer
20556
+ truncated:
20557
+ type: boolean
20558
+ required:
20559
+ - authorCommits
20560
+ - galascribeCommits
20561
+ - truncated
20562
+ type: object
20466
20563
  SiteNextRelease:
20467
20564
  additionalProperties: false
20468
20565
  description: "The next draft the staggered release will publish (SCHEMA-3.19.0): `slug` is the draft's slug and `publishAfter` its `YYYY-MM-DD` date, read in the publication's staggered-release timezone."
@@ -53709,7 +53806,9 @@ paths:
53709
53806
  description: |
53710
53807
  The one read behind a Home screen: the live address, whether the site is live, publishing or has never been published, who published last, the unpublished changes in words, and what needs attention.
53711
53808
 
53712
- `pendingChanges` holds exactly one entry per path (and one for the look): the newest unpublished change for a path wins, older ones are superseded and omitted. `review` is `NOT_REQUIRED` unless the publication's `publishingPolicy.requireReview` is true. `attention[].code` is a closed vocabulary; `relatedChangeId` names the change that needs the action. `publishing.stage` follows `QUEUED`, `PREPARING`, `BUILDING`, `GOING_LIVE`, `CHECKING_LIVE`; `publishing.runUrl` links the GitHub run and `publishing.stageSince` says when the stage began. Read from the platform's own records; nothing is read from the person's repository.
53809
+ `pendingChanges` holds exactly one entry per path (and one for the look): the newest unpublished change for a path wins, older ones are superseded and omitted. `review` is `NOT_REQUIRED` unless the publication's `publishingPolicy.requireReview` is true. `attention[].code` is a closed vocabulary; `relatedChangeId` names the change that needs the action. `publishing.stage` follows `QUEUED`, `PREPARING`, `BUILDING`, `GOING_LIVE`, `CHECKING_LIVE`; `publishing.runUrl` links the GitHub run and `publishing.stageSince` says when the stage began. Read from the platform's own records, except `liveUpdate`.
53810
+
53811
+ `liveUpdate` (SCHEMA-3.24.0) says whether the live version has fallen behind the repository's default branch, which is what should be live. `state` is `CURRENT`, `BEHIND` or `UNKNOWN` (never published, no repository binding, or GitHub could not be reached; a client shows nothing extra for `UNKNOWN`, and the rest of the read is unaffected). `servedCommit` is the source commit of the live version; `headCommit` is the head the server compared it against, read from GitHub and possibly a short-lived cached read; a client sends `headCommit` back to `POST .../site:publish-update`. `waiting` counts the commits on the head that are not in the live version, split into `authorCommits` (made outside Galascribe) and `galascribeCommits` (Galascribe's own system commits), with `truncated` true when the comparison was cut short. `unreviewed` is true when the site requires review and `waiting.authorCommits` is above 0 or `waiting.truncated` is true. `restored` is true when the live version is a restore of an older version rather than the newest publish. `publishing` is true while a publish of any kind is in flight for the site.
53713
53812
  operationId: getOrganizationsByOrganizationIdPublicationsByPublicationIdSite
53714
53813
  parameters:
53715
53814
  - $ref: "#/components/parameters/XCorrelationId"
@@ -53744,6 +53843,17 @@ paths:
53744
53843
  actor:
53745
53844
  displayName: Asha Rao
53746
53845
  at: "2026-10-05T09:30:00Z"
53846
+ liveUpdate:
53847
+ headCommit: sha1:2222222222222222222222222222222222222222
53848
+ publishing: false
53849
+ restored: false
53850
+ servedCommit: sha1:1111111111111111111111111111111111111111
53851
+ state: BEHIND
53852
+ unreviewed: true
53853
+ waiting:
53854
+ authorCommits: 2
53855
+ galascribeCommits: 1
53856
+ truncated: false
53747
53857
  pendingChanges:
53748
53858
  - action: EDIT
53749
53859
  author:
@@ -53921,6 +54031,420 @@ paths:
53921
54031
  - NONE
53922
54032
  x-gala-success-category: query
53923
54033
  x-gala-tenant-scope: ORGANIZATION_AND_PUBLICATION_PATH
54034
+ /v2/organizations/{organizationId}/publications/{publicationId}/site:publish-update:
54035
+ post:
54036
+ description: |
54037
+ Publishes the repository's current default-branch head when the live version is behind it ("Publish the update"): the commits made outside Galascribe by a push or the GitHub web editor, Galascribe's own system commits that were held back, and the head after a failed publish. The body names the `headCommit` the client read from the site read's `liveUpdate`. Success is `202` with the accepted operation (kind `publish`; `publishId` names it, and the operation's `subject.generationId` names the generation once it exists), the same shape as `changes:publish`. No change is named and nothing is merged: the head is built as it stands. A post dated for later is a draft with `publishAfter` and a production build leaves drafts out, so publishing the update never releases one early.
54038
+
54039
+ The person pressing the action is the approval. When the publication's `publishingPolicy.requireReview` is true and `liveUpdate.unreviewed` is true, the commits counted in `liveUpdate.waiting.authorCommits` never went through a Galascribe review; a person's press of this action counts as approval of those commits, so no `REVIEW_REQUIRED` refusal applies here and the press is recorded against the person. A client shows what will go live and says so before it asks. The same press replaces a restored version: when `liveUpdate.restored` is true the live version is a restore of an older version (a rollback), and publishing the update puts the head live in its place. The automatic paths (self-heal and the set-up republish) never move a restored site; only this action does. After a publish that gave up or is backing off, a press starts a fresh attempt.
54040
+
54041
+ The person needs `publication.publish` and a recent authentication: a stale session gets `401 REAUTH_REQUIRED` and the client confirms the person again and resumes. `Idempotency-Key` is required; a replay with the same key and body returns the first result, the same key with a different body is `409 COMMAND_REPLAY_CONFLICT`. The server checks, in this order and with nothing written on a refusal: `409 HEAD_MOVED` when the repository head is no longer `headCommit` (the client reads the site again and asks again with the new head); `409 ALREADY_LIVE` when the live version is already that head; `409 PUBLISH_IN_PROGRESS` while a publish of any kind is in flight for the site; `409 NOT_SET_UP` when the repository has not been set up for the current Galascribe toolchain, and Update now (`POST .../repository:set-up`) comes first. This operation is not callable with an admin API key.
54042
+ operationId: postOrganizationsByOrganizationIdPublicationsByPublicationIdSitePublishUpdate
54043
+ parameters:
54044
+ - $ref: "#/components/parameters/XCorrelationId"
54045
+ - example: 018f0000-0000-7000-8000-000000000001
54046
+ in: path
54047
+ name: organizationId
54048
+ required: true
54049
+ schema:
54050
+ format: uuid
54051
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
54052
+ type: string
54053
+ - example: 018f0000-0000-7000-8000-000000000001
54054
+ in: path
54055
+ name: publicationId
54056
+ required: true
54057
+ schema:
54058
+ format: uuid
54059
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
54060
+ type: string
54061
+ - $ref: "#/components/parameters/IdempotencyKey"
54062
+ - $ref: "#/components/parameters/XCsrfToken"
54063
+ requestBody:
54064
+ content:
54065
+ application/json:
54066
+ examples:
54067
+ nominal:
54068
+ summary: Nominal valid request
54069
+ value:
54070
+ headCommit: sha1:2222222222222222222222222222222222222222
54071
+ schema:
54072
+ $ref: "#/components/schemas/PostOrganizationsByOrganizationIdPublicationsByPublicationIdSitePublishUpdateRequest"
54073
+ required: true
54074
+ responses:
54075
+ "202":
54076
+ content:
54077
+ application/json:
54078
+ examples:
54079
+ nominal:
54080
+ summary: Nominal successful response
54081
+ value:
54082
+ commandId: 018f0000-0000-7000-8000-000000000001
54083
+ operationId: 018f0000-0000-7000-8000-000000000001
54084
+ phase: accepted
54085
+ publishId: 018f0000-0000-7000-8000-000000000003
54086
+ resourceVersion: 0
54087
+ statusUrl: /v2/organizations/018f0000-0000-7000-8000-000000000001/operations/018f0000-0000-7000-8000-000000000002
54088
+ schema:
54089
+ $ref: "#/components/schemas/PostOrganizationsByOrganizationIdPublicationsByPublicationIdSitePublishUpdateResponse"
54090
+ description: publish the repository's current head as the update to the live site succeeded
54091
+ headers:
54092
+ Cache-Control:
54093
+ $ref: "#/components/headers/CacheControlNoStore"
54094
+ X-Correlation-Id:
54095
+ $ref: "#/components/headers/XCorrelationId"
54096
+ "400":
54097
+ content:
54098
+ application/problem+json:
54099
+ examples:
54100
+ REQUEST_FIELD_UNKNOWN:
54101
+ summary: REQUEST_FIELD_UNKNOWN
54102
+ value:
54103
+ code: REQUEST_FIELD_UNKNOWN
54104
+ correlationId: 018f0000-0000-7000-8000-000000000001
54105
+ detail: See the operation contract.
54106
+ errors: []
54107
+ retryable: false
54108
+ schemaId: urn:gala:schema:problem:2.0.0
54109
+ schemaVersion: 2.0.0
54110
+ status: 400
54111
+ title: REQUEST_FIELD_UNKNOWN
54112
+ type: urn:gala:problem:request-field-unknown
54113
+ VALIDATION_FAILED:
54114
+ summary: VALIDATION_FAILED
54115
+ value:
54116
+ code: VALIDATION_FAILED
54117
+ correlationId: 018f0000-0000-7000-8000-000000000001
54118
+ detail: See the operation contract.
54119
+ errors: []
54120
+ retryable: false
54121
+ schemaId: urn:gala:schema:problem:2.0.0
54122
+ schemaVersion: 2.0.0
54123
+ status: 400
54124
+ title: VALIDATION_FAILED
54125
+ type: urn:gala:problem:validation-failed
54126
+ schema:
54127
+ $ref: "#/components/schemas/Problem"
54128
+ description: REQUEST_FIELD_UNKNOWN, VALIDATION_FAILED
54129
+ headers:
54130
+ Cache-Control:
54131
+ $ref: "#/components/headers/CacheControlNoStore"
54132
+ X-Correlation-Id:
54133
+ $ref: "#/components/headers/XCorrelationId"
54134
+ x-gala-problem-codes:
54135
+ - REQUEST_FIELD_UNKNOWN
54136
+ - VALIDATION_FAILED
54137
+ "401":
54138
+ content:
54139
+ application/problem+json:
54140
+ examples:
54141
+ AUTHENTICATION_REQUIRED:
54142
+ summary: AUTHENTICATION_REQUIRED
54143
+ value:
54144
+ code: AUTHENTICATION_REQUIRED
54145
+ correlationId: 018f0000-0000-7000-8000-000000000001
54146
+ detail: See the operation contract.
54147
+ errors: []
54148
+ retryable: false
54149
+ schemaId: urn:gala:schema:problem:2.0.0
54150
+ schemaVersion: 2.0.0
54151
+ status: 401
54152
+ title: AUTHENTICATION_REQUIRED
54153
+ type: urn:gala:problem:authentication-required
54154
+ REAUTH_REQUIRED:
54155
+ summary: REAUTH_REQUIRED
54156
+ value:
54157
+ code: REAUTH_REQUIRED
54158
+ correlationId: 018f0000-0000-7000-8000-000000000001
54159
+ detail: See the operation contract.
54160
+ errors: []
54161
+ retryable: false
54162
+ schemaId: urn:gala:schema:problem:2.0.0
54163
+ schemaVersion: 2.0.0
54164
+ status: 401
54165
+ title: REAUTH_REQUIRED
54166
+ type: urn:gala:problem:reauth-required
54167
+ schema:
54168
+ $ref: "#/components/schemas/Problem"
54169
+ description: AUTHENTICATION_REQUIRED, REAUTH_REQUIRED
54170
+ headers:
54171
+ Cache-Control:
54172
+ $ref: "#/components/headers/CacheControlNoStore"
54173
+ X-Correlation-Id:
54174
+ $ref: "#/components/headers/XCorrelationId"
54175
+ x-gala-problem-codes:
54176
+ - AUTHENTICATION_REQUIRED
54177
+ - REAUTH_REQUIRED
54178
+ "403":
54179
+ content:
54180
+ application/problem+json:
54181
+ examples:
54182
+ AUTHORIZATION_DENIED:
54183
+ summary: AUTHORIZATION_DENIED
54184
+ value:
54185
+ code: AUTHORIZATION_DENIED
54186
+ correlationId: 018f0000-0000-7000-8000-000000000001
54187
+ detail: See the operation contract.
54188
+ errors: []
54189
+ retryable: false
54190
+ schemaId: urn:gala:schema:problem:2.0.0
54191
+ schemaVersion: 2.0.0
54192
+ status: 403
54193
+ title: AUTHORIZATION_DENIED
54194
+ type: urn:gala:problem:authorization-denied
54195
+ schema:
54196
+ $ref: "#/components/schemas/Problem"
54197
+ description: AUTHORIZATION_DENIED
54198
+ headers:
54199
+ Cache-Control:
54200
+ $ref: "#/components/headers/CacheControlNoStore"
54201
+ X-Correlation-Id:
54202
+ $ref: "#/components/headers/XCorrelationId"
54203
+ x-gala-problem-codes:
54204
+ - AUTHORIZATION_DENIED
54205
+ "404":
54206
+ content:
54207
+ application/problem+json:
54208
+ examples:
54209
+ RESOURCE_NOT_FOUND:
54210
+ summary: RESOURCE_NOT_FOUND
54211
+ value:
54212
+ code: RESOURCE_NOT_FOUND
54213
+ correlationId: 018f0000-0000-7000-8000-000000000001
54214
+ detail: See the operation contract.
54215
+ errors: []
54216
+ retryable: false
54217
+ schemaId: urn:gala:schema:problem:2.0.0
54218
+ schemaVersion: 2.0.0
54219
+ status: 404
54220
+ title: RESOURCE_NOT_FOUND
54221
+ type: urn:gala:problem:resource-not-found
54222
+ schema:
54223
+ $ref: "#/components/schemas/Problem"
54224
+ description: RESOURCE_NOT_FOUND
54225
+ headers:
54226
+ Cache-Control:
54227
+ $ref: "#/components/headers/CacheControlNoStore"
54228
+ X-Correlation-Id:
54229
+ $ref: "#/components/headers/XCorrelationId"
54230
+ x-gala-problem-codes:
54231
+ - RESOURCE_NOT_FOUND
54232
+ "409":
54233
+ content:
54234
+ application/problem+json:
54235
+ examples:
54236
+ ALREADY_LIVE:
54237
+ summary: ALREADY_LIVE
54238
+ value:
54239
+ code: ALREADY_LIVE
54240
+ correlationId: 018f0000-0000-7000-8000-000000000001
54241
+ detail: See the operation contract.
54242
+ errors: []
54243
+ retryable: false
54244
+ schemaId: urn:gala:schema:problem:2.0.0
54245
+ schemaVersion: 2.0.0
54246
+ status: 409
54247
+ title: ALREADY_LIVE
54248
+ type: urn:gala:problem:already-live
54249
+ COMMAND_REPLAY_CONFLICT:
54250
+ summary: COMMAND_REPLAY_CONFLICT
54251
+ value:
54252
+ code: COMMAND_REPLAY_CONFLICT
54253
+ correlationId: 018f0000-0000-7000-8000-000000000001
54254
+ detail: See the operation contract.
54255
+ errors: []
54256
+ retryable: false
54257
+ schemaId: urn:gala:schema:problem:2.0.0
54258
+ schemaVersion: 2.0.0
54259
+ status: 409
54260
+ title: COMMAND_REPLAY_CONFLICT
54261
+ type: urn:gala:problem:command-replay-conflict
54262
+ HEAD_MOVED:
54263
+ summary: HEAD_MOVED
54264
+ value:
54265
+ code: HEAD_MOVED
54266
+ correlationId: 018f0000-0000-7000-8000-000000000001
54267
+ detail: See the operation contract.
54268
+ errors: []
54269
+ retryable: false
54270
+ schemaId: urn:gala:schema:problem:2.0.0
54271
+ schemaVersion: 2.0.0
54272
+ status: 409
54273
+ title: HEAD_MOVED
54274
+ type: urn:gala:problem:head-moved
54275
+ NOT_SET_UP:
54276
+ summary: NOT_SET_UP
54277
+ value:
54278
+ code: NOT_SET_UP
54279
+ correlationId: 018f0000-0000-7000-8000-000000000001
54280
+ detail: See the operation contract.
54281
+ errors: []
54282
+ retryable: false
54283
+ schemaId: urn:gala:schema:problem:2.0.0
54284
+ schemaVersion: 2.0.0
54285
+ status: 409
54286
+ title: NOT_SET_UP
54287
+ type: urn:gala:problem:not-set-up
54288
+ PUBLISH_IN_PROGRESS:
54289
+ summary: PUBLISH_IN_PROGRESS
54290
+ value:
54291
+ code: PUBLISH_IN_PROGRESS
54292
+ correlationId: 018f0000-0000-7000-8000-000000000001
54293
+ detail: See the operation contract.
54294
+ errors: []
54295
+ retryable: false
54296
+ schemaId: urn:gala:schema:problem:2.0.0
54297
+ schemaVersion: 2.0.0
54298
+ status: 409
54299
+ title: PUBLISH_IN_PROGRESS
54300
+ type: urn:gala:problem:publish-in-progress
54301
+ schema:
54302
+ $ref: "#/components/schemas/Problem"
54303
+ description: ALREADY_LIVE, COMMAND_REPLAY_CONFLICT, HEAD_MOVED, NOT_SET_UP, PUBLISH_IN_PROGRESS
54304
+ headers:
54305
+ Cache-Control:
54306
+ $ref: "#/components/headers/CacheControlNoStore"
54307
+ X-Correlation-Id:
54308
+ $ref: "#/components/headers/XCorrelationId"
54309
+ x-gala-problem-codes:
54310
+ - ALREADY_LIVE
54311
+ - COMMAND_REPLAY_CONFLICT
54312
+ - HEAD_MOVED
54313
+ - NOT_SET_UP
54314
+ - PUBLISH_IN_PROGRESS
54315
+ "422":
54316
+ content:
54317
+ application/problem+json:
54318
+ examples:
54319
+ VALIDATION_FAILED:
54320
+ summary: VALIDATION_FAILED
54321
+ value:
54322
+ code: VALIDATION_FAILED
54323
+ correlationId: 018f0000-0000-7000-8000-000000000001
54324
+ detail: See the operation contract.
54325
+ errors: []
54326
+ retryable: false
54327
+ schemaId: urn:gala:schema:problem:2.0.0
54328
+ schemaVersion: 2.0.0
54329
+ status: 422
54330
+ title: VALIDATION_FAILED
54331
+ type: urn:gala:problem:validation-failed
54332
+ schema:
54333
+ $ref: "#/components/schemas/Problem"
54334
+ description: VALIDATION_FAILED
54335
+ headers:
54336
+ Cache-Control:
54337
+ $ref: "#/components/headers/CacheControlNoStore"
54338
+ X-Correlation-Id:
54339
+ $ref: "#/components/headers/XCorrelationId"
54340
+ x-gala-problem-codes:
54341
+ - VALIDATION_FAILED
54342
+ "429":
54343
+ content:
54344
+ application/problem+json:
54345
+ examples:
54346
+ RATE_LIMITED:
54347
+ summary: RATE_LIMITED
54348
+ value:
54349
+ code: RATE_LIMITED
54350
+ correlationId: 018f0000-0000-7000-8000-000000000001
54351
+ detail: See the operation contract.
54352
+ errors: []
54353
+ retryable: true
54354
+ schemaId: urn:gala:schema:problem:2.0.0
54355
+ schemaVersion: 2.0.0
54356
+ status: 429
54357
+ title: RATE_LIMITED
54358
+ type: urn:gala:problem:rate-limited
54359
+ schema:
54360
+ $ref: "#/components/schemas/Problem"
54361
+ description: RATE_LIMITED
54362
+ headers:
54363
+ Cache-Control:
54364
+ $ref: "#/components/headers/CacheControlNoStore"
54365
+ Retry-After:
54366
+ $ref: "#/components/headers/RetryAfter"
54367
+ X-Correlation-Id:
54368
+ $ref: "#/components/headers/XCorrelationId"
54369
+ x-gala-problem-codes:
54370
+ - RATE_LIMITED
54371
+ "503":
54372
+ content:
54373
+ application/problem+json:
54374
+ examples:
54375
+ CAPABILITY_UNAVAILABLE:
54376
+ summary: CAPABILITY_UNAVAILABLE
54377
+ value:
54378
+ code: CAPABILITY_UNAVAILABLE
54379
+ correlationId: 018f0000-0000-7000-8000-000000000001
54380
+ detail: See the operation contract.
54381
+ errors: []
54382
+ retryable: false
54383
+ schemaId: urn:gala:schema:problem:2.0.0
54384
+ schemaVersion: 2.0.0
54385
+ status: 503
54386
+ title: CAPABILITY_UNAVAILABLE
54387
+ type: urn:gala:problem:capability-unavailable
54388
+ DEPENDENCY_UNAVAILABLE:
54389
+ summary: DEPENDENCY_UNAVAILABLE
54390
+ value:
54391
+ code: DEPENDENCY_UNAVAILABLE
54392
+ correlationId: 018f0000-0000-7000-8000-000000000001
54393
+ detail: See the operation contract.
54394
+ errors: []
54395
+ retryable: true
54396
+ schemaId: urn:gala:schema:problem:2.0.0
54397
+ schemaVersion: 2.0.0
54398
+ status: 503
54399
+ title: DEPENDENCY_UNAVAILABLE
54400
+ type: urn:gala:problem:dependency-unavailable
54401
+ schema:
54402
+ $ref: "#/components/schemas/Problem"
54403
+ description: CAPABILITY_UNAVAILABLE, DEPENDENCY_UNAVAILABLE
54404
+ headers:
54405
+ Cache-Control:
54406
+ $ref: "#/components/headers/CacheControlNoStore"
54407
+ X-Correlation-Id:
54408
+ $ref: "#/components/headers/XCorrelationId"
54409
+ x-gala-problem-codes:
54410
+ - CAPABILITY_UNAVAILABLE
54411
+ - DEPENDENCY_UNAVAILABLE
54412
+ security:
54413
+ - browserSession: []
54414
+ summary: publish the repository head as the update to the live site
54415
+ tags:
54416
+ - organizations
54417
+ x-gala-action-grant: none
54418
+ x-gala-activation-gate: MVP
54419
+ x-gala-activation-guards:
54420
+ - Active binding epoch, admitted author-source contract, admitted destination, and no transfer or retirement fence
54421
+ x-gala-assurance-class: RECENT_AUTHENTICATION
54422
+ x-gala-capability-key: publication.publish
54423
+ x-gala-concurrency: publication-and-destination-epochs
54424
+ x-gala-conditional-capabilities: []
54425
+ x-gala-example-profile: NOMINAL_SUCCESS_AND_EACH_REACHABLE_PROBLEM
54426
+ x-gala-nullability: required-and-nullable-are-explicit
54427
+ x-gala-purpose: publish the repository head as the update to the live site
54428
+ x-gala-reachable-problems:
54429
+ - ALREADY_LIVE
54430
+ - AUTHENTICATION_REQUIRED
54431
+ - AUTHORIZATION_DENIED
54432
+ - CAPABILITY_UNAVAILABLE
54433
+ - COMMAND_REPLAY_CONFLICT
54434
+ - DEPENDENCY_UNAVAILABLE
54435
+ - HEAD_MOVED
54436
+ - NOT_SET_UP
54437
+ - PUBLISH_IN_PROGRESS
54438
+ - RATE_LIMITED
54439
+ - REAUTH_REQUIRED
54440
+ - REQUEST_FIELD_UNKNOWN
54441
+ - RESOURCE_NOT_FOUND
54442
+ - VALIDATION_FAILED
54443
+ x-gala-replay-identity: idempotency-key
54444
+ x-gala-state-guards:
54445
+ - NONE
54446
+ x-gala-success-category: async
54447
+ x-gala-tenant-scope: ORGANIZATION_AND_PUBLICATION_PATH
53924
54448
  /v2/organizations/{organizationId}/publications/{publicationId}/transfers:
53925
54449
  post:
53926
54450
  description: |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rathnasgala2/schemas",
3
- "version": "3.23.1",
3
+ "version": "3.24.0",
4
4
  "description": "Executable JSON Schema and OpenAPI contracts for Galascribe",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
package/sbom.cdx.json CHANGED
@@ -97,8 +97,8 @@
97
97
  "type": "library",
98
98
  "name": "schemas",
99
99
  "group": "@rathnasgala2",
100
- "version": "3.23.1",
101
- "bom-ref": "@rathnasgala2/schemas@3.23.1",
100
+ "version": "3.24.0",
101
+ "bom-ref": "@rathnasgala2/schemas@3.24.0",
102
102
  "description": "Executable JSON Schema and OpenAPI contracts for Galascribe",
103
103
  "licenses": [
104
104
  {
@@ -108,7 +108,7 @@
108
108
  }
109
109
  }
110
110
  ],
111
- "purl": "pkg:npm/%40rathnasgala2/schemas@3.23.1?vcs_url=git%2Bhttps%3A%2F%2Fgithub.com%2Frathnasgala2%2Fschema.git",
111
+ "purl": "pkg:npm/%40rathnasgala2/schemas@3.24.0?vcs_url=git%2Bhttps%3A%2F%2Fgithub.com%2Frathnasgala2%2Fschema.git",
112
112
  "externalReferences": [
113
113
  {
114
114
  "url": "https://github.com/rathnasgala2/schema/issues",
@@ -153,7 +153,7 @@
153
153
  "type": "library",
154
154
  "name": "ajv-formats",
155
155
  "version": "3.0.1",
156
- "bom-ref": "@rathnasgala2/schemas@3.23.1|ajv-formats@3.0.1",
156
+ "bom-ref": "@rathnasgala2/schemas@3.24.0|ajv-formats@3.0.1",
157
157
  "licenses": [
158
158
  {
159
159
  "license": {
@@ -187,7 +187,7 @@
187
187
  "type": "library",
188
188
  "name": "ajv",
189
189
  "version": "8.20.0",
190
- "bom-ref": "@rathnasgala2/schemas@3.23.1|ajv@8.20.0",
190
+ "bom-ref": "@rathnasgala2/schemas@3.24.0|ajv@8.20.0",
191
191
  "licenses": [
192
192
  {
193
193
  "license": {
@@ -221,7 +221,7 @@
221
221
  "type": "library",
222
222
  "name": "fast-deep-equal",
223
223
  "version": "3.1.3",
224
- "bom-ref": "@rathnasgala2/schemas@3.23.1|fast-deep-equal@3.1.3",
224
+ "bom-ref": "@rathnasgala2/schemas@3.24.0|fast-deep-equal@3.1.3",
225
225
  "licenses": [
226
226
  {
227
227
  "license": {
@@ -255,7 +255,7 @@
255
255
  "type": "library",
256
256
  "name": "fast-uri",
257
257
  "version": "3.1.8",
258
- "bom-ref": "@rathnasgala2/schemas@3.23.1|fast-uri@3.1.8",
258
+ "bom-ref": "@rathnasgala2/schemas@3.24.0|fast-uri@3.1.8",
259
259
  "licenses": [
260
260
  {
261
261
  "license": {
@@ -289,7 +289,7 @@
289
289
  "type": "library",
290
290
  "name": "json-schema-traverse",
291
291
  "version": "1.0.0",
292
- "bom-ref": "@rathnasgala2/schemas@3.23.1|json-schema-traverse@1.0.0",
292
+ "bom-ref": "@rathnasgala2/schemas@3.24.0|json-schema-traverse@1.0.0",
293
293
  "licenses": [
294
294
  {
295
295
  "license": {
@@ -323,7 +323,7 @@
323
323
  "type": "library",
324
324
  "name": "require-from-string",
325
325
  "version": "2.0.2",
326
- "bom-ref": "@rathnasgala2/schemas@3.23.1|require-from-string@2.0.2",
326
+ "bom-ref": "@rathnasgala2/schemas@3.24.0|require-from-string@2.0.2",
327
327
  "licenses": [
328
328
  {
329
329
  "license": {
@@ -1064,10 +1064,10 @@
1064
1064
  ],
1065
1065
  "dependencies": [
1066
1066
  {
1067
- "ref": "@rathnasgala2/schemas@3.23.1",
1067
+ "ref": "@rathnasgala2/schemas@3.24.0",
1068
1068
  "dependsOn": [
1069
- "@rathnasgala2/schemas@3.23.1|ajv-formats@3.0.1",
1070
- "@rathnasgala2/schemas@3.23.1|ajv@8.20.0",
1069
+ "@rathnasgala2/schemas@3.24.0|ajv-formats@3.0.1",
1070
+ "@rathnasgala2/schemas@3.24.0|ajv@8.20.0",
1071
1071
  "pkg:npm/semver@7.8.5",
1072
1072
  "urn:gala:source-data:iana-ipv4-special-registry",
1073
1073
  "urn:gala:source-data:iana-ipv6-special-registry",
@@ -1089,31 +1089,31 @@
1089
1089
  ]
1090
1090
  },
1091
1091
  {
1092
- "ref": "@rathnasgala2/schemas@3.23.1|ajv-formats@3.0.1",
1092
+ "ref": "@rathnasgala2/schemas@3.24.0|ajv-formats@3.0.1",
1093
1093
  "dependsOn": [
1094
- "@rathnasgala2/schemas@3.23.1|ajv@8.20.0"
1094
+ "@rathnasgala2/schemas@3.24.0|ajv@8.20.0"
1095
1095
  ]
1096
1096
  },
1097
1097
  {
1098
- "ref": "@rathnasgala2/schemas@3.23.1|ajv@8.20.0",
1098
+ "ref": "@rathnasgala2/schemas@3.24.0|ajv@8.20.0",
1099
1099
  "dependsOn": [
1100
- "@rathnasgala2/schemas@3.23.1|fast-deep-equal@3.1.3",
1101
- "@rathnasgala2/schemas@3.23.1|fast-uri@3.1.8",
1102
- "@rathnasgala2/schemas@3.23.1|json-schema-traverse@1.0.0",
1103
- "@rathnasgala2/schemas@3.23.1|require-from-string@2.0.2"
1100
+ "@rathnasgala2/schemas@3.24.0|fast-deep-equal@3.1.3",
1101
+ "@rathnasgala2/schemas@3.24.0|fast-uri@3.1.8",
1102
+ "@rathnasgala2/schemas@3.24.0|json-schema-traverse@1.0.0",
1103
+ "@rathnasgala2/schemas@3.24.0|require-from-string@2.0.2"
1104
1104
  ]
1105
1105
  },
1106
1106
  {
1107
- "ref": "@rathnasgala2/schemas@3.23.1|fast-deep-equal@3.1.3"
1107
+ "ref": "@rathnasgala2/schemas@3.24.0|fast-deep-equal@3.1.3"
1108
1108
  },
1109
1109
  {
1110
- "ref": "@rathnasgala2/schemas@3.23.1|fast-uri@3.1.8"
1110
+ "ref": "@rathnasgala2/schemas@3.24.0|fast-uri@3.1.8"
1111
1111
  },
1112
1112
  {
1113
- "ref": "@rathnasgala2/schemas@3.23.1|json-schema-traverse@1.0.0"
1113
+ "ref": "@rathnasgala2/schemas@3.24.0|json-schema-traverse@1.0.0"
1114
1114
  },
1115
1115
  {
1116
- "ref": "@rathnasgala2/schemas@3.23.1|require-from-string@2.0.2"
1116
+ "ref": "@rathnasgala2/schemas@3.24.0|require-from-string@2.0.2"
1117
1117
  },
1118
1118
  {
1119
1119
  "ref": "pkg:npm/semver@7.8.5"