Skip to content

[propolis-server-api] add an openapi-lint-clean API version - #1253

Merged
sunshowers merged 1 commit into
masterfrom
jj-stack/propolis-server-api-add-an-openapi-lint-clean-api-version-myvqppon
Nov 9, 2026
Merged

sunshowers merged 1 commit into
masterfrom
jj-stack/propolis-server-api-add-an-openapi-lint-clean-api-version-myvqppon

Conversation

@sunshowers

Copy link
Copy Markdown
Contributor

Prepare to lint OpenAPI documents with openapi-lint.

Introduce the following changes in v7:

  • Enum string values become snake_case: InstanceState, InstanceStateRequested, MigrationState, and the tags of InstanceInitializationMethod, InstanceSpecStatus, and ReplacementComponent.
  • InstanceVCRReplace is renamed to InstanceVcrReplace.
  • instance_issue_crucible_snapshot_request and instance_issue_nmi return 204 No Content instead of 200 with a null body.

@sunshowers
sunshowers added this pull request to stack #1254 November 9, 2026 00:51
@sunshowers
sunshowers requested review from ahl and iximeow November 9, 2026 00:51
@sunshowers
sunshowers removed this pull request from stack #1254 November 9, 2026 01:04
@sunshowers
sunshowers changed the base branch from master to jj-stack/bump-bhyve-api-version-to-match-stlouis-llmrospv November 9, 2026 01:04
@sunshowers
sunshowers force-pushed the jj-stack/propolis-server-api-add-an-openapi-lint-clean-api-version-myvqppon branch from 795b607 to f27c9ca Compare November 9, 2026 01:04
@sunshowers
sunshowers added this pull request to stack #1256 November 9, 2026 01:04
@sunshowers

sunshowers commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor Author

Revision history

Version Changes from previous version Submitted commit
3 (current) f27c9ca9..9d3653b8 9d3653b8
2 795b607e..f27c9ca9 f27c9ca9
1 Initial version 795b607e

Generated by jj-stack from this pull request's force-push history.

Prepare to lint OpenAPI documents with openapi-lint.

Introduce the following changes in v7:

- Enum string values become snake_case: `InstanceState`,
  `InstanceStateRequested`, `MigrationState`, and the tags of
  `InstanceInitializationMethod`, `InstanceSpecStatus`, and
  `ReplacementComponent`.
- `InstanceVCRReplace` is renamed to `InstanceVcrReplace`.
- `instance_issue_crucible_snapshot_request` and `instance_issue_nmi` return
  204 No Content instead of 200 with a null body.
@sunshowers
sunshowers removed this pull request from stack #1256 November 9, 2026 01:07
@sunshowers
sunshowers changed the base branch from jj-stack/bump-bhyve-api-version-to-match-stlouis-llmrospv to master November 9, 2026 01:07
@sunshowers
sunshowers force-pushed the jj-stack/propolis-server-api-add-an-openapi-lint-clean-api-version-myvqppon branch from f27c9ca to 9d3653b Compare November 9, 2026 01:07
@sunshowers
sunshowers added this pull request to stack #1257 November 9, 2026 01:07
Comment on lines +91 to 92
use propolis_api_types::instance::ReplacementComponent;
use propolis_api_types_versions::{v1, v2, v3, v6};

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the correct way to refer to these types per RFD 619.

Comment on lines -91 to -103
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"title": "Null",
"type": "string",
"enum": [
null
]
}
}
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ugh

@sunshowers
sunshowers merged commit 24caf8a into master Nov 9, 2026
12 of 14 checks passed
@sunshowers
sunshowers deleted the jj-stack/propolis-server-api-add-an-openapi-lint-clean-api-version-myvqppon branch November 9, 2026 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants