From ad21bc6f2d8981085a0dfd3fec3faa64de60ff57 Mon Sep 17 00:00:00 2001 From: alrayyes <511318+alrayyes@users.noreply.github.com> Date: Thu, 19 Nov 2026 16:55:16 +0000 Subject: [PATCH] fix: regenerate client from updated forge-dashboard spec --- openapi/SPEC_COMMIT | 2 +- openapi/openapi.yaml | 34 +++++++++++++------ .../_generated/models/issue_details.py | 27 ++++++++++----- .../_generated/models/item_reference.py | 5 ++- 4 files changed, 48 insertions(+), 20 deletions(-) diff --git a/openapi/SPEC_COMMIT b/openapi/SPEC_COMMIT index cbc5d1f..42ec55f 100644 --- a/openapi/SPEC_COMMIT +++ b/openapi/SPEC_COMMIT @@ -1 +1 @@ -09b6a56224f78d418ae63daf0120b134b34be455 +50540a9c6bb9124f62060e19627d0e72f1c8d938 diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml index 322cb25..eb87455 100644 --- a/openapi/openapi.yaml +++ b/openapi/openapi.yaml @@ -5862,18 +5862,29 @@ components: description: True when `commentCount` is more than the comments returned. references: type: array - maxItems: 50 + maxItems: 70 items: $ref: "#/components/schemas/ItemReference" description: | - The items that refer to this one, as the forge's own timeline - records them, newest first, at most the first 50. They are read - from the forge, so a closed or merged item shows them as well as an - open one: the board's own pills list open pull requests only. An - empty array means nothing refers to it. Only the entries whose - `direction` is `incoming` are returned for now; `outgoing` is part - of the contract so a later release can add what this item refers - to without another change. + The items related to this one, incoming first and then outgoing. + An empty array means nothing is related. A closed or merged item + has them as well as an open one: the board's own pills list open + pull requests only. + + The `incoming` entries are the items that refer to this one, as + the forge's own timeline records them, newest first, at most the + first 50. + + The `outgoing` entries are the items this one's own title and + description refer to, in the order the text names them (closing + ones first, then references, then mentions), at most 20. The + forge records only what refers to an item, so the text is read + the way the board reads a pull request's and each named item is + looked up for its title and state. An item that can't be read + (missing, no access) is left out, and a lookup that fails leaves + the outgoing entries out without failing the read. A closing + keyword counts as `closes` only in a pull request, and the base + branch isn't checked; in an issue it is a `mentions`. ItemReference: type: object @@ -5925,7 +5936,10 @@ components: enum: [incoming, outgoing] description: | `incoming` when the related item refers to the asked-for one, - `outgoing` when the asked-for one refers to it. + `outgoing` when the asked-for one refers to it. The `relation` is + always the referring item's: what the related item does to the + asked-for one when `incoming`, what the asked-for one does to the + related item when `outgoing`. relation: type: string enum: [closes, refs, mentions] diff --git a/src/forge_dashboard/_generated/models/issue_details.py b/src/forge_dashboard/_generated/models/issue_details.py index f364c0f..749fa89 100644 --- a/src/forge_dashboard/_generated/models/issue_details.py +++ b/src/forge_dashboard/_generated/models/issue_details.py @@ -44,14 +44,25 @@ class IssueDetails: comments (list[DetailsComment]): The conversation, oldest first, at most the first 50. comment_count (int): How many comments the forge has on the issue. comments_truncated (bool): True when `commentCount` is more than the comments returned. - references (list[ItemReference]): The items that refer to this one, as the forge's own timeline - records them, newest first, at most the first 50. They are read - from the forge, so a closed or merged item shows them as well as an - open one: the board's own pills list open pull requests only. An - empty array means nothing refers to it. Only the entries whose - `direction` is `incoming` are returned for now; `outgoing` is part - of the contract so a later release can add what this item refers - to without another change. + references (list[ItemReference]): The items related to this one, incoming first and then outgoing. + An empty array means nothing is related. A closed or merged item + has them as well as an open one: the board's own pills list open + pull requests only. + + The `incoming` entries are the items that refer to this one, as + the forge's own timeline records them, newest first, at most the + first 50. + + The `outgoing` entries are the items this one's own title and + description refer to, in the order the text names them (closing + ones first, then references, then mentions), at most 20. The + forge records only what refers to an item, so the text is read + the way the board reads a pull request's and each named item is + looked up for its title and state. An item that can't be read + (missing, no access) is left out, and a lookup that fails leaves + the outgoing entries out without failing the read. A closing + keyword counts as `closes` only in a pull request, and the base + branch isn't checked; in an issue it is a `mentions`. pull_request (IssuePullRequest | Unset): Present only when `kind` is `pullRequest`: what the header of a pull request needs when the board has no row for it, because it is closed, merged or in a repository the board doesn't track. The dialog words it. diff --git a/src/forge_dashboard/_generated/models/item_reference.py b/src/forge_dashboard/_generated/models/item_reference.py index a68364c..68cbff8 100644 --- a/src/forge_dashboard/_generated/models/item_reference.py +++ b/src/forge_dashboard/_generated/models/item_reference.py @@ -40,7 +40,10 @@ class ItemReference: state (ItemReferenceState): Where the related item stands. Only a pull request is `merged`; `closed` means closed without merging. direction (ItemReferenceDirection): `incoming` when the related item refers to the asked-for one, - `outgoing` when the asked-for one refers to it. + `outgoing` when the asked-for one refers to it. The `relation` is + always the referring item's: what the related item does to the + asked-for one when `incoming`, what the asked-for one does to the + related item when `outgoing`. relation (ItemReferenceRelation): What the referring item does to the referred-to one. `closes` closes it when merged (a closing keyword). `refs` references it without closing it (`Refs`, `Related to`, `See`). `mentions` only