PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

API plugin isn't working with the file upload

Open
#698 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the bug

So Im adding the documentation of the api with paloalto plugin.
And in this documentation, we added options and one of this is to add a file uploaded.
When I see the code with the curl widget is ok and working fine. But when I use the python formatted code, I don't see the file uploaded.

Expected behavior

To see the file uploaded in the right argument of the python code.

Current behavior

So when you have the plugin api installed in the documentation you can see the the parameters being filled according to the options.

Steps to reproduce

Screenshots

Context

Your Environment

  • Version used:
  • Environment name and version (e.g. Chrome 59, node.js 5.4, python 3.7.3):
  • Operating System and version (desktop or mobile):
  • Link to your project:

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 reproducing the issue in the API documentation with the Palo Alto plugin and compare the generated curl and Python examples for a file-upload parameter. Done means the generated Python code includes the uploaded file in the correct argument, matching the curl example.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python, typescript
Domain
api, documentation
Issue type
Bug
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.