Repository navigation
[dpd-api] add an openapi-lint-clean API version - #418
Merged
sunshowers merged 1 commit intoNov 9, 2026
Merged
sunshowers merged 1 commit into
sunshowers merged 1 commit into
Conversation
Going to add openapi-lint to the next commit. Fix up some lint issues
identified by it. In the newly added version:
* Enum values and object properties are snake_case (for example,
`PortSpeed::Speed100G` is "speed100_g", and `PortFec::RS` is "rs").
* `LinkState` and `IpSrc` are adjacently tagged.
* `FecRSCounters` and `LinkFecRSCounters` are renamed to `FecRsCounters` and
`LinkFecRsCounters`, respectively.
* The NAT address lists return `NatIpv4Address` and `NatIpv6Address` objects
(`{"address": ...}`) rather than bare addresses, matching how omicron pages
over named item types. A page of bare addresses is named after the std type's
schema (`ipv4ResultsPage`), which isn't PascalCase.
* Path components are kebab-case.
* `nat_trigger_update` returns 204 No Content instead of a JSON null.
The on-disk port config keeps its existing format by using the v13
LinkCreate to do parsing with.
ahl
approved these changes
Nov 9, 2026
| @@ -495,10 +495,10 @@ | |||
| "content": { | |||
| "application/json": { | |||
| "schema": { | |||
| "title": "Array_of_LinkFecRSCounters", | |||
Contributor
There was a problem hiding this comment.
I assume it's outside of scope here to paginate or fake paginate
Contributor
Author
There was a problem hiding this comment.
Yeah probably a followup if we'd like to do that.
sunshowers
deleted the
jj-stack/dpd-api-add-an-openapi-lint-clean-api-version-mnykwnzo
branch
November 9, 2026 19:06
This was referenced Nov 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Going to add openapi-lint to the next commit. Fix up some lint issues identified by it. In the newly added version:
PortSpeed::Speed100Gis "speed100_g", andPortFec::RSis "rs").LinkStateandIpSrcare adjacently tagged.FecRSCountersandLinkFecRSCountersare renamed toFecRsCountersandLinkFecRsCounters, respectively.NatIpv4AddressandNatIpv6Addressobjects ({"address": ...}) rather than bare addresses, matching how omicron pages over named item types. A page of bare addresses is named after the std type's schema (ipv4ResultsPage), which isn't PascalCase.nat_trigger_updatereturns 204 No Content instead of a JSON null.The on-disk port config keeps its existing format by using the v13 LinkCreate to do parsing with.