Customizing API details pane

You can customize the entries that are displayed in the details pane on the API details screen to suit your requirements.

About this task

In this example, you change the text Introduction to API Overview for the theme, Theme1.

Procedure

  1. From the Themes page, click the customize icon next to Theme1.
  2. Select Components from the left pane and select the API details side bar.
  3. Move your mouse pointer over the component and click the edit icon .
  4. From the Layout configuration section, select Text.
  5. Provide API Overview in the Enter the key field.
  6. Click Save.
    Your changes are saved.
  7. Click the activate icon next to the theme in the Themes page to activate the changes.

What to do next

  • Add a block to the grid. For information on adding a block, see Adding blocks and components.
  • Customize a block on the grid. For information on customizing a block, see Customizing blocks.
  • Modify the order of blocks on the grid. For information on moving the blocks, see Moving blocks.
  • Remove a block from the grid. For information on removing a block, see Removing blocks.
  • You can also add the following components that are exclusive to the API details pane.
    Component Description
    Global search Inserts a search box that allows users to search for API resources.
    Stage chooser Inserts option that allows users to choose an API stage.
    Version chooser Inserts option that allows users to choose an API version.
    Comment streams Inserts the comments stream section.
    API Nav Item Inserts link to the configured page. Click the edit icon next to the component and configure the page in the Layout configuration section.
    Download SDK Inserts the Download SDK button that allows users to download a client SDK for an API resource.