You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-6Lines changed: 17 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,16 @@
4
4
<palign="center">A GitHub Action that uploads your OpenAPI specifications to Hey API 🚀</p>
5
5
</div>
6
6
7
-
To use this action, you have to be registered with [Hey API](https://heyapi.vercel.app/). If you don't have an account, please [email us](mailto:[email protected]) or [open an issue](https://github.com/hey-api/upload-openapi-spec/issues) and we will set you up.
7
+
To use this action, you have to be registered with
8
+
[Hey API](https://heyapi.vercel.app/). If you don't have an account, please
[open an issue](https://github.com/hey-api/upload-openapi-spec/issues) and we
11
+
will set you up.
8
12
9
13
## Usage
10
14
11
-
Create a new GitHub workflow or add an upload step to your existing workflow inside your API codebase.
15
+
Create a new GitHub workflow or add an upload step to your existing workflow
16
+
inside your API codebase.
12
17
13
18
```yaml
14
19
name: Upload OpenAPI Specification
@@ -32,20 +37,26 @@ jobs:
32
37
path-to-openapi: path/to/openapi.json
33
38
```
34
39
35
-
The example above will send your OpenAPI spec to Hey API on every push to `main` branch.
40
+
The example above will send your OpenAPI spec to Hey API on every push to `main`
41
+
branch.
36
42
37
43
## Inputs
38
44
39
-
To successfully upload an OpenAPI specification, you need to provide the following inputs (see `with` in the example above)
45
+
To successfully upload an OpenAPI specification, you need to provide the
46
+
following inputs (see `with` in the example above)
40
47
41
48
### `hey-api-token`
42
49
43
50
This is the authorization token you obtained from us.
44
51
45
52
### `path-to-openapi`
46
53
47
-
A relative path to your OpenAPI spec file within the repository. Note that you might need an additional step in your GitHub workflow to generate this file (see [FastAPI example](https://fastapi.tiangolo.com/how-to/extending-openapi/#generate-the-openapi-schema)).
54
+
A relative path to your OpenAPI spec file within the repository. Note that you
55
+
might need an additional step in your GitHub workflow to generate this file (see
0 commit comments