@confighub/api 0.11.0 → 0.11.1

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.
package/dist/index.d.cts CHANGED
@@ -2766,7 +2766,7 @@ interface paths {
2766
2766
  };
2767
2767
  /**
2768
2768
  * Get everything recorded about one field of a Unit
2769
- * @description Returns everything recorded about one field of a Unit's configuration: the field as the Unit's blame reports it, its own annotations, whether the Unit's last Release includes its value, and each change from this Unit out to where the value was set with the Mutation and Revision it was read from. With history, it also returns every change the Unit recorded to the field. A field that names nothing is a 404; one that names several fields, or a value holding several, is a 400 whose message lists them.
2769
+ * @description Returns everything recorded about one field of a Unit's configuration: the field as the Unit's blame reports it, its own annotations, whether the Unit's last Release includes its value, each change from this Unit out to where the value was set with the Mutation and Revision it was read from, the comments the configuration has about the field, and the latest thread of ReviewComments about it. With history, it also returns every change the Unit recorded to the field. A field that names nothing is a 404; one that names several fields, or a value holding several, is a 400 whose message lists them.
2770
2770
  */
2771
2771
  get: operations["GetUnitPath"];
2772
2772
  put?: never;
@@ -4073,6 +4073,14 @@ interface components {
4073
4073
  ProvidedResource?: components["schemas"]["ResourceInfo"];
4074
4074
  };
4075
4075
  BindingList: components["schemas"]["Binding"][];
