Path params being lumped in with query params in OpenAPI spec

Open Beginner friendly
#88 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi, typescript
Domain
documentation, frontend

Research direction

Start in app/components/ApiEndpoint.vue at line 78, where the issue identifies the parameter rendering logic. Trace how OpenAPI path and query parameters are classified, then verify that path parameters appear as path parameters rather than being lumped into the query parameters in the rendered specification.

Written by the indexing model from the issue text.

Description

Docs Platform

As noted by @hanneskuettner (thank you!) under Items, the path params were being rendered as query params.

Looking at the code, it's indeed happening that path params are being lumped in.

Dominant language
TypeScript
Stars
22
Forks
82
Avg merge
18h 49m
Merged PRs (30d)
4

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 directus/docs

All issues in directus/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.