Skip to content

Commit 4ee1b93

Browse files
authored
Merge pull request #9 from hey-api/chore/action-yml
chore: try with action.yml
2 parents 11218c2 + a707525 commit 4ee1b93

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@
44
<p align="center">A GitHub Action that uploads your OpenAPI specifications to Hey API 🚀</p>
55
</div>
66

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
9+
[email us](mailto:[email protected]) or
10+
[open an issue](https://github.com/hey-api/upload-openapi-spec/issues) and we
11+
will set you up.
812

913
## Usage
1014

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.
1217

1318
```yaml
1419
name: Upload OpenAPI Specification
@@ -32,20 +37,26 @@ jobs:
3237
path-to-openapi: path/to/openapi.json
3338
```
3439
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.
3642

3743
## Inputs
3844

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)
4047

4148
### `hey-api-token`
4249

4350
This is the authorization token you obtained from us.
4451

4552
### `path-to-openapi`
4653

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
56+
[FastAPI example](https://fastapi.tiangolo.com/how-to/extending-openapi/#generate-the-openapi-schema)).
4857

4958
## Next Steps
5059

51-
Please follow the [integrations guide](https://heyapi.vercel.app/openapi-ts/integrations.html) on our website for the next steps.
60+
Please follow the
61+
[integrations guide](https://heyapi.vercel.app/openapi-ts/integrations.html) on
62+
our website for the next steps.

action.yaml renamed to action.yml

File renamed without changes.

0 commit comments

Comments
 (0)