allow-user-to-pass-env-variables-when-generating-docs - #504
Open
Timothyjb wants to merge 1 commit into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
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
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
This way someone can generate multiple different swaggers with different environemnts