fork of hey-api/openapi-ts because I need some additional things
Merge pull request #451 from hey-api/docs/integrations
docs: add github action to integrations
+30
-7
+5
.changeset/fluffy-ways-sleep.md
+5
.changeset/fluffy-ways-sleep.md
+25
-7
docs/openapi-ts/integrations.md
+25
-7
docs/openapi-ts/integrations.md
···
5
5
6
6
# Integrations <span class="soon">Soon</span>
7
7
8
-
Integrations allow you to automate your client generation workflow. We suggest using them with `openapi-ts`, but you can use any codegen.
8
+
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.
9
9
10
-
<br/>
10
+
## Upload OpenAPI Spec
11
11
12
-
::: tip
13
-
Integrations are in beta. If you'd like to be one of the first users, [send us an email](mailto:lmenus@lmen.us).
14
-
:::
12
+
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.
15
13
16
-
## Upload OpenAPI Spec
14
+
```yaml
15
+
name: Upload OpenAPI Specification
17
16
18
-
More information will be provided as we finalize the tooling.
17
+
on:
18
+
push:
19
+
branches:
20
+
- main
21
+
22
+
jobs:
23
+
upload-openapi-spec:
24
+
runs-on: ubuntu-latest
25
+
steps:
26
+
- name: Checkout
27
+
uses: actions/checkout@v4
28
+
29
+
- name: Upload OpenAPI spec
30
+
uses: hey-api/upload-openapi-spec@v1
31
+
with:
32
+
hey-api-token: ${{ secrets.HEY_API_TOKEN }}
33
+
path-to-openapi: path/to/openapi.json
34
+
```
35
+
36
+
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.
19
37
20
38
## Configure Clients
21
39