Skip to content

[REQ] [Java-Jersey2] Include API's Http response codes and their corresponding description and response headers in the documentation #3059

@saigiridhar21

Description

@saigiridhar21

Is your feature request related to a problem? Please describe.

The possible HTTP response codes of each API method are not specified on javadocs. It is also better to include description of each response code and corresponding response headers in the documentation.
This will help the clients of library to easily go through the documentation of each API method on Eclipse's intellisense.

Describe the solution you'd like

Use javadocs custom tag and define HTTP response codes along with their corresponding description and response headers on each API method.

Describe alternatives you've considered

Additional context

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