info-override

Extends the info object with the designated value.

API design principles

Sometimes developers generate OpenAPI and the info object need to be improved after the fact. This generally happens when you have no permission to edit the source. This decorator provides a way to "overlay" a new info section over the source so that as the source changes you won't lose your modifications.

Configuration

Option Type Description
additionalProperties any REQUIRED. Any properties from the OpenAPI info object.

Example of a configuration:

Copy
Copied
decorators:
  info-description-override:
    title: Updated title
    x-meta: Custom metadata

Examples

info-override

Related decorators

Resources