Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow-user-to-pass-env-variables-when-generating-docs #504

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Timothyjb
Copy link

Why
This is to allow users to use environment variables in their open_api.yaml file. Like so:

swagger: '2.0'
info:
  title: My Api
  description: About my api
  version: "1.0.0"
host: <%= ENV.fetch('host_name') %>

They could then call the generate command like:

host_name=env_specific_host.com rake docs:generate

This way someone can generate multiple different swaggers with different environemnts

Why
This is to allow users to use environment variables in their `open_api.yaml` file.
Like so:
```
swagger: '2.0'
info:
  title: My Api
  description: About my api
  version: "1.0.0"
host: <%= ENV.fetch('host_name') %>
```
They could then call the generate command like:
```
host_name=env_specific_host.com rake docs:generate
```
This way someone can generate multiple different swaggers with different environemnts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant