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

open_api formatter doesn't populate info node correctly #464

Open
kira4ka opened this issue Feb 12, 2020 · 1 comment
Open

open_api formatter doesn't populate info node correctly #464

kira4ka opened this issue Feb 12, 2020 · 1 comment

Comments

@kira4ka
Copy link

kira4ka commented Feb 12, 2020

From the documentation seems to be a correct way to set API name and API description using following params on config:

# Change the name of the API on index pages
  config.api_name = "API Documentation"
 # Change the description of the API on index pages
  config.api_explanation = "API Description"

This approach works well when exporting documentation in :html format, but when exporting to :open_API nothing happens and the info node seems to ignore configurations and set default values. (See attached screenshot)

Screenshot_2020-02-12_at_14_36_02

I added an open_api.yml under config folder, but still nothing.

Is there another way to correctly populate open_api.json?

@joelcahalan
Copy link

This worked for us: config.configurations_dir = Rails.root.join("config"). Then it should find the yml file you reference.

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

No branches or pull requests

2 participants