-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from hey-api/chore/action-yml
chore: try with action.yml
- Loading branch information
Showing
2 changed files
with
17 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,11 +4,16 @@ | |
<p align="center">A GitHub Action that uploads your OpenAPI specifications to Hey API 🚀</p> | ||
</div> | ||
|
||
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. | ||
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. | ||
|
||
## Usage | ||
|
||
Create a new GitHub workflow or add an upload step to your existing workflow inside your API codebase. | ||
Create a new GitHub workflow or add an upload step to your existing workflow | ||
inside your API codebase. | ||
|
||
```yaml | ||
name: Upload OpenAPI Specification | ||
|
@@ -32,20 +37,26 @@ jobs: | |
path-to-openapi: path/to/openapi.json | ||
``` | ||
The example above will send your OpenAPI spec to Hey API on every push to `main` branch. | ||
The example above will send your OpenAPI spec to Hey API on every push to `main` | ||
branch. | ||
|
||
## Inputs | ||
|
||
To successfully upload an OpenAPI specification, you need to provide the following inputs (see `with` in the example above) | ||
To successfully upload an OpenAPI specification, you need to provide the | ||
following inputs (see `with` in the example above) | ||
|
||
### `hey-api-token` | ||
|
||
This is the authorization token you obtained from us. | ||
|
||
### `path-to-openapi` | ||
|
||
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)). | ||
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)). | ||
|
||
## Next Steps | ||
|
||
Please follow the [integrations guide](https://heyapi.vercel.app/openapi-ts/integrations.html) on our website for the next steps. | ||
Please follow the | ||
[integrations guide](https://heyapi.vercel.app/openapi-ts/integrations.html) on | ||
our website for the next steps. |
File renamed without changes.