Skip to content

Instantly share code, notes, and snippets.

@ybiquitous

ybiquitous/a.yml

Last active August 28, 2025 09:45
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save ybiquitous/65f7e5491f8b40c384561c4f96dd58cb to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save ybiquitous/65f7e5491f8b40c384561c4f96dd58cb to your computer and use it in GitHub Desktop.
Download ZIP
redocly-cli v2.0.7 bug reproduction
Raw
a.yml
openapi: '3.1.0'
info:
title: Example API
version: '1.0.0'
license:
name: MIT
servers:
- url: https://api.example.com/v1
Raw
b.yml
openapi: '3.1.0'
paths:
/items:
get:
summary: Retrieve a list of items
responses:
'200':
description: A list of items
content:
application/json:
schema:
type: array
items:
type: string
Raw
package.json
{
"type": "module",
"dependencies": {
"@redocly/cli": "2.0.7"
},
"scripts": {
"join": "redocly join --without-x-tag-groups a.yml b.yml -o tmp.yml",
"bundle": "redocly bundle tmp.yml -o openapi.yml",
"postbundle": "rm -f tmp.yml",
"lint": "redocly lint openapi.yml --skip-rule security-defined",
"test": "npm run join && npm run bundle && npm run lint"
}
}
Raw
plugin.js
export default function plugin() {
return {
id: "my-plugin",
decorators: {
oas3: {
"add-servers": addServers,
},
},
};
}
const addServers = () => ({
Root: {
leave: (root) => {
root.servers = [
{
url: "https://api.example.com/v1",
},
];
},
},
});
Raw
redocly.yaml
decorators:
my-plugin/add-servers: on
plugins:
- plugin.js
extends:
- recommended
@ybiquitous
Copy link
Author

ybiquitous commented Aug 28, 2025

Adding a customer decorator and running redocly bundle can work around the problem. Note that servers in a.yml is ignored.

Run:

$ npm it
...
Woohoo! Your API description is valid. 🎉
You have 5 warnings.

Output openapi.yml:

openapi: 3.1.0
info:
  title: Example API
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://api.example.com/v1
tags:
  - name: b_other
    x-displayName: other
paths:
  /items:
    servers: []
    get:
      summary: Retrieve a list of items
      responses:
        '200':
          description: A list of items
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      tags:
        - b_other
components: {}

Ref https://redocly.com/docs/cli/guides/replace-servers-url

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment