Add mount path into the default generated openapi.json spec (UI) #17926
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
averche
force-pushed
the
ui/mount-paths
branch
from
20e5cfd to
a760ab7
Compare
averche
force-pushed
the
ui/mount-paths
branch
from
2f5d20e to
202efee
Compare
hashishaw
reviewed
Dec 6, 2022
| const pathInfo = help.openapi.paths[path]; | ||
| const params = pathInfo.parameters; | ||
| const paramProp = {}; | ||
|
|
||
| // include url params | ||
| if (params) { | ||
| const { name, schema, description } = params[0]; |
There was a problem hiding this comment.
This is the crux of the change that fixes the UI issues. Before, we only cared about the first param for the path. Now that the backend mount path is also a path param, we instead iterate over all the path params, throw out _mount_path (because we already capture it as backend) and add the rest to the model
hashishaw
reviewed
Dec 6, 2022
ui/app/services/path-help.js
Outdated
| @@ -295,7 +299,8 @@ export default Service.extend({ | |||
| }, | |||
|
|
|||
| registerNewModelWithProps(helpUrl, backend, newModel, modelName) { | |||
| return this.getProps(helpUrl, backend).then((props) => { | |||
| const pathName = modelName === 'model:generated-user-userpass' ? '/users/{username}' : ''; | |||
There was a problem hiding this comment.
This might not actually be needed, checking now
|
Thank you for fixing the UI parts, @chelshaw! |
dhuckins
approved these changes
Dec 7, 2022
maxb
added a commit
to maxb/vault
that referenced
this pull request
Dec 27, 2022
PR hashicorp#17926 already deleted the implementation of the `generic_mount_paths` field so it needs to be removed from the declared fields of the path too, so help and OpenAPI isn't misleading.
averche
pushed a commit
that referenced
this pull request
Jan 4, 2023
averche
added a commit
that referenced
this pull request
Jan 10, 2023
AnPucel
pushed a commit
that referenced
this pull request
Jan 14, 2023
AnPucel
pushed a commit
that referenced
this pull request
Jan 14, 2023
AnPucel
pushed a commit
that referenced
this pull request
Jan 14, 2023
AnPucel
pushed a commit
that referenced
this pull request
Feb 3, 2023
AnPucel
pushed a commit
that referenced
this pull request
Feb 3, 2023
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.
The current behaviour is to only add mount paths into the generated
opeanpi.jsonspec if ageneric_mount_pathsflag is added to the request. This means that we would have to maintain two differentopenapi.jsonfiles, which is not ideal. The new solution in this PR is to add{<mount>_mount_path}into every path with a default value specified:Additionally, fixed the logic to generate the
operationId(used to generate method names in the code generated from OpenAPI spec). It had a bug where the ID hadmountPathin it.