4076
+ BlameConfigComments: {
4077
+ /** @description The comment on the lines below the field. */
4078
+ Foot?: string;
4079
+ /** @description The comment on the lines above the field. On the row about a resource as a whole, the comment above the resource's document separator. */
4080
+ Head?: string;
4081
+ /** @description The comment at the end of the field's line. */
4082
+ Line?: string;
4083
+ };
4076
4084
  BlameConflictDismissal: {
4077
4085
  /** @description For a dismissal of what one guard withheld, the guard's key. */
4078
4086
  Guard?: string;
@@ -4293,6 +4301,16 @@ interface components {
4293
4301
  /** @description The value the change recorded for the field. Returned in History. */
4294
4302
  Value?: string;
4295
4303
  };
4304
+ BlameReviewThread: {
4305
+ /**
4306
+ * Format: uuid
4307
+ * @description The ChangeOrder the thread was made in review of, if any; the report's Names names it, unless it cannot be read.
4308
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4309
+ */
4310
+ ChangeOrderID?: string;
4311
+ /** @description The comment that started the thread, then its replies, replies to replies included, oldest first. Hidden comments are left out; a thread whose first comment is hidden still has its replies. The report's Names names each comment's author by UserID, unless the author cannot be read. */
4312
+ Comments?: components["schemas"]["ReviewComment"][] | null;
4313
+ };
4296
4314
  BlameValidation: {
4297
4315
  /** @description The result's free-text messages, where the function gave no Issues. */
4298
4316
  Details?: string[];
@@ -9030,13 +9048,15 @@ interface components {
9030
9048
  };
9031
9049
  /** @description The field's chain: the changes that put the value here, from this unit out to where it was set, each with the Mutation and Revision it was read from. */
9032
9050
  Changes?: components["schemas"]["BlamePathChange"][];
9051
+ /** @description The comments the unit's configuration has about the field: above it, at the end of its line, and below it. Absent when it has none. */
9052
+ ConfigComments?: components["schemas"]["BlameConfigComments"];
9033
9053
  /** @description Every conflict dismissal covering the field, each with the Path it is recorded at: the field's, a pattern naming it, or empty for one on its resource as a whole. */
9034
9054
  ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
9035
9055
  /** @description The field, as the unit's blame reports it, without its Chain: Changes carries the chain with its records. */
9036
9056
  Field?: components["schemas"]["BlameField"];
9037
9057
  /** @description Every change this unit recorded to the field, oldest first; returned when history is requested. */
9038
9058
  History?: components["schemas"]["BlamePathChange"][];
9039
- /** @description Names, as space/slug, of the Units and Targets the report's records refer to by ID alone: the other unit of each conflict, each Link's upstream unit, each merge source, and each Release's Target. */
9059
+ /** @description Names of the entities the report's records refer to by ID alone: as space/slug, the other unit of each conflict, each Link's upstream unit and each merge source; by slug, or space/slug in another Space, each Release's Target and the ReviewThread's ChangeOrder; and by username, the author of each comment of the ReviewThread. */
9040
9060
  Names?: {
9041
9061
  [key: string]: string;
9042
9062
  };
@@ -9044,6 +9064,10 @@ interface components {
9044
9064
  ReleaseMessage?: string;
9045
9065
  /** @description Whether the unit's last Release includes the value: Released, NeverReleased, ChangedSinceRelease, or NothingToRelease in a Space with no release Target. Absent for a field the unit does not have. */
9046
9066
  ReleaseState?: string;
9067
+ /** @description The thread of ReviewComments about the field that was commented in most recently: those naming its resource and path, the path as written or naming the same element. Absent when there is none. */
9068
+ ReviewThread?: components["schemas"]["BlameReviewThread"];
9069
+ /** @description How many threads of ReviewComments are about the field, ReviewThread among them. */
9070
+ ReviewThreads?: number;
9047
9071
  };
9048
9072
  UnitProtectionRequest: {
9049
9073
  /** @description Recorded on the Revision the edit creates. Defaults to "Set path protection". */
@@ -9173,7 +9197,7 @@ interface components {
9173
9197
  Slug?: string;
9174
9198
  };
9175
9199
  UploadLinkResult: {
9176
- /** @description Create or Unchanged. */
9200
+ /** @description Create, Update (a Link an earlier upload created that is cleared for less than it now needs: a Link from a carrier's placeholder Unit is cleared for the Link=Upsert guard of the ConfigMaps rendered into it), or Unchanged. */
9177
9201
  Action?: string;
9178
9202
  Error?: components["schemas"]["ResponseError"];
9179
9203
  FromUnit?: string;
@@ -9294,7 +9318,7 @@ interface components {
9294
9318
  Units?: components["schemas"]["UploadUnitResult"][];
9295
9319
  };
9296
9320
  UploadTriggerResult: {
9297
- /** @description Create (in the Space, which runs the Triggers defined in it), Unchanged (the Space already runs a Mutation Trigger with the function, or one with the slug is in the Space), or Missing (the Space selects its Triggers from elsewhere, and none it selects runs the function). */
9321
+ /** @description Create (in the Space, which runs the Triggers defined in it), Update (a Trigger of the pack that an earlier upload created in the Space, which gets the guards and clearance the pack now states), Unchanged (the Space already runs a Mutation Trigger with the function, or one with the slug is in the Space), or Missing (the Space selects its Triggers from elsewhere, and none it selects runs the function). */
9298
9322
  Action?: string;
9299
9323
  Error?: components["schemas"]["ResponseError"];
9300
9324
  /** @description The function the Trigger runs. */
package/dist/index.d.ts CHANGED
@@ -2766,7 +2766,7 @@ interface paths {
2766
2766
  };
2767
2767
  /**
2768
2768
  * Get everything recorded about one field of a Unit
2769
- * @description Returns everything recorded about one field of a Unit's configuration: the field as the Unit's blame reports it, its own annotations, whether the Unit's last Release includes its value, and each change from this Unit out to where the value was set with the Mutation and Revision it was read from. With history, it also returns every change the Unit recorded to the field. A field that names nothing is a 404; one that names several fields, or a value holding several, is a 400 whose message lists them.
2769
+ * @description Returns everything recorded about one field of a Unit's configuration: the field as the Unit's blame reports it, its own annotations, whether the Unit's last Release includes its value, each change from this Unit out to where the value was set with the Mutation and Revision it was read from, the comments the configuration has about the field, and the latest thread of ReviewComments about it. With history, it also returns every change the Unit recorded to the field. A field that names nothing is a 404; one that names several fields, or a value holding several, is a 400 whose message lists them.
2770
2770
  */
2771
2771
  get: operations["GetUnitPath"];
2772
2772
  put?: never;
@@ -4073,6 +4073,14 @@ interface components {
4073
4073
  ProvidedResource?: components["schemas"]["ResourceInfo"];
4074
4074
  };
4075
4075
  BindingList: components["schemas"]["Binding"][];
4076
+ BlameConfigComments: {
4077
+ /** @description The comment on the lines below the field. */
4078
+ Foot?: string;
4079
+ /** @description The comment on the lines above the field. On the row about a resource as a whole, the comment above the resource's document separator. */
4080
+ Head?: string;
4081
+ /** @description The comment at the end of the field's line. */
4082
+ Line?: string;
4083
+ };
4076
4084
  BlameConflictDismissal: {
4077
4085
  /** @description For a dismissal of what one guard withheld, the guard's key. */
4078
4086
  Guard?: string;
@@ -4293,6 +4301,16 @@ interface components {
4293
4301
  /** @description The value the change recorded for the field. Returned in History. */
4294
4302
  Value?: string;
4295
4303
  };
4304
+ BlameReviewThread: {
4305
+ /**
4306
+ * Format: uuid
4307
+ * @description The ChangeOrder the thread was made in review of, if any; the report's Names names it, unless it cannot be read.
4308
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4309
+ */
4310
+ ChangeOrderID?: string;
4311
+ /** @description The comment that started the thread, then its replies, replies to replies included, oldest first. Hidden comments are left out; a thread whose first comment is hidden still has its replies. The report's Names names each comment's author by UserID, unless the author cannot be read. */
4312
+ Comments?: components["schemas"]["ReviewComment"][] | null;
4313
+ };
4296
4314
  BlameValidation: {
4297
4315
  /** @description The result's free-text messages, where the function gave no Issues. */
4298
4316
  Details?: string[];
@@ -9030,13 +9048,15 @@ interface components {
9030
9048
  };
9031
9049
  /** @description The field's chain: the changes that put the value here, from this unit out to where it was set, each with the Mutation and Revision it was read from. */
9032
9050
  Changes?: components["schemas"]["BlamePathChange"][];
9051
+ /** @description The comments the unit's configuration has about the field: above it, at the end of its line, and below it. Absent when it has none. */
9052
+ ConfigComments?: components["schemas"]["BlameConfigComments"];
9033
9053
  /** @description Every conflict dismissal covering the field, each with the Path it is recorded at: the field's, a pattern naming it, or empty for one on its resource as a whole. */
9034
9054
  ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
9035
9055
  /** @description The field, as the unit's blame reports it, without its Chain: Changes carries the chain with its records. */
9036
9056
  Field?: components["schemas"]["BlameField"];
9037
9057
  /** @description Every change this unit recorded to the field, oldest first; returned when history is requested. */
9038
9058
  History?: components["schemas"]["BlamePathChange"][];
9039
- /** @description Names, as space/slug, of the Units and Targets the report's records refer to by ID alone: the other unit of each conflict, each Link's upstream unit, each merge source, and each Release's Target. */
9059
+ /** @description Names of the entities the report's records refer to by ID alone: as space/slug, the other unit of each conflict, each Link's upstream unit and each merge source; by slug, or space/slug in another Space, each Release's Target and the ReviewThread's ChangeOrder; and by username, the author of each comment of the ReviewThread. */
9040
9060
  Names?: {
9041
9061
  [key: string]: string;
9042
9062
  };
@@ -9044,6 +9064,10 @@ interface components {
9044
9064
  ReleaseMessage?: string;
9045
9065
  /** @description Whether the unit's last Release includes the value: Released, NeverReleased, ChangedSinceRelease, or NothingToRelease in a Space with no release Target. Absent for a field the unit does not have. */
9046
9066
  ReleaseState?: string;
9067
+ /** @description The thread of ReviewComments about the field that was commented in most recently: those naming its resource and path, the path as written or naming the same element. Absent when there is none. */
9068
+ ReviewThread?: components["schemas"]["BlameReviewThread"];
9069
+ /** @description How many threads of ReviewComments are about the field, ReviewThread among them. */
9070
+ ReviewThreads?: number;
9047
9071
  };
9048
9072
  UnitProtectionRequest: {
9049
9073
  /** @description Recorded on the Revision the edit creates. Defaults to "Set path protection". */
@@ -9173,7 +9197,7 @@ interface components {
9173
9197
  Slug?: string;
9174
9198
  };
9175
9199
  UploadLinkResult: {
9176
- /** @description Create or Unchanged. */
9200
+ /** @description Create, Update (a Link an earlier upload created that is cleared for less than it now needs: a Link from a carrier's placeholder Unit is cleared for the Link=Upsert guard of the ConfigMaps rendered into it), or Unchanged. */
9177
9201
  Action?: string;
9178
9202
  Error?: components["schemas"]["ResponseError"];
9179
9203
  FromUnit?: string;
@@ -9294,7 +9318,7 @@ interface components {
9294
9318
  Units?: components["schemas"]["UploadUnitResult"][];
9295
9319
  };
9296
9320
  UploadTriggerResult: {
9297
- /** @description Create (in the Space, which runs the Triggers defined in it), Unchanged (the Space already runs a Mutation Trigger with the function, or one with the slug is in the Space), or Missing (the Space selects its Triggers from elsewhere, and none it selects runs the function). */
9321
+ /** @description Create (in the Space, which runs the Triggers defined in it), Update (a Trigger of the pack that an earlier upload created in the Space, which gets the guards and clearance the pack now states), Unchanged (the Space already runs a Mutation Trigger with the function, or one with the slug is in the Space), or Missing (the Space selects its Triggers from elsewhere, and none it selects runs the function). */
9298
9322
  Action?: string;
9299
9323
  Error?: components["schemas"]["ResponseError"];
9300
9324
  /** @description The function the Trigger runs. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.11.0",
3
+ "version": "0.11.1",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {