Redocly / Redocly/redoc

Matrix parameter support

Open
#761 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Since v2 matrix parameters (https://www.w3.org/DesignIssues/MatrixURIs.html) are part of the OpenAPI Spec. We use them in our API and would be happy about a Redoc support.

parameters:
  - name: id
    in: path
    required: true
    style: matrix
    schema:
      type: string

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.

Research direction

Start with the linked W3C matrix-URI material and the OpenAPI path-parameter example in the issue. Then locate where Redoc handles and renders path parameter styles; done means the shown matrix-style parameter is supported in the generated API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.