Repository navigation
The published /v1 OpenAPI document differs from openapi/v1.json #210
Description
The published /v1 OpenAPI document differs in content from the vendored openapi/v1.json. Key order and whitespace are not compared.
| Published document | openapi/v1.json |
|
|---|---|---|
info.version |
2026-10-25 |
2026-10-19 |
| SHA-256 | 26e5a79d4669eaa3394c9917e66d56af546fc861d6576af1d6caada37c9c3458 |
8c9a44bc696584105f10b67d490a8816dabc26b07b80ed18369e6d3e498359c4 |
Breaking changes, according to oasdiff
- From
openapi/v1.jsonto the published document (a client built from the vendored copy may fail against the published one): yes, 3 breaking change(s) - From the published document to
openapi/v1.json(a client built from the published document may fail against the vendored copy): yes, 6 breaking change(s)
Breaking changes from openapi/v1.json to the published document
GET /v1/alerts: the response property `pagination/page` became optional for the status `200`
GET /v1/alerts: the response property `pagination/total` became optional for the status `200`
GET /v1/alerts: the response property `pagination/total_pages` became optional for the status `200`
Breaking changes from the published document to openapi/v1.json
GET /v1/alerts: removed the enum value `updated_at` from the `query` request parameter `sort`
GET /v1/alerts: removed the required property `data/items/updated_at` from the response with the `200` status
GET /v1/alerts: removed the required property `pagination/next_cursor` from the response with the `200` status
GET /v1/alerts/{id}: removed the required property `data/updated_at` from the response with the `200` status
GET /v1/me: removed the required property `data/beta` from the response with the `200` status
GET /v1/me: removed the required property `data/user` from the response with the `200` status
Summary, published to vendored
diff: true
details:
endpoints:
modified: 3
paths:
modified: 3
Changelog, published to vendored
12 changes: 6 error, 2 warning, 4 info
error [request-parameter-enum-value-removed] at vendored.json
in API GET /v1/alerts
removed the enum value `updated_at` from the `query` request parameter `sort`
error [response-required-property-removed] at vendored.json
in API GET /v1/alerts
removed the required property `data/items/updated_at` from the response with the `200` status
error [response-required-property-removed] at vendored.json
in API GET /v1/alerts
removed the required property `pagination/next_cursor` from the response with the `200` status
error [response-required-property-removed] at vendored.json
in API GET /v1/alerts/{id}
removed the required property `data/updated_at` from the response with the `200` status
error [response-required-property-removed] at vendored.json
in API GET /v1/me
removed the required property `data/beta` from the response with the `200` status
error [response-required-property-removed] at vendored.json
in API GET /v1/me
removed the required property `data/user` from the response with the `200` status
warning [request-parameter-removed] at vendored.json
in API GET /v1/alerts
deleted the `query` request parameter `cursor`
This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.
warning [request-parameter-removed] at vendored.json
in API GET /v1/alerts
deleted the `query` request parameter `updated_since`
This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.
info [request-parameter-default-value-added] at vendored.json
in API GET /v1/alerts
for the `query` request parameter `page`, default value `1.00` was added
info [response-property-became-required] at vendored.json
in API GET /v1/alerts
the response property `pagination/page` became required for the status `200`
info [response-property-became-required] at vendored.json
in API GET /v1/alerts
the response property `pagination/total` became required for the status `200`
info [response-property-became-required] at vendored.json
in API GET /v1/alerts
the response property `pagination/total_pages` became required for the status `200`
The vendored document is not updated automatically. Decide whether the API or the vendored copy is behind, then fix that side.
Reported by the OpenAPI sync workflow: https://github.com/Hodeitek/hodeishield-cli/actions/runs/39204728778
Activity
d0ubl3g commentedon Oct 19, 2026
Impact on the released 0.5.1: none found. In page mode, which is all 0.5.1 uses (it never sends
cursor), the published API still returnspage,per_page,totalandtotal_pages, and now alsonext_cursor. Only cursor mode leaves the totals out. The generated API types in 0.5.1 do not reject unknown fields (deny_unknown_fieldsis used only for the CLI configuration file), so the extranext_cursoris ignored andalerts listkeeps working. The client now follows the 2026-10-25 document (#213, indev); this issue closes when that reaches a release.github-actions commentedon Oct 26, 2026
The published document and openapi/v1.json match again.