danielgtaylor / danielgtaylor/huma

How to use the Components.Headers

Open
#862 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
4.4k
Forks
285
Avg merge
40m
Merged PRs (30d)
1

Description

Similar to https://github.com/danielgtaylor/huma/issues/495

I want to define a common header that is documented and reused by a group of API.

What's the correct way to ref the header in the group or each Operation Register?

I see there's Security field on the Operation to referecne the Components.SecuritySchemes

so what about for Headers?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Components.Headers, Components.SecuritySchemes, and Operation Register entry points named in the issue, then inspect the existing API documentation for how reusable components are referenced. Done means documenting the supported way to define and reuse a common header across a group of APIs or operations.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.