Enunciate

Support for Response Headers

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.25
  • Fix Version/s: 1.26
  • Component/s: documentation
  • Labels:
    None
  • Number of attachments :
    0

Description

Currently the docs do not list the HeaderParams. Also, it would be nice to specify both request and response headers.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Ryan Heaton added a comment -

Request headers are being documented. Support for documentation of response headers seems reasonable. I'll take a look for 1.26.

Show
Ryan Heaton added a comment - Request headers are being documented. Support for documentation of response headers seems reasonable. I'll take a look for 1.26.
Hide
Permalink
Jason Chaffee added a comment -

Request headers are now working, but only after I added the @param in the JavaDoc.

It might be nice to still add params to the table even if they don't have JavaDoc. Perhaps, this could be a configuration option so if some people don't want certain params to show up, it doesn't change that behavior.

Show
Jason Chaffee added a comment - Request headers are now working, but only after I added the @param in the JavaDoc. It might be nice to still add params to the table even if they don't have JavaDoc. Perhaps, this could be a configuration option so if some people don't want certain params to show up, it doesn't change that behavior.
Hide
Permalink
Ryan Heaton added a comment -

I can't reproduce the report that header params without javadoc don't show up. They show up for me.

Work started on adding a new annotation, @org.codehaus.enunciate.jaxrs.ResponseHeaders, to document response headers.

Show
Ryan Heaton added a comment - I can't reproduce the report that header params without javadoc don't show up. They show up for me. Work started on adding a new annotation, @org.codehaus.enunciate.jaxrs.ResponseHeaders , to document response headers.
Hide
Permalink
Ryan Heaton added a comment -

Fixed at 75fff18

Show
Ryan Heaton added a comment - Fixed at 75fff18
Hide
Permalink
Ryan Heaton added a comment -

Closed with the release of 1.26.

Show
Ryan Heaton added a comment - Closed with the release of 1.26.

People

  • Assignee:
    Ryan Heaton
    Reporter:
    Jason Chaffee
Vote (0)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: