OpenAPI Overlays

Overlays allow us to modify an existing OpenAPI document without directly editing the original document. An overlay is a separate document that contains instructions for updating the original OpenAPI document.

Active Development

The OpenAPI Overlay Specification (opens in a new tab) is still under active development, and is therefore not considered stable. However, it is supported by Speakeasy and many other tools in the OpenAPI ecosystem.

Overlays are useful for:

• Separating concerns between the original API definition and modifications required by different consumers or use cases.
• Avoiding direct modification of the original OpenAPI document, which may be managed by a separate team or process.
• Applying a set of common modifications to multiple OpenAPI documents.

Overlay Document Structure in OpenAPI

An Overlay document is a separate document from the OpenAPI document it modifies. It contains an ordered list of Action Objects that describe the modifications to be made to the original OpenAPI document.

overlay: 1.0.0
info:
  title: Overlay to fix the Speakeasy bar
  version: 0.0.1
actions:
  - target: "$.tags"
    description: Add a Snacks tag to the global tags list
    update:
      - name: Snacks
        description: All methods related to serving snacks
  - target: "$.paths['/dinner']"
    description: Remove all paths related to serving dinner
    remove: true

The extends field is optional. If not provided, it is the responsibility of tooling to determine which OpenAPI documents the overlay should be applied to.

Overlay Specification Versions

The overlay field contains the version number of the Overlay Specification that the document conforms to. Tooling should use this value to interpret the document correctly.

The current version of the Overlay Specification is 1.0.0, but keep in mind that the specification is still under development.

Overlay Info Object in OpenAPI

Provides metadata about the Overlay document.

Action Object in OpenAPI

Each Action Object represents at least one change to be made to the original OpenAPI document at the location specified by the target field.

Action Targets in OpenAPI

The target field of an Action Object is a JSONPath (opens in a new tab) expression that specifies the locations in the original OpenAPI document where the change should be made.

JSONPath expressions allow you to select and manipulate specific parts of a JSON or YAML document using an intuitive syntax. The expressions are similar to XPath for XML, allowing you to traverse the document tree and select elements based on various criteria.

JSONPath is implemented differently (opens in a new tab) across tooling languages and among individual tools. Speakeasy uses VMware Labs YAML JSONPath (opens in a new tab) to parse JSONPath.

Here are some examples of JSONPath expressions relevant to OpenAPI documents:

When selecting the object to target for different types of updates, consider the following:

For example, to update the description field of the info object, you would target the info object itself:

overlay: 1.0.0
info:
  title: Update Speakeasy API description
  version: 1.0.0
actions:
  - target: $.info
    update:
      description: The Speakeasy Bar API is a secret underground bar that serves drinks to those in the know.

To remove a specific path, such as /oldDrinks, from the paths object, you would target that path directly:

overlay: 1.0.0
info:
  title: Remove deprecated drinks path
  version: 1.0.0
actions:
  - target: $.paths['/oldDrinks']
    remove: true

Applying an Overlay in OpenAPI

When an overlay is applied, the update object is merged with the targeted objects. Any properties present in both the update object and the targeted objects will be replaced with the values from the update object. New properties from the update object will be added to the targeted objects.

The Overlay document is processed in the following order:

1. Tooling locates the original OpenAPI document to modify. This is based on the extends field if provided, otherwise determined by the tooling.

2. Each Action Object is applied to the OpenAPI documents in the order they appear in the actions array.

   For each action:

   1. The target JSONPath expression is evaluated against the OpenAPI document to locate the objects to modify.

   2. If the remove field is true, the targeted objects are removed from the OpenAPI document.

   3. If the remove field is false or not provided and an update object is specified, the update object is merged with each of the targeted objects.

OpenAPI Overlay Examples

Here are some examples of overlays that could be applied to the Speakeasy Bar OpenAPI document:

Updating Info and Servers

This example demonstrates updating the info and servers objects in the original OpenAPI document.

overlay: 1.0.0
info:
  title: Update Speakeasy Bar Info and Servers
  version: 1.0.0
actions:
  - target: $.info
    update:
      description: The Speakeasy Bar API is a secret underground bar that serves drinks to those in the know.
      contact:
        name: Speakeasy Bar Support
        email: support@speakeasy.bar
  - target: $.servers
    update:
      - url: https://staging.speakeasy.bar/v1
        description: Staging server
      - url: https://api.speakeasy.bar/v1
        description: Production server

Adding Tags and Updating Drink Responses

This example demonstrates adding tags to the OpenAPI document and updating response objects for operations related to drinks.

overlay: 1.0.0
info:
  title: Add Tags and Update Drink Responses
  version: 1.0.0
actions:
  - target: $.tags
    update:
      - name: Drinks
        description: Operations related to managing drinks
      - name: Orders
        description: Operations related to order processing
  - target: $.paths['/drinks'].get.responses[200].content['application/json'].schema
    update:
      $ref: "#/components/schemas/DrinkList"
  - target: $.paths['/drinks/{drinkId}'].get.responses[200].content['application/json'].schema
    update:
      $ref: "#/components/schemas/Drink"

Adding Query Parameter Tags

This example demonstrates adding a tag to all operations that have query parameters.

overlay: 1.0.0
info:
  title: Add Query Parameter Tags
  version: 1.0.0
actions:
  - target: $.paths.*[?(@..parameters.*[?(@.in=='query')])]['post','get','put','path','delete'].tags
    update:
      - hasQueryParameters

Removing Deprecated Drink Operations

This example demonstrates removing operations related to drinks that have been marked as deprecated.

overlay: 1.0.0
info:
  title: Remove Deprecated Drink Operations
  version: 1.0.0
actions:
  - target: $.paths['/drinks'].*.deprecated
    remove: true
  - target: $.paths['/drinks/{drinkId}'].*.deprecated
    remove: true