Skip to content

OpenApi 3.1: add additional metadata to Objects with outside context semantics #450

@char0n

Description

@char0n

Affected specification Objects

Some specification Objects are outside-context aware. This means they should be always bound with the field they are referred from.

Path Item Object

Path Item Object is referenced in

  • Callback Object (add expression metadata)
  • webhooks field (add webhook name metadata)
  • Paths Object (add path metadata)
  • components/pathsItems field (no metadata decoration required as key has no semantic meaning)

Media Type Object

Media Type Object is referenced in

  • Parameter Object
  • Request Body Object
  • Response Object

Header Object

Header Object is referenced in

  • Encoding Object
  • Response Object
  • components/headers field

Response Object

Response Object is referenced in

  • components/responses field
  • Responses Object

Implementation

field name that is referring a value of Objects with outside context must be translated into metadata contained within the referenced object.

Refs: #444
Refs: #447

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions