Skip to content

Commit

Permalink
Merge pull request #9 from stainless-api/sam/sta-2798-update-upload-g…
Browse files Browse the repository at this point in the history
…ithub-action-to-support-a-stainless-config-in

Add support for uploading a Stainless config file in addition to the OpenAPI spec file
  • Loading branch information
dgellow authored Nov 28, 2023
2 parents b5d8084 + 529b0aa commit 2c68462
Show file tree
Hide file tree
Showing 6 changed files with 28,598 additions and 6,877 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and more manual steps before they are merged and released.

If your account is configured to do so, this action can also output a copy of your OpenAPI spec decorated with sample code snippets,
so that your API reference documentation can show examples of making each request with the user's chosen SDK
(e.g., show `client.items.list()` instead of `curl https://api.my-company.com/items`).
(e.g. show `client.items.list()` instead of `curl https://api.my-company.com/items`).

## Example usage

Expand Down Expand Up @@ -42,6 +42,7 @@ jobs:
with:
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
input_path: 'path/to/my-company-openapi.json'
config_path: 'path/to/my-company.stainless.yaml'
```
## Usage with ReadMe for docs with example snippets
Expand All @@ -66,6 +67,7 @@ jobs:
with:
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
input_path: 'path/to/my-company-openapi.json'
config_path: 'path/to/my-company.stainless.yaml'
output_path: 'path/to/my-company-openapi.documented.json'
- uses: readmeio/rdme
with:
Expand Down
3 changes: 3 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,8 @@ inputs:
input_path:
description: "Path to the OpenAPI file."
required: true
config_path:
description: "Path to the Stainless config file."
required: false
output_path:
description: "Output path for the decorated OpenAPI spec."
Loading

0 comments on commit 2c68462

Please sign in to comment.