Notification Center

The table below shows icons that might appear when you edit a page or API in your portal. This summary provides an overview of these icons to help you understand their differences.

Note

Notification Center clears every time you click Publish.

Content is not preserved between publish actions, so for example, if a page is removed, it is gone.

Table 3. Notification Center

Icon

Meaning

When does it show?

Options

Notes

1_inaccessible_API.png

Inaccessible API

The link to the API in SwaggerHub has broken and we cannot fetch the API. Potential causes:

  • API renamed in SwaggerHub.

  • API deleted from SwaggerHub.

  • Provider doesn't have correct permissions to the API.

  • Anything that affects the API URL structure.

Show the inaccessible API.

  • The API must be unlinked to preview or publish the product.

  • The drop-down border shows in red.

2_API_changes.png

API changes

If the content of the API has changed in SwaggerHub.

  • Show the API that has changes.

  • Open the API in SwaggerHub.

  • When you open the API, you get a reminder to republish the product.

  • Drop-down border shows as yellow.

3_removed_content.png

Removed content

A previously published API has been unlinked, or a page has been deleted.

  • API - ability to link a new API.

  • Page - the ability to restore the page.

  • Content that is added and subsequently removed between publishing will NOT appear here.

  • The restored page will restore the page, including any content change since the last publish.

  • These items will be removed from the consumer side on the next publish action.

  • The drop-down border shows as yellow.

4_new_content.png

New content

When a new API is linked, or a page is added to the product.

Show the page or API that has been added.

  • New content will display on the Consumer view once published.

  • Content that is added and subsequently removed between publishing will NOT appear here.

  • The drop-down border shows as blue.

5_unpublished_changes.png

Unpublished changes

  • If the Table of Contents title has changed for an API or a page.

  • If the page content has changed.

Show the page or API that has been changed in Portal.

  • Changes appear on the consumer view once published.

  • The drop-down border shows as blue.

6_unpublished_reorder.png

Table of Contents reordered

When the Table of Contents items are reordered.

None.

  • The reordered table of contents will display on the Consumer view once published.

  • The drop-down border shows as blue.



Note

The lock icon private-api.png means your API is private in SwaggerHub. This icon doesn't belong to Notification Center.

In this section:
© 2024
Publication date: