Skip to content

open_api formatter doesn't populate info node correctly #464

Open

Description

@kira4ka

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?

Activity

  1. joelcahalan commented on Jul 21, 2020

    @joelcahalan

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

  2. JosimarCamargo commented on Jan 17, 2025

    @JosimarCamargo

    It worked for, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions