PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

Issue in request section with postman request always being set to content type x-www-form-urlencoded

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

Nobody has claimed this yet.

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

Description

Describe the bug

The issue I am seeing is we have a request which allows you to specify Content-Type between x-www-form-urlencoded and multipart/form-data shown below. What I am seeing is that even if I have the content type set to multipart/form-data and attach the csv file is that in the postmanRequest it is setting the content type to x-www-form-urlencoded and does not seem to be attaching the file when the call is made. the ApiExplorer function seems to be getting the item and having it defaulted to x-www-form-urlencoded even though the content type in the dropdown defaults to multipart/form-data even manually selecting from the dropdown does not seem to change the content type.

Expected behavior

I would expect the content-type drop down to change the content type for the postmanRequest and attach the file when making the api call.

Current behavior

The content type seems to only be set to x-www-form-urlencoded and does not attach the file when making the api call.

Possible solution

Steps to reproduce

Screenshots

image

image

image

Context

Your Environment

  • Version used: we are currently using version 0.0.0-949 with Docusaurus 3.6.3
  • 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: https://github.com/sailpoint-oss/developer.sailpoint.com

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 tracing the ApiExplorer function and how it builds postmanRequest, then reproduce the request using multipart/form-data with an attached CSV file. Confirm that manually selecting the content type changes the generated request and that the file is included when the API call is made.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.