Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

W-17118609 REVERT the reverted doc updates for Nov GA - jh #58

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified modules/ROOT/assets/.DS_Store
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions modules/ROOT/pages/api-experience-hub-lightning-components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,17 @@ To change the number of API cards that display in the API Carousel:

The API Catalog component offers API consumers an interactive way to explore all the available APIs in an API portal. The API Catalog shows API cards in rows and columns, divided into pages, and shows controls to search the displayed APIs by categories and search terms. Each card shows an API. With the catalog, users can view and explore large numbers of API versions.

Select the properties to show in the API Catalog:

* Show filter display layout:
** Dropdown below search box
** Dropdown beside search box
** Side panel
* Show asset type filter
* Show categories filter
* Show category pills
* Show asset layout button

== Search Box

The API Experience Hub Search Box component enables users to search for both content that exists in Salesforce Experience Cloud (such as knowledge articles, support cases, and announcements) and content that exists in Anypoint Platform (such as APIs and client applications). Knowledge article, support cases, and announcements are currently not available.
Expand Down
6 changes: 5 additions & 1 deletion modules/ROOT/pages/limitations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@ This release has the following limitations:
* API Experience Hub functions at the main organization level only.
* A Salesforce organization can't connect to more than one Anypoint organization.
* Multiple portals per Salesforce organization aren’t supported.
* API Groups aren't available.
* An API portal can have a maximum of 350 APIs.
+
Don't make changes to the permissions of the out-of-the-box Teams created in Access Management for API Experience Hub. Each asset added to the API portal uses two permissions and Access Management has a limit of 1000 permissions per team.
* API Groups aren't available.

* Enable scalability on the *API management* page to increase the maximum number of APIs to 1,000 for the API portal. After you enable this option, you can't revert to the portal version that supports up to 350 APIs.
+
For more information, see xref:managing-apis.adoc#opt-in-to-increase-the-number-of-apis[Opt in to Increase the Number of APIs in the Portal].
//* API details can't' be modified.
* API Experience Hub isn't certified for use on mobile devices. Some functionality works on mobile devices, but some functionality such as the API Console does not.
* IP restrictions aren't supported. For more information, see the xref:troubleshooting.adoc[Troubleshooting] section.
Expand Down
24 changes: 21 additions & 3 deletions modules/ROOT/pages/managing-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ The *API management* page shows the following information:
* *APIs in the portal*
+
Shows the APIs that have been added to your portal. Administrators can add only those APIs for which they have Exchange Viewer permission. For more information, see xref:assigning-administrator-permissions.adoc[].

+
All administrators are automatically assigned the Exchange Viewer permission for all APIs added to the portal. By default, the visibility of the APIs is set to Administrators. The portal administrator can change the visibility or remove APIs in the *APIs in the portal* tab.
+
You can have a maximum of 350 APIs in your portal.
Existing portals are limited to 350 APIs. To increase the maximum number of APIs to 1,000, opt in to scale the portal.

* *APIs in Exchange*
+
Expand All @@ -30,10 +30,25 @@ Shows the APIs that exist in your Exchange organization but have not been added

//image::aeh-api-description.png[View API Description]

== Opt in to Increase the Number of APIs in the Portal
Administrators can enable portal scalability in the *API management* page to increase the maximum number of APIs available in your portal to 1,000.

After enabling this option, you can't revert to the portal version that supports up to 350 APIs.

New portals automatically scale to 1,000 APIs.

. Click *Learn more* from the sidebar in *API management*.
. Select *I understand and want to enable scalability.* and click *Enable*.
+
You can add up to 1,000 APIs to your portal from Exchange.


== View APIs in Exchange
You can view information about an API directly from Exchange to determine whether you want to add the API in your portal.

From the *APIs in Exchange* tab, select an API from the list, click more the options icon, and select *View in Exchange*.
From the *APIs in Exchange* tab, select an API from the list and select *View in Exchange*.

To filter APIs by categories and tags, select an option from the *Any category* or *Any tag* dropdown and click *Apply*.

== Add APIs from Exchange
Curate your portal in API Experience Hub by adding APIs from Exchange. You must have APIs in Exchange before you can add them to your portal. When adding APIs to the portal, the default visibility is Administrator. You can change the visibility to include members or everyone. See <<make-api-versions-visible,Make API Versions Visible>> for more information.
Expand All @@ -42,6 +57,7 @@ To add APIs to your portal:

. From the *API management* page, select the *APIs in Exchange* tab.
. To search for an API by name or description, enter the name or description into the *Search* bar.
. To filter APIs by categories and tags, select an option from the *Any category* or *Any tag* dropdown and click *Apply*.
. Locate the API in the list, click *+ (Add to portal)*.
+
The API displays in the list in the *APIs in the portal* tab.
Expand All @@ -51,6 +67,7 @@ To remove APIs from your portal:

. From the *API management* page, select the *APIs in the portal* tab.
. To search for an API, enter the name, description, category, or tag keyword into the *Search* box.
. To filter APIs by categories and tags, select an option from the *Any category* or *Any tag* dropdown and click *Apply*.
. Locate the API in the list and click the trash can (Remove from portal).
. Click *Confirm*.
+
Expand Down Expand Up @@ -81,6 +98,7 @@ To edit the user visibility that displays for an API:

. From the *API management* page, select *APIs in Portal*.
. To search for an API, enter the name, description, category, or tag keyword into the *Search* box.
. To filter APIs by categories and tags, select an option from the *Any category* or *Any tag* dropdown and click *Apply*.
. Locate the API in the list and click *Edit visibility*.
. Select an API instance option:
+
Expand Down
14 changes: 8 additions & 6 deletions modules/ROOT/pages/searching-for-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,19 @@ ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]

From the APIs page, search the catalog by an API name to find a specific API. Enter at least four characters in the *Search by API name* field then select an option from the *Search Results* page.
From the *Home* and *APIs* pages, search the catalog by an API name to find a specific API. Enter at least four characters in the *Search All APIs* box then select an option from the results.

image::aeh-search-by-api-name-box.png["Search by API name search box",211,40]
image::aeh-search-by-api-name-box.png["Search box to enter an API name",20%]

Filter the API by type to further refine your search results. The filter options display depending on which API types are available in the portal for example, REST, HTTP, SOAP, and Async.
Filter the API by category and type to further refine your search results. The filter options display depending on which API categories and types are available in the portal.

image::aeh-filter-by-type.png["Filter by Any Type",121,40]
image::aeh-filter-by-category-and-type.png["Filter options to find APIs by categories or types",50%]

From the Home page, you can also filter the carousel by clicking on any of the API type cards.
To filter by categories or tags, select one or more options from *All categories* or *All API types* and click *Apply*.

image::aeh-api-type-filter.png["Filter by API Type"]
From the *Home* page, you can also filter the carousel by clicking on any of the API type cards.

image::aeh-api-type-filter.png["API cards you can select to filter results by API type"]

== See Also

Expand Down