@rathnasgala2/schemas 3.38.0 → 3.39.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.38.0",
3
+ "package": "@rathnasgala2/schemas@3.39.0",
4
4
  "source": "package-lock.json",
5
5
  "dependencies": [
6
6
  {
@@ -229,9 +229,9 @@
229
229
  "version": "2.0.0",
230
230
  "path": "openapi/openapi.yaml",
231
231
  "materialized": true,
232
- "sourceDigest": "sha256:9fd0867256cb9bae41fe81a73fec8ef605e102e6731ef9711c7507b0d6f4248d",
232
+ "sourceDigest": "sha256:abaa1134d0b5bcbc66e802e6a7f9104ff97b9e89204f4f4099ae27bd33a130e2",
233
233
  "typescriptRootType": null
234
234
  }
235
235
  ],
236
- "digest": "sha256:4feee68dabb8e0b4c1d4593dd546fbd0840ff0b779c1712585da776baef90d55"
236
+ "digest": "sha256:e74629d4f1c4c32a61eb545cafb7e7b3e2c34aa8835479c9b7200b64935e4e42"
237
237
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "schemaVersion": "2.0.0",
3
3
  "sourceDesignRevision": "a53052955ceb6c1aa10c886289dc832eedfe6de0a00004df07d353ac19c4403a",
4
- "openApiDigest": "sha256:9fd0867256cb9bae41fe81a73fec8ef605e102e6731ef9711c7507b0d6f4248d",
4
+ "openApiDigest": "sha256:abaa1134d0b5bcbc66e802e6a7f9104ff97b9e89204f4f4099ae27bd33a130e2",
5
5
  "operations": [
6
6
  {
7
7
  "operationId": "getInternalHealth",
@@ -3843,5 +3843,5 @@
3843
3843
  "sourceFragment": "workloads"
3844
3844
  }
3845
3845
  ],
3846
- "digest": "sha256:40a395fc0ba96909facd3dda068e3860495386ea21d3aba493ce13dc730600aa"
3846
+ "digest": "sha256:959a2ce5cff7482a49c6cbc92333e18a1f425fba2c9073f0fc36c056b311751d"
3847
3847
  }
@@ -6723,11 +6723,11 @@ components:
6723
6723
  type: string
6724
6724
  InterviewPolicy:
6725
6725
  additionalProperties: false
6726
- description: "SCHEMA-3.34.0. Whether Interview is available to this publication and how many interviews are left this period (UTC month). `enabled: false` means the feature is off; the editor says so and stays usable."
6726
+ description: "SCHEMA-3.34.0. Whether Interview is available to this publication and how many interviews are left this period (the UTC week starting Monday). `enabled: false` means the feature is off; the editor says so and stays usable. `plan.requiredTier` is `PRO` and `quota.period` is a week with `quota.renewsAt` as of SCHEMA-3.39.0."
6727
6727
  properties:
6728
6728
  budget:
6729
6729
  additionalProperties: false
6730
- description: "`available` is false when the platform's monthly spend cap is reached."
6730
+ description: "`available` is false when the platform's optional monthly spend cap is reached."
6731
6731
  properties:
6732
6732
  available:
6733
6733
  type: boolean
@@ -6743,7 +6743,7 @@ components:
6743
6743
  allowed:
6744
6744
  type: boolean
6745
6745
  requiredTier:
6746
- description: "The API tier the feature needs: `BUSINESS`, sold as Pro."
6746
+ description: "The lowest API tier that includes Interview: `PRO` (sold as Basic). Basic sites get 2 interviews a week and Pro sites (`BUSINESS`) 5, as the platform settings say."
6747
6747
  enum:
6748
6748
  - FREE
6749
6749
  - PRO
@@ -6761,19 +6761,23 @@ components:
6761
6761
  minimum: 0
6762
6762
  type: integer
6763
6763
  period:
6764
- description: The UTC month, `YYYY-MM`.
6765
- pattern: ^[0-9]{4}-(?:0[1-9]|1[0-2])$
6764
+ description: The UTC week the allowance counts in, as its Monday, `YYYY-MM-DD`
6765
+ pattern: ^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])$
6766
6766
  type: string
6767
6767
  remaining:
6768
6768
  format: int64
6769
6769
  minimum: 0
6770
6770
  type: integer
6771
+ renewsAt:
6772
+ $ref: "#/components/schemas/PortableProblemRfc3339"
6773
+ description: The first instant of the next UTC week (Monday 00:00Z), when the allowance comes back
6771
6774
  used:
6772
6775
  format: int64
6773
6776
  minimum: 0
6774
6777
  type: integer
6775
6778
  required:
6776
6779
  - period
6780
+ - renewsAt
6777
6781
  - limit
6778
6782
  - used
6779
6783
  - remaining
@@ -50477,7 +50481,7 @@ paths:
50477
50481
  /v2/organizations/{organizationId}/publications/{publicationId}/interview-policy:
50478
50482
  get:
50479
50483
  description: |
50480
- Whether Interview is available to this publication (`enabled`), whether the plan includes it (`plan.allowed`, `BUSINESS` tier, sold as Pro), how many interviews are left this period (UTC month) and whether the platform's monthly spend cap still has room. `enabled: false` means the feature is off; the editor says so and stays usable.
50484
+ Whether Interview is available to this publication (`enabled`), whether the plan includes it (`plan.allowed`: the plan must be `PRO`, sold as Basic, or above), how many interviews are left this period (the UTC week starting Monday) and whether the platform's optional monthly spend cap still has room. `enabled: false` means the feature is off; the editor says so and stays usable.
50481
50485
  operationId: getOrganizationsByOrganizationIdPublicationsByPublicationIdInterviewPolicy
50482
50486
  parameters:
50483
50487
  - $ref: "#/components/parameters/XCorrelationId"
@@ -50502,6 +50506,21 @@ paths:
50502
50506
  content:
50503
50507
  application/json:
50504
50508
  examples:
50509
+ basic:
50510
+ summary: A Basic site
50511
+ value:
50512
+ budget:
50513
+ available: true
50514
+ enabled: true
50515
+ plan:
50516
+ allowed: true
50517
+ requiredTier: PRO
50518
+ quota:
50519
+ limit: 2
50520
+ period: "2026-11-02"
50521
+ remaining: 1
50522
+ renewsAt: "2026-11-09T00:00:00Z"
50523
+ used: 1
50505
50524
  nominal:
50506
50525
  summary: Nominal successful response
50507
50526
  value:
@@ -50510,11 +50529,12 @@ paths:
50510
50529
  enabled: true
50511
50530
  plan:
50512
50531
  allowed: true
50513
- requiredTier: BUSINESS
50532
+ requiredTier: PRO
50514
50533
  quota:
50515
- limit: 10
50516
- period: 2026-11
50517
- remaining: 7
50534
+ limit: 5
50535
+ period: "2026-11-02"
50536
+ remaining: 2
50537
+ renewsAt: "2026-11-09T00:00:00Z"
50518
50538
  used: 3
50519
50539
  schema:
50520
50540
  $ref: "#/components/schemas/GetOrganizationsByOrganizationIdPublicationsByPublicationIdInterviewPolicyResponse"
@@ -51269,7 +51289,7 @@ paths:
51269
51289
  x-gala-tenant-scope: ORGANIZATION_AND_PUBLICATION_PATH
51270
51290
  post:
51271
51291
  description: |
51272
- Saves the material (a note, a voice transcript or a link with its text) as an interview in `CAPTURED`. Nothing is asked and no quota unit is used yet; `POST .../interviews/{interviewId}:start` begins the conversation. `409 PLAN_REQUIRED` when the plan is below `BUSINESS`; `503 CAPABILITY_UNAVAILABLE` when Interview is off. `201`.
51292
+ Saves the material (a note, a voice transcript or a link with its text) as an interview in `CAPTURED`. Nothing is asked and no quota unit is used yet; `POST .../interviews/{interviewId}:start` begins the conversation. The plan must be `PRO` (sold as Basic) or above: `409 PLAN_REQUIRED` below `PRO`. `503 CAPABILITY_UNAVAILABLE` when Interview is off. `201`.
51273
51293
  operationId: postOrganizationsByOrganizationIdPublicationsByPublicationIdInterviews
51274
51294
  parameters:
51275
51295
  - $ref: "#/components/parameters/XCorrelationId"
@@ -53088,7 +53108,7 @@ paths:
53088
53108
  /v2/organizations/{organizationId}/publications/{publicationId}/interviews/{interviewId}:start:
53089
53109
  post:
53090
53110
  description: |
53091
- Reserves one unit of the organization's monthly allowance and asks the first question. Only from `CAPTURED`. `429 QUOTA_EXHAUSTED` with `Retry-After` when no unit is left this period; `503 BUDGET_EXHAUSTED` when the platform's monthly spend cap is reached; `503 PROVIDER_UNAVAILABLE` when the question could not be asked (nothing is stored and no unit is used; retry).
53111
+ Reserves one unit of the organization's weekly allowance (the UTC week starting Monday; 2 on Basic, 5 on Pro by default) and asks the first question. Only from `CAPTURED`. `429 QUOTA_EXHAUSTED` with `Retry-After` when no unit is left this period; `503 BUDGET_EXHAUSTED` when the platform's optional monthly spend cap is reached; `503 PROVIDER_UNAVAILABLE` when the question could not be asked (nothing is stored and no unit is used; retry).
53092
53112
  operationId: postOrganizationsByOrganizationIdPublicationsByPublicationIdInterviewsByInterviewIdStart
53093
53113
  parameters:
53094
53114
  - $ref: "#/components/parameters/XCorrelationId"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rathnasgala2/schemas",
3
- "version": "3.38.0",
3
+ "version": "3.39.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.38.0",
101
- "bom-ref": "@rathnasgala2/schemas@3.38.0",
100
+ "version": "3.39.0",
101
+ "bom-ref": "@rathnasgala2/schemas@3.39.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.38.0?vcs_url=git%2Bhttps%3A%2F%2Fgithub.com%2Frathnasgala2%2Fschema.git",
111
+ "purl": "pkg:npm/%40rathnasgala2/schemas@3.39.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.38.0|ajv-formats@3.0.1",
156
+ "bom-ref": "@rathnasgala2/schemas@3.39.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.38.0|ajv@8.20.0",
190
+ "bom-ref": "@rathnasgala2/schemas@3.39.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.38.0|fast-deep-equal@3.1.3",
224
+ "bom-ref": "@rathnasgala2/schemas@3.39.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.38.0|fast-uri@3.1.8",
258
+ "bom-ref": "@rathnasgala2/schemas@3.39.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.38.0|json-schema-traverse@1.0.0",
292
+ "bom-ref": "@rathnasgala2/schemas@3.39.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.38.0|require-from-string@2.0.2",
326
+ "bom-ref": "@rathnasgala2/schemas@3.39.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.38.0",
1067
+ "ref": "@rathnasgala2/schemas@3.39.0",
1068
1068
  "dependsOn": [
1069
- "@rathnasgala2/schemas@3.38.0|ajv-formats@3.0.1",
1070
- "@rathnasgala2/schemas@3.38.0|ajv@8.20.0",
1069
+ "@rathnasgala2/schemas@3.39.0|ajv-formats@3.0.1",
1070
+ "@rathnasgala2/schemas@3.39.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.38.0|ajv-formats@3.0.1",
1092
+ "ref": "@rathnasgala2/schemas@3.39.0|ajv-formats@3.0.1",
1093
1093
  "dependsOn": [
1094
- "@rathnasgala2/schemas@3.38.0|ajv@8.20.0"
1094
+ "@rathnasgala2/schemas@3.39.0|ajv@8.20.0"
1095
1095
  ]
1096
1096
  },
1097
1097
  {
1098
- "ref": "@rathnasgala2/schemas@3.38.0|ajv@8.20.0",
1098
+ "ref": "@rathnasgala2/schemas@3.39.0|ajv@8.20.0",
1099
1099
  "dependsOn": [
1100
- "@rathnasgala2/schemas@3.38.0|fast-deep-equal@3.1.3",
1101
- "@rathnasgala2/schemas@3.38.0|fast-uri@3.1.8",
1102
- "@rathnasgala2/schemas@3.38.0|json-schema-traverse@1.0.0",
1103
- "@rathnasgala2/schemas@3.38.0|require-from-string@2.0.2"
1100
+ "@rathnasgala2/schemas@3.39.0|fast-deep-equal@3.1.3",
1101
+ "@rathnasgala2/schemas@3.39.0|fast-uri@3.1.8",
1102
+ "@rathnasgala2/schemas@3.39.0|json-schema-traverse@1.0.0",
1103
+ "@rathnasgala2/schemas@3.39.0|require-from-string@2.0.2"
1104
1104
  ]
1105
1105
  },
1106
1106
  {
1107
- "ref": "@rathnasgala2/schemas@3.38.0|fast-deep-equal@3.1.3"
1107
+ "ref": "@rathnasgala2/schemas@3.39.0|fast-deep-equal@3.1.3"
1108
1108
  },
1109
1109
  {
1110
- "ref": "@rathnasgala2/schemas@3.38.0|fast-uri@3.1.8"
1110
+ "ref": "@rathnasgala2/schemas@3.39.0|fast-uri@3.1.8"
1111
1111
  },
1112
1112
  {
1113
- "ref": "@rathnasgala2/schemas@3.38.0|json-schema-traverse@1.0.0"
1113
+ "ref": "@rathnasgala2/schemas@3.39.0|json-schema-traverse@1.0.0"
1114
1114
  },
1115
1115
  {
1116
- "ref": "@rathnasgala2/schemas@3.38.0|require-from-string@2.0.2"
1116
+ "ref": "@rathnasgala2/schemas@3.39.0|require-from-string@2.0.2"
1117
1117
  },
1118
1118
  {
1119
1119
  "ref": "pkg:npm/semver@7.8.5"