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

Add status enum docs to Admin endpoint #4194

Merged
merged 1 commit into from
Aug 5, 2022
Merged

Add status enum docs to Admin endpoint #4194

merged 1 commit into from
Aug 5, 2022

Conversation

mheap
Copy link
Member

@mheap mheap commented Aug 5, 2022

Summary

Resolves #3862

This will likely need porting in to 3.0 too

Reason

Help users understand the available statuses in the admin list endpoint. Values taken from https://github.com/Kong/kong-ee/blob/master/kong/enterprise_edition/dao/enums.lua#L12-L19

Testing

/gateway/2.8.x/admin-api/admins/reference/#list-admins

@mheap mheap added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Aug 5, 2022
@mheap mheap requested a review from a team as a code owner August 5, 2022 11:13
@netlify
Copy link

netlify bot commented Aug 5, 2022

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 455f2c2
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/62ecfb4311c2d6000a03dd9a
😎 Deploy Preview https://deploy-preview-4194--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Guaris
Copy link
Contributor

Guaris commented Aug 5, 2022

#4198
3.0 PR here.

@mheap mheap merged commit 5639be8 into main Aug 5, 2022
@mheap mheap deleted the admin-status-docs branch August 5, 2022 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Encoded values should have these values documented.
2 participants