Investigate if it's possible to document HTTP headers more strictly without it becoming too laborious

Open
#275 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
api, documentation

Research direction

Start by reviewing the existing HTTP-header documentation behavior and its tests. Compare the current non-failing rule with the requested stricter balance; done means undocumented headers are less likely to be missed without making common headers laborious to document.

Written by the indexing model from the issue text.

Description

type: enhancement

When support for documenting HTTP headers was added a decision was made that, unlike the other snippets, a failure would not occur if a header wasn't documented. This was to avoid problems with headers that are very commonly sent or received but typically don't warrant documentation such as Content-Length.

This seems to have worked well for making it easy to document HTTP headers, but has come at the cost of headers sometimes going undocumented. It would be nice to adjust the balance a little so that headers aren't missed and, hopefully, so that documenting headers remains an easy thing to do

Dominant language
Java
Stars
1.2k
Forks
731
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from spring-projects/spring-restdocs

All issues in spring-projects/spring-restdocs

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.