Re-usable parameters in open api specification

Question

I have an endpoint which takes an X-Request-ID header. This is described as:

parameters:
    - in: header
      name: X-Request-ID
      schema:
        type: string
        format: uuid
      required: true

However, if I have ten endpoints that take this header, do I have to keep repeating this or is there anyway I can get some re-use?

Thanks

Does this answer your question? Swagger/OpenAPI - use $ref to pass a reusable defined parameter — Helen
– Helen, Commented Mar 27, 2020 at 12:00

Alex Shum · Accepted Answer · 2020-03-29 07:48:38Z

2

To add to Helen's comment, you can achieve some reuse by defining X-Request-ID as a Parameter Object in the Parameters Definitions Object, then reference it (by using a Reference Object) in the parameters field of each Path Item Object to denote that it's applicable to all operations under the path.

answered Mar 29, 2020 at 7:48

Alex Shum

711 bronze badge

Sign up to request clarification or add additional context in comments.

1 Answer 1