Add support for documenting a request URI's matrix variables

Open
#295 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java, spring
Domain
documentation

Research direction

The issue names no files or tests. Start by locating the request-URI documentation entry points and reviewing how Spring MVC exposes matrix variables. Define the expected documentation for a URI such as "/cars;color=red;year=2012", then identify the relevant coverage needed to demonstrate that behavior.

Written by the indexing model from the issue text.

Description

type: enhancement

The URI specification RFC 3986 defines the possibility of including name-value pairs within path segments. Spring MVC has support for this for a long while.

How do you recommend documenting matrix variables with rest docs?
For example: "/cars;color=red;year=2012"

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.