PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

Array of files in input doesn't work in GUI

Open
#801 1 comment 1 reaction 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

When we have an API that requires a list of documents in input, it's impossible to upload them.

Expected behavior

The upload of multiple files can be done via Docusaurus GUI.

Current behavior

From Docusaurus is impossible to upload multiple files and to invoke these types of API endpoints.

Steps to reproduce

Pre-requirements: having an endpoint API that can be used to upload an array of files.
For example, having this type of OpenApi properties:
properties:
files:
type: array
description: List of documents to upload async
items:
type: string
format: binary

Screenshots

Example of docusaurus' view of a single file as input (it works!):
onefile_upload_in_docusaurus_ae64eaa9-65c9-4b19-8e78-40811a0b4bd5

Example of docusaurus' view of an array of files as input (it doesn't works):
array_of_files_upload_in_docusaurus_423ae299-cb4a-4cb7-b2eb-4c9262e671c1

Example of Swagger editor of OpenAPI with the same OpenAPI defined above (it works):
SWAGGER_OPEN_API_EDITOR_WORKS_Immagine 2024-04-15 172301

here is possible to upload multiple files as array.

Your Environment

  • Version used: v3.0.0-beta.4 (Docusaurus version 3.1.0)
  • Environment name and version:
    • Docusaurus side: Chrome Browser 122.0.6261.71 (Official build 64 bit);
    • BE side: SpringBoot BE engine and NGINX web server
  • Operating System and version (desktop or mobile): Windows 11 Desktop

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

Reproduce the issue with the provided OpenAPI schema and inspect the GUI handling for request-body file inputs, comparing the single-file and array-of-binary cases. Confirm the request can represent multiple selected files and verify the generated API call against the working Swagger editor behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, react, typescript
Domain
api, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.