[meta] update docs for API traits #6486
Merged
Conversation
This file contains 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
Created using spr 1.3.6-beta.1
sunshowers
commented
Aug 29, 2024
Comment on lines
-282
to
-300
| // 2. Add the new kind to <repo root>/clients/src/lib.rs. | ||
| // The mapping from `UpdateArtifactKind::*` to `types::UpdateArtifactKind::*` | ||
| // must be left as a `todo!()` for now; `types::UpdateArtifactKind` will not | ||
| // be updated with the new variant until step 5 below. | ||
| // | ||
| // 4. Add the new kind and the mapping to its `update_artifact_kind` to | ||
| // <repo root>/nexus/db-model/src/update_artifact.rs | ||
| // | ||
| // 5. Regenerate the OpenAPI specs for nexus and sled-agent: | ||
| // | ||
| // ``` | ||
| // EXPECTORATE=overwrite cargo nextest run -p omicron-nexus -p omicron-sled-agent openapi | ||
| // ``` | ||
| // | ||
| // 6. Return to <repo root>/{nexus-client,sled-agent-client}/lib.rs from step 2 | ||
| // and replace the `todo!()`s with the new `types::UpdateArtifactKind::*` | ||
| // variant. | ||
| // | ||
| // See https://github.com/oxidecomputer/omicron/pull/2300 as an example. |
smklein
approved these changes
Aug 29, 2024
hawkw
pushed a commit
that referenced
this pull request
Aug 31, 2024
All of Omicron's OpenAPI documents have been converted over to API traits. Update our documentation to reflect that.
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.
All of Omicron's OpenAPI documents have been converted over to API traits. Update documentation to reflect that.