Display documentation similar to operations?

[fewcifur]

(I am new to this so please bear with me)

I have an API spec with extensive documentation in the "description" section. As a result, it takes an age to scroll down to the actual operations. Unfortunately, external documentation isn't an option right now.

I would like to have the documentation sections displayed in a group, similar to the way operations are displayed via tags. Unfortunately, I can't figure out how to do this without specifying it as GET etc.

Is there any way to display a "Documentation" tags group without specifying the method? Or is there a way to hide this method for one operation?

I'm using Swagger 2.0

[shockey]

Hmmmm, good question.

Here's a plugin that makes your API Info block (which includes the description) collapsible:

const CollapsibleDescriptionPlugin = (system) => {
  const React = system.React
  
  return {
    wrapComponents: {
      info: (OriginalComponent) => system.React.createClass({
        getInitialState() {
          return {
            isOpened: true
          }
        },
        onClick() {
          this.setState({ isOpened: !this.state.isOpened })
        },
        render() {
          const Collapse = system.getComponent("Collapse")
          return <div>
            <h2 onClick={this.onClick}>Description 
              <small>{this.state.isOpened ? "▼" : "▶"}</small>
            </h2>
            <Collapse isOpened={this.state.isOpened}>
              <OriginalComponent {...this.props} />
            </Collapse>
          </div>
        }
      })
    }
  }
}

[shockey]

Closing due to inactivity.

This is simply to keep our issue tracker clean - feel free to comment if there are any further thoughts or concerns, and we'll be happy to reopen this issue.