Manage Products and Content

The following section describes how to create and publish a new product (that is, an API product) to a SwaggerHub Portal instance directly via its APIs.

A product, in terms of SwaggerHub Portal, is a combination of:

  • metadata (also known as product settings),
  • API reference documents (for example, an OpenAPI document),
  • and Markdown documents.

The following table outlines the settings per product:

Setting NameDescription
nameThe name of the product that will appear on the portal landing page (maximum length is 22 characters).
slugThe URL segment to be appended to the portal URL to uniquely reference the product https://<SUBDOMAIN><SLUG>.
descriptionThe product description that will appear on the landing page (maximum length is 110 characters).
publicIndicates whether or not the product is available publicly (that is, to non-members of the SwaggerHub organization linked to the portal instance). Defaults to false.
hiddenIndicates whether or not the product will be displayed on the portal landing page. Defaults to false (so the product is visible on landing page by default).
logoIdA reference to the logo attachment. Note A logo must be 64x64 pixels, have a .jpg, .gif, or .png file format, and be less than 5MB in size.