Sync your OpenAPI specification

1
 api:
2
   specs: 
3
     - openapi: .path/to/openapi.json               # Definition file
4
       overrides: .path/to-openapi-overrides.yml    # Overrides file
5
       origin: https://api.example.com/openapi.json # URL to fetch latest spec from

1
name: Sync OpenAPI Specs # can be customized
2
on:                               # additional custom triggers can be configured
3
  workflow_dispatch:              # Manual trigger
4
  push:                                          
5
    branches:
6
      - main                      # Trigger on push to
7
  schedule:
8
    - cron: '0 3 * * *'           # Daily at 3:00 AM UTC
9
jobs:
10
update-from-source:
11
  runs-on: ubuntu-latest
12
  steps:
13
    - uses: actions/checkout@v4
14
      with:
15
        token: ${{ secrets.OPENAPI_SYNC_TOKEN }}
16
    - name: Update API with Fern
17
      uses: fern-api/sync-openapi@v2
18
      with:
19
        update_from_source: true
20
        token: ${{ secrets.OPENAPI_SYNC_TOKEN }}
21
        branch: 'update-api'
22
        auto_merge: false
23
        add_timestamp: true