[6/6] [nexus] convert external API to trait#6373
Merged
sunshowers merged 6 commits intoAug 28, 2024
Merged
Conversation
Created using spr 1.3.6-beta.1 [skip ci]
Created using spr 1.3.6-beta.1
sunshowers
changed the title
Contributor
|
10 seconds! Great! 
|
sunshowers
commented
Aug 17, 2024
| // a function name is a breaking change from a client perspective. | ||
|
|
||
| #[dropshot::api_description { | ||
| tag_config = { |
Contributor
Author
There was a problem hiding this comment.
The tag config is now defined here.
|
|
||
| pub const API_VERSION: &str = "20240821.0"; | ||
|
|
||
| // API ENDPOINT FUNCTION NAMING CONVENTIONS |
Contributor
Author
There was a problem hiding this comment.
Moved the function naming doc here because this is the canonical place for OpenAPI definitions.
sunshowers
commented
Aug 17, 2024
sunshowers
added a commit
that referenced
this pull request
Aug 21, 2024
With the Nexus external API, the validator generates a `nexus_tags.txt` file that must be kept track of. Instead of the validation function simply erroring out if the file is different, it is a better experience for users if it records what it expects the file to be, and then the OpenAPI manager simply treats it as an extra file similar to the document itself. With this pattern, the check and generate functions can both work on the extra file just like they work on the document. In order for the there to be a richer protocol for validation, the interface needs to be split into its own crate. This way, the API crates can depend on this minimal interface, and the OpenAPI manager itself can depend on the API crates. This isn't used yet, but will be in #6373.
andrewjstone
approved these changes
Aug 27, 2024
sunshowers
changed the base branch from
sunshowers/spr/main.nexus-convert-external-api-to-trait
to
main
Created using spr 1.3.6-beta.1
Contributor
Author
|
This should be all good to go -- going to land this tomorrow morning. |
Contributor
Author
|
GitHub recognizes the ignore-revs file.
|
Contributor
Author
|
Haha thanks @david-crespo! |
sunshowers
deleted the
sunshowers/spr/nexus-convert-external-api-to-trait
branch
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
3 participants
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.
At long last, here's the last OpenAPI document converted into a trait: the
Nexus external API. This is a fairly large change, but with all the
prerequisites in place the conversion is overall pretty mechanical. I did need
to move some types around, but the bulk of the PR is just adding the very large
external API trait.
This PR also adds a
.git-blame-ignore-revsentry corresponding to #6372, so that the indent doesn't ruin blame in the GitHub web view. (You can configure this locally as well withgit config blame.ignoreRevsFile .git-blame-ignore-revs.)In a subsequent PR I'll remove the old instructions.
Depends on: