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 documentation for how to access path keys in a resource method (especially entity-level Actions) #605

Open
evanw555 opened this issue Apr 23, 2021 · 0 comments
Labels
documentation Documentation errors or suggestions (https://rest.li/)

Comments

@evanw555
Copy link
Contributor

There isn't any documentation on how to use annotations like \@PathKeyParam and \@PathKeysParam, it seems like most users onboard to this functionality by following existing examples (almost all of which only use \@PathKeysParam).

This is especially critical for the entity-level Action resource method use case, which requires usage of this feature. We've had numerous customers ask us how an Action resource method can access the Collection key. This requires setting the Action method to an ENTITY-level Action, and then using either of the two annotations specified above.

Our documentation says nothing about this, yet it should.

@evanw555 evanw555 added the documentation Documentation errors or suggestions (https://rest.li/) label Apr 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation errors or suggestions (https://rest.li/)
Projects
None yet
Development

No branches or pull requests

1 participant