/openapi-merge

Action that merges multiple remote OpenAPI specs into one

Primary LanguageTypeScriptMIT LicenseMIT

typescript-action status

Description

A github action that merge multiple openapi links from different repositories into an array of object as JSON

Usage

      - uses: actions/checkout@v2

      - name: Merge OpenAPIs into one
        uses: barchewbacca/openapi-merge@main
        with:
          token: ${{ TOKEN }}
          path: 'path/to/openapi/merge/file'
          filename: 'openapi-merge.json'

Action inputs

Name Description Default
token GITHUB_TOKEN (repo and workflow should be scoped) Personal Access Token (PAT).
path Path to the openapi-merge.json file that contain list of the openapi links of different repositories. root .
filename Name of the json file that contains the links to the API specifications

Note: The token must have access to the all listed repositories in the input array of the openapi-merge.json if they are private with a minimum read permission.

Note: The sso is need to be enabled if an organization or as account require that.