diff --git a/README.md b/README.md index 8d2fc1d..a7a2597 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,16 @@
A GitHub Action that uploads your OpenAPI specifications to Hey API 🚀
-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:lmenus@lmen.us) 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:lmenus@lmen.us) 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,11 +37,13 @@ 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` @@ -44,8 +51,12 @@ 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. diff --git a/action.yaml b/action.yml similarity index 100% rename from action.yaml rename to action.yml