Update openapi_classification.yml #308
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Sync OpenAPI definitions to ReadMe | |
# Run workflow for every push to the `main` branch | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- '**.yml' | |
jobs: | |
sync-api: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout this repo | |
uses: actions/checkout@v3 | |
# Run GitHub Action to sync OpenAPI file at [path-to-file.json] | |
- name: Sync API definition 1 (extraction) | |
# We recommend specifying a fixed version, i.e. @6.5.0 | |
# Docs: https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#example-using-versioned-actions | |
uses: readmeio/[email protected] | |
with: | |
rdme: openapi openapi_extraction.yml --key=${{ secrets.README_API_KEY }} --id=6201a25efa760de40382e060 | |
- name: Sync API definition 2 (configuration) | |
uses: readmeio/[email protected] | |
with: | |
rdme: openapi openapi_configuration.yml --key=${{ secrets.README_API_KEY }} --id=6243535fd727c300827515b3 | |
# get the ID for the OAS file by importing the file manually in ReadMe Dash, clicking API definitions in the API ref | |
# section of the dash, and copying the new ID. the openapi's title field becomes the new category | |
- name: Sync API definition 2 (classification) | |
uses: readmeio/[email protected] | |
with: | |
rdme: openapi openapi_classification.yml --key=${{ secrets.README_API_KEY }} --id=645bdc026d628e0026488c4e |