Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed unpublished:true for sys/internal/* endpoints #12713

Merged
merged 5 commits into from Oct 15, 2021

Conversation

saltperfect
Copy link
Contributor

@saltperfect saltperfect commented Oct 2, 2021

Fixes: #12282

Removed Unpublished true to make open api spec consistent with documentation.
Namely internal/ui/namespaces, internal/ui/resultant-acl, internal/counters/requests, internal/counters/tokens, internal/counters/entities

Useful Links

  1. https://www.vaultproject.io/api-docs/system/internal-counters
  2. https://github.com/hashicorp/vault/blob/main/vault/logical_system_paths.go

@hashicorp-cla
Copy link

hashicorp-cla commented Oct 2, 2021

CLA assistant check
All committers have signed the CLA.

@vercel vercel bot temporarily deployed to Preview – vault October 2, 2021 06:48 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 2, 2021 06:48 Inactive
@saltperfect saltperfect changed the title Fixes https://github.com/hashicorp/vault/issues/12282 Removed unpublished:true for sys/internal/* endpoints Removed unpublished:true for sys/internal/* endpoints Oct 2, 2021
@vercel vercel bot temporarily deployed to Preview – vault October 2, 2021 06:52 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 2, 2021 06:52 Inactive
@hghaf099
Copy link
Contributor

hghaf099 commented Oct 4, 2021

@saltperfect Thanks for submitting this PR. Would you please add the changelog text file related to this change as well? Also, if you would please add some documentation on those unpublished endpoints, that would be great. We don't need thorough docs on those, just something to acknowledge their existence would suffice for now. With those changes, we can go ahead and merge this PR.

changelog/_12713.txt Outdated Show resolved Hide resolved
@@ -0,0 +1,3 @@
```release-note:bug
COMPONENT: removed unpublished true from logical_system path, making openapi spec consistent with documentation
Copy link
Contributor

Choose a reason for hiding this comment

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

the name of the file contains an "_", please remove it.

@vercel vercel bot temporarily deployed to Preview – vault October 5, 2021 12:15 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 5, 2021 12:15 Inactive
@saltperfect
Copy link
Contributor Author

I have edited 5 entries in logical_paths_system.go

internal/ui/namespaces, internal/ui/resultant-acl, internal/counters/requests, internal/counters/tokens, internal/counters/entities.

For now I have put in a really dumb entry for Summary. Let me know if this works.

@hghaf099
Copy link
Contributor

hghaf099 commented Oct 6, 2021

Please remove the summary and add two mdx files for internal/ui/namespaces and internal/ui/resultant-acl as the other three already have docs. We don't need fancy docs on these two, we just want to capture their existence. For those, please follow the pattern used in docs for https://github.com/hashicorp/vault/blob/main/website/content/api-docs/system/internal-ui-feature.mdx

@saltperfect
Copy link
Contributor Author

Please remove the summary and add two mdx files for internal/ui/namespaces and internal/ui/resultant-acl as the other three already have docs. We don't need fancy docs on these two, we just want to capture their existence. For those, please follow the pattern used in docs for https://github.com/hashicorp/vault/blob/main/website/content/api-docs/system/internal-ui-feature.mdx

I have added the two mdx files. I have kept it quite similar. Please let me know if any changes required.

@hghaf099
Copy link
Contributor

@saltperfect Thank you very much for adding the docs. Seems like the deployment check failed since the added new endpoints mdx files, are not reflected in the api docs nav data file located here:
https://github.com/hashicorp/vault/blob/main/website/data/api-docs-nav-data.json
Would you please update that file as well with the new entries?

Copy link
Contributor

@taoism4504 taoism4504 left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove 'Unpublished: true' inconsistently applied to sys/internal/* endpoints
5 participants