Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add Support for Custom Headers to ParseOpenApi3Documentation

Open
#501 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
api, authentication

Research direction

Start by comparing parseOpenApi3Documentation with parseHydraDocumentation, focusing on how the latter accepts custom headers for authenticated requests. Trace the OpenAPI JSON parsing entry point and determine the interface needed for equivalent header support; done means an OpenAPI document can be parsed with authentication headers, matching the linked authentication example.

Written by the indexing model from the issue text.

Description

Description
It would be ideal if we could support allowing for custom headers while leveraging the parseOpenApi3Documentation function. Currently this is only supported in parseHydraDocumentation, but I have a need to parse an openAPI.json file and would love a means of adding support for authentication while parsing it.

Example
Essentially I would like to be able to leverage the example here without using Hydra. Thanks

Dominant language
TypeScript
Stars
516
Forks
134
No merged PRs in 30d

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.

More from api-platform/admin

All issues in api-platform/admin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.