You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Does GraphQLite support outputting descriptions for fields? I'm not seeing this currently, or how this might work. I realize that the docblock comment is used in other cases - think this is a bad idea too, for the most part, since it can expose internals, particularly on models. And, the descriptions don't make a lot of sense.
So, I guess I'd like to find out what the plan is on the above. It'd be nice to have another arg added to the Field annotation that supports a description. But, overall, I think the lib needs to define how to go about properly documenting the full API. Part of the beauty of GraphQL is that the schema can act as a replacement for something like Swagger. I'd love to be able to leverage the schema more for this purpose.
The text was updated successfully, but these errors were encountered:
oojacoboo
changed the title
Field descriptions for schema
Schema documentation (field descriptions, etc.)
Jul 24, 2020
I think we can safely close this.
The "description" attribute was added to @field and if not present, the text from the PHPDoc is used.
This is documented in the annotation reference page.
Does GraphQLite support outputting descriptions for fields? I'm not seeing this currently, or how this might work. I realize that the docblock comment is used in other cases - think this is a bad idea too, for the most part, since it can expose internals, particularly on models. And, the descriptions don't make a lot of sense.
So, I guess I'd like to find out what the plan is on the above. It'd be nice to have another arg added to the
Field
annotation that supports adescription
. But, overall, I think the lib needs to define how to go about properly documenting the full API. Part of the beauty of GraphQL is that the schema can act as a replacement for something like Swagger. I'd love to be able to leverage the schema more for this purpose.The text was updated successfully, but these errors were encountered: