PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

How do to customise logic in the generated mdx?

Open
#1,112 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hi,

I'd like to know if there's a suggested approach on "ejecting" the default generation to inject some custom logic such as preselecting fields in the API "playground" (e.g. a different API remote than the first one)

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

The issue concerns ejecting generated MDX and customizing the API playground, but it names no files, tests, or entry points. Start by locating the generation and playground entry points, then determine whether a supported customization path can be documented; done means a clear approach for changing the selected API remote or fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.