https://github.com/firetail-io/upload-api-spec-to-firetail-action

https://github.com/firetail-io/upload-api-spec-to-firetail-action

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/firetail-io/upload-api-spec-to-firetail-action
• Owner: FireTail-io
• License: lgpl-3.0
• Created: 2023-07-04T18:55:46.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-09-20T17:34:17.000Z (about 1 year ago)
• Last Synced: 2023-09-21T04:45:03.412Z (about 1 year ago)
• Language: Python
• Size: 60.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FireTail Action for uploading API Specs

This GitHub Action will send an OpenAPI/Swagger specification to FireTail's platform

**Prerequisites:**

1. Active FireTail account - [FireTail SaaS Platform](https://firetail.app) 

2. API collection - [How to Create a Collection](https://www.firetail.io/docs/create-a-collection)

3. API Token - [How to Create an API Token](https://www.firetail.io/docs/create-an-api-token)

4. API token defined in GitHub - [Encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)

```yaml

steps:

  - uses: actions/checkout@v3

  - uses: FireTail-io/[email protected]

    env:

      FIRETAIL_API_TOKEN: ${{ secrets.FIRETAIL_API_TOKEN }}

      COLLECTION_UUID: ${{ env.COLLECTION_UUID }}

      API_SPEC_LOCATION: src/openapi-spec.yaml

      CONTEXT: ${{ toJson(github) }}

```