join

Introduction

Maintainers of multiple API descriptions can benefit from storing each endpoint as a standalone API description file. However, this approach is not supported by the majority of OpenAPI tools, as they require a single API description file.

With Redocly CLI, you can solve this problem by using the join command that can combine two or more API description files into a single one.

To easily distinguish the origin of OpenAPI objects and properties, you can optionally instruct the join command to append custom prefixes to them.

The join command accepts both YAML and JSON files, which you can mix in the resulting openapi.yaml file. Setting a custom name for this file can be achieved by providing it through the --output argument. Any existing file is overwritten.

Apart from providing individual API description files as the input, you can also specify the path to a folder that contains multiple API description files and match them with a wildcard (for example, myproject/openapi/*.yaml). The join command collects all matching files and combines them into one file.

Usage

redocly join <api> <api>...
redocly join <api> <api>... -o <outputName>
redocly join <path-to-folder>/<wildcard-pattern> [--lint]
redocly join [--help] [--prefix-components-with-info-prop] [--prefix-tags-with-info-prop] [--prefix-tags-with-filename]

redocly join first-api.yaml second-api.yaml
redocly join first-api.yaml second-api.json
redocly join first-api.yaml second-api.json -o openapi-custom.yaml
redocly join ./*.yaml
redocly join --version

Options

Examples

Array of paths

redocly join first-api.yaml second-api.json

redocly join first-api.yaml second-api.json

openapi.yaml: join processed in 56ms

The command creates the output openapi.yaml file in the working directory.

The order of input files affects how their content is processed. The first provided file is always treated as the "main" file, and its content has precedence over other input files when combining them. Specifically, the following properties of the API description are always taken only from the first input file:

info:
  version
  title
  termsOfService
  contact
  license
externalDocs

By default, the info.description property is taken only from the first file, even if it exists in other input files.

However, if any of the input files contain the tags object, the join command automatically creates the x-tagGroups object in the output file. This object contains the info.description property from each of the input files.

x-tagGroups:
  - name: first-api
    tags:
      - expanded
      - other
    description: 'Text from info: description of the first input file'
  - name: second-api
    tags:
      - pets
    description: 'Text from info: description of the second input file'

The servers object combines the content from all input files, starting with the content from the first file. Commented lines are not included in the output file.

Path names and component names must be unique in all input files, but their content doesn't have to be unique for the join command to produce the output file. For each path item object, only the operation ID must be unique.

If the join command detects any conflicting content while trying to combine the input files, it displays informative messages about the conflicts and exits without creating an output file. To prevent this, use optional parameters to add prefixes to tags and components.

Conflict on tags => all : pets in files: petstore.yaml,test.yaml

1 conflict(s) on tags.
Suggestion: please use prefix-tags-with-filename, prefix-tags-with-info-prop or without-x-tag-groups to prevent naming conflicts.

Conflict on paths => /pets : get in files: petstore.yaml,test.yaml
Conflict on paths => /pets : post in files: petstore.yaml,test.yaml
Conflict on paths => operationIds : listPets in files: petstore.yaml,test.yaml
Conflict on paths => operationIds : createPets in files: petstore.yaml,test.yaml
Conflict on paths => operationIds : showPetById in files: petstore.yaml,test.yaml
Conflict on paths => /pets/{petId} : get in files: petstore.yaml,test.yaml

Please fix conflicts before running join.

Use the --without-x-tag-groups option to skip the creation and population of x-tagGroups in the output file.

prefix-tags-with-info-prop

If any of the input files contain the tags object, tags in the output file are prefixed by the selected property from the info object of the corresponding input file.

The output file preserves the original tag names as the value of the x-displayName property for each tag.

Usage

redocly join first-api.yaml second-api.json --prefix-tags-with-info-prop title

- name: First Document title_endpoints
  description: endpoints tag description
  x-displayName: endpoints

- name: Second document title_pets
  description: pets tag description
  x-displayName: pets

prefix-tags-with-filename

If any of the input files contain the tags object, tags in the output file are prefixed by the filename of the corresponding input file.

The output file preserves the original tag names as the value of the x-displayName property for each tag.

Usage

redocly join first-api.yaml second-api.json --prefix-tags-with-filename true

- name: first-api_endpoints
  description: endpoints tag description
  x-displayName: endpoints

- name: second-api_pets
  description: pets tag description
  x-displayName: pets

without-x-tag-groups

If you have the same tags in multiple API descriptions, you can allow tag duplication by using the without-x-tag-groups option. In this case, the x-tagGroups property is not created in the joined file.

Usage

redocly join first-api.yaml second-api.json --without-x-tag-groups

The tag description is taken from the first file that contains the tag. You may see a warning about conflicts in the command output:

warning: 1 conflict(s) on tags description.

openapi.yaml: join processed in 69ms

prefix-components-with-info-prop

If any of the input files have conflicting component names, this option can be used to resolve that issue and generate the output file. All component names in the output file are prefixed by the selected property from the info object of the corresponding input file(s).

Usage

redocly join first-api.yaml second-api.json --prefix-components-with-info-prop version

components:
  schemas:
    1.0.1_Pet:
      allOf:
        - $ref: '#/components/schemas/NewPet'
        - type: object
          required:
            - id
          properties:
            id:
              type: integer
              format: int64
    1.0.1_NewPet:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        tag:
          type: string
    1.2.0_Pet:
      allOf:
        - $ref: '#/components/schemas/NewPet'
        - type: object
          required:
            - id
          properties:
            id:
              type: integer
              format: int64

Custom output file

By default, the CLI tool writes the joined file as openapi.yaml in the current working directory. Use the optional --output argument to provide an alternative output file path.

redocly join --output=openapi-custom.yaml