PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

Open API with code snippets

Open
#289 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hi,

Documentation link

https://github.com/PaloAltoNetworks/docusaurus-openapi-docs

Describe the problem

we would like to achieve a functionality that is similar to the one that you present here:

https://docusaurus-openapi.tryingpan.dev/petstore/add-pet

We are starting by the following Open API documentation:

https://qanswer-core1.univ-st-etienne.fr/v2/api-docs

The problem is that we do not get the whole right part, send API request + code snippets.

At the beginning we thought they would be generated from the swagger documentation, but you start from

https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/demo/examples/petstore.yaml

which already contains the code snippets. Is this right? How can we achieve a similar input file? I would try to imporve the documentation to indicate this to users ....

Suggested fix

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 by comparing the linked demo/examples/petstore.yaml with the supplied OpenAPI documentation at qanswer-core1.univ-st-etienne.fr/v2/api-docs. Review the linked documentation and issue discussion to determine how the request panel and code snippets are represented, then document the required input and expected result for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.