rspec_api_documentation icon indicating copy to clipboard operation
rspec_api_documentation copied to clipboard

open_api formatter doesn't populate info node correctly

Open kira4ka opened this issue 5 years ago • 1 comments

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?

kira4ka avatar Feb 12 '20 13:02 kira4ka

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

joelcahalan avatar Jul 21 '20 16:07 joelcahalan