casbin-website-v2 icon indicating copy to clipboard operation
casbin-website-v2 copied to clipboard

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

Open hsluoyz opened this issue 3 years ago • 6 comments

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

hsluoyz avatar Oct 19 '22 00:10 hsluoyz

@tangyang9464 @JalinWang @imp2002

casbin-bot avatar Oct 19 '22 00:10 casbin-bot

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

rajivharlalka avatar Dec 14 '22 12:12 rajivharlalka

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

hsluoyz avatar Dec 14 '22 13:12 hsluoyz

@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

rajivharlalka avatar Dec 16 '22 15:12 rajivharlalka

Finally all will be added, can start from Go

hsluoyz avatar Dec 16 '22 16:12 hsluoyz

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

rajivharlalka avatar Dec 17 '22 15:12 rajivharlalka