Skip to content

Commit

Permalink
Merge pull request #451 from hey-api/docs/integrations
Browse files Browse the repository at this point in the history
docs: add github action to integrations
  • Loading branch information
mrlubos authored Apr 20, 2024
2 parents 00fa2b1 + effa307 commit 9d9de65
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 7 deletions.
5 changes: 5 additions & 0 deletions .changeset/fluffy-ways-sleep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"openapi-ts-docs": patch
---

docs: add github action to integrations
32 changes: 25 additions & 7 deletions docs/openapi-ts/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,35 @@ description: Automate your client generation.

# Integrations <span class="soon">Soon</span>

Integrations allow you to automate your client generation workflow. We suggest using them with `openapi-ts`, but you can use any codegen.
Integrations allow you to automate your client generation workflow. Create dependency links between your clients and APIs, and watch the magic unfold. While we prefer to use `openapi-ts` for generating clients, you can use any codegen.

<br/>
## Upload OpenAPI Spec

::: tip
Integrations are in beta. If you'd like to be one of the first users, [send us an email](mailto:lmenus@lmen.us).
:::
First, you need to configure your API services to send us OpenAPI specifications. This can be done by adding our [hey-api/upload-openapi-spec](https://github.com/marketplace/actions/upload-openapi-spec-by-hey-api) GitHub Action into your CI workflow.

## Upload OpenAPI Spec
```yaml
name: Upload OpenAPI Specification

More information will be provided as we finalize the tooling.
on:
push:
branches:
- main

jobs:
upload-openapi-spec:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Upload OpenAPI spec
uses: hey-api/upload-openapi-spec@v1
with:
hey-api-token: ${{ secrets.HEY_API_TOKEN }}
path-to-openapi: path/to/openapi.json
```
This step requires you to register with us in order to obtain a Hey API token. Please follow the instructions in our [GitHub Action](https://github.com/marketplace/actions/upload-openapi-spec-by-hey-api) to complete the setup. Once you have your APIs configured, you're ready to connect your clients.
## Configure Clients
Expand Down

0 comments on commit 9d9de65

Please sign in to comment.