Skip to content

v2.8.1 (2024-04-25) Upgrades and a small fix

Latest
Compare
Choose a tag to compare
@github-actions github-actions released this 25 Apr 11:38
ea01dba

On top of some dependency npm package upgrades (to remove the nasty security audit warnings) this release fixes a small bug.

🐛 Allow overlay target to be the root document

The release fixes a bug in the newly introduced bump overlay command to allow overlay actions targeting the root of the document ($ in JSON path).

This should help for the kind of use-case where you want to add topics to your API document, e.g.:

overlay: 1.0.0
info:
  title: Adding topics to my API
  version: 0.0.1
actions:
  - target: "$"
    update:
      x-topics:
        - title: Getting started
          content: |
            This paragraph is added via an overlay because my **tech
            writers** team is different from my **developers** team
            and I want to publish introduction topics in our API
            documentation!

Have fun designing APIs 😊 ✨