PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

Option to display all endpoints on a single page

Open
#1,472 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
1.1k
Forks
315
Avg merge
7d 5h
Merged PRs (30d)
7

Description

Is your feature request related to a problem?

We would like to display all endpoints for an API on the same page, so that users can both select an endpoint from the TOC (sidebar) and scroll all endpoints without selecting (e.g. for mobile devices and small screens). This layout is becoming standard - used on GitHub docs.

Describe the solution you'd like

When generating the Markdown files of a Swagger, provide an option to automatically merge all files for the same swagger into a single Markdown file, so that all endpoints for that API are on a single, scrollable page.

Describe alternatives you've considered

Other open source plugins, such as Rapidoc, Slate, Redoc, have an outdated layout, without the great layout provided by this plugin.

Additional context

We love the layout that we get from the plugin but we're getting user requests to provide all endpoints for an API on a scrollable page.

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

No implementation files or tests are named. Start by locating the Markdown-generation path for a Swagger and trace how endpoint files are produced. Done means an option can merge all endpoint files for one API into a single scrollable Markdown page while retaining endpoint selection in the sidebar.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.