The Wayback Machine - https://web.archive.org/web/20210105055435/https://github.com/api-platform/docs/issues/868
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 a reference of all built-in attributes #868

Open
dunglas opened this issue Sep 5, 2019 · 1 comment
Open

Add a reference of all built-in attributes #868

dunglas opened this issue Sep 5, 2019 · 1 comment

Comments

@dunglas
Copy link
Member

@dunglas dunglas commented Sep 5, 2019

All built-in attributes should be listed and documented on https://github.com/api-platform/docs/blob/2.4/core/configuration.md

The full list of built-in attributes is available in the annotations: https://github.com/api-platform/core/tree/master/src/Annotation

For every attribute in the annotations, we should also add link to the corresponding documentation on the website (discoverability in PHPStorm and the like).

The best would be to create a script to automatically extract the full list of attributes from annotations to markdown. The corresponding YAML and XML config could also be automatically generated. The regeneration of the current YAML configuration could also be scripted (Symfony provides a command to extract the shape of configuration, it's already what we use to update manually this page).

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.