Skip to content

Custom annotations for description extender #10

Description

@nandorholozsnyak

Is your feature request related to a problem? Please describe.
Most of the time, developers are not willing to write the proper description for their operations, and it makes the API documentation week. It is hard to determine what will happen on calling, but there are typical endpoints like query endpoints (GET or POST) that returns data based on different predicates or endpoints that are creating resources on the server.

With the query endpoints different annotations could be introduced to make sure that the fields are annotated with the predicate types (FULL_EQUALITY, PARTIAL, GREATER_THAN, GREATER, LESS_THAN, LESS etc) to make sure those information will end up for the end users too.

TODO: Finish the idea properly.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

enhancementNew feature or requestnew-featureNon existing feature request or proposal

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions