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

[docs] Add example return values to all APIs in API reference pages #106

Open
hsluoyz opened this issue Oct 19, 2022 · 6 comments · May be fixed by #125
Open

[docs] Add example return values to all APIs in API reference pages #106

hsluoyz opened this issue Oct 19, 2022 · 6 comments · May be fixed by #125
Assignees
Labels
enhancement New feature or request

Comments

@hsluoyz
Copy link
Member

hsluoyz commented Oct 19, 2022

Would be clearer if outputs are also shown along with the method calls in the ApI reference

Add example return values to all APIs in https://casbin.io/docs/management-api and https://casbin.io/docs/rbac-api

image

@casbin-bot
Copy link
Member

@casbin-bot casbin-bot added the enhancement New feature or request label Oct 19, 2022
@hsluoyz hsluoyz changed the title Add example return values to all APIs in API reference pages [docs] Add example return values to all APIs in API reference pages Oct 19, 2022
@rajivharlalka
Copy link

@hsluoyz I would like to take up this issue, can you please assign it to me.

@hsluoyz
Copy link
Member Author

hsluoyz commented Dec 14, 2022

@rajivharlalka we don't usually assign people but you can work on it

@rajivharlalka
Copy link

@hsluoyz Does adding an example return value only for Go(the default language selected) works, or does it need to be there for all languages

@hsluoyz
Copy link
Member Author

hsluoyz commented Dec 16, 2022

Finally all will be added, can start from Go

@rajivharlalka rajivharlalka linked a pull request Dec 17, 2022 that will close this issue
2 tasks
@rajivharlalka
Copy link

@hsluoyz Had added some return values, could you confirm if the format works, and would add more in same format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants