Skip to content

Add a reference of all built-in attributes #868

Closed
@dunglas

Description

@dunglas

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).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions