Skip to content

Add description attribute to annotations to override PHPDoc  #453

Open
@oojacoboo

Description

@oojacoboo

Currently, the PHPDoc comment is exposed over the schema as the description. This is fine to remain. However, often there are times where internals are needed in the PHPDoc. In fact, I'd argue that the PHPDoc should really be reserved for internal documentation only. It's too easy to accidentally expose something undesired in the PHPDoc. Additionally, there isn't any way to add additional internal documentation in the PHPDoc without having it also added to the GraphQL schema.

Therefore, with the addition of a new param description on annotations, we can override whatever description is in the PHPDoc. This would maintain BC and simplicity for others, but provide a finer grained option for other cases.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions