Skip to content

Commit e4bf3df

Browse files
Merge pull request #510 from mulesoft/W-13223380-api-summary-gr
W-13223380 api summary gr
2 parents 15bba65 + a56945e commit e4bf3df

38 files changed

Lines changed: 124 additions & 124 deletions

modules/ROOT/pages/_partials/task-configure-proxy.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
[[select_proxy_type]]
1313
= Select a Proxy Type
1414

15-
. In API Manager, click *Add API* and select *Add new API*.
15+
. Navigate to *Anypoint Platform* > *API Manager*.
16+
. In *API Administration*, click *Add API* and select *Add new API*.
1617
. Select *Mule Gateway* as your runtime.
1718
. Select *Deploy a proxy application* for *Proxy type*.
1819
//end::first-steps[]
@@ -163,7 +164,7 @@ If you upload an OAS API specification to an API proxy version 1.0 or earlier, y
163164
//tag::last-steps[]
164165

165166
. Review your selections and edit them if necessary.
166-
. If you are ready to deploy, click **Save & Deploy**. Otherwise, you can select **Save**, to save the API Instance
167+
. If you are ready to deploy, click **Save & Deploy**. Otherwise, you can select **Save**, to save the API instance
167168
and deploy it at a later time.
168169
+
169170
// end::last-steps[]

modules/ROOT/pages/access-client-app-id-task.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ You must have the Organization Administrator privileges of the root organization
1111

1212
To obtain the credentials of a client application:
1313

14-
. From the left navigation pane in Anypoint Platform, click *Management Center* > *API Manager*.
15-
. On the left navigation in API Manager, click *Client Applications*.
14+
. Go to *Anypoint Platform* > *API Manager*.
15+
. Click *Client Applications*.
1616
. From the details pane, click the application for which you want to view the client credentials.
1717
+
18-
The client ID and client secret credentials for the selected application appear on the right of the window.
19-
. Alternatively, if you need to obtain only the client ID of the registered client application, select the correct version of the API and click *Contracts* from the left navigation.
18+
The client ID and client secret credentials for the selected application appear in the window.
19+
. Alternatively, if you need to obtain only the client ID of the registered client application, select the correct version of the API and click *Contracts*.
2020
+
2121
As an Application Owner, if you do not have access to API Manager, you can view the xref:exchange::about-my-applications.adoc[application credentials] in Exchange.
2222
. To view the details, click the specific API contract.

modules/ROOT/pages/access-developer-portal-task.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ Before you access an asset portal, ensure that you meet one of the following con
1414

1515
To access an asset portal:
1616

17-
. Log in to Anypoint Platform.
18-
. In the navigation bar or the Anypoint Platform page, click *API Manager*.
19-
. On the API Administration dashboard, click the API instance name that you want to access.
20-
. From the top-right corner on the API instance page, click *View API in Exchange*.
17+
. Navigate to *Anypoint Platform* > *API Manager*.
18+
. In *API Administration*, click the name of the API instance that you want to access.
19+
. Click *Actions* and select *View API in Exchange*.
2120
+
2221
The portal for the selected asset is displayed in an Exchange window. You can also share and make the xref:exchange::about-portals.adoc[portal public] in Anypoint Exchange.
2322

modules/ROOT/pages/add-api-alert-task.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ NOTE: This tutorial is for Mule Gateway and Service Mesh runtimes. To add alerts
1515
== Add API Alerts for Mule Gateway or Service Mesh
1616
To add an API alert to a Mule Gateway or Service Mesh API:
1717

18-
. Navigate to *API Manager > API Administration* and click the API instance for which you want to add an alert.
19-
. From the left navigation panel, click *Alerts > Add alert*.
18+
. Navigate to *Anypoint Platform* > *API Manager*.
19+
. In *API Administration*, click the API instance to which to add an alert.
20+
. Click *Alerts* > *Add alert*.
2021
. Specify the alert options:
2122
* *Name*:
2223
+

modules/ROOT/pages/api-groups-add-sla-tiers.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ You can add multiple SLA tiers to an API Group instance.
88

99
To add an SLA tier:
1010

11-
. From *API Administration*, click *API Groups*.
11+
. Navigate to *Anypoint Platform* > *API Manager*.
12+
. Click *API Groups*.
1213
. Expand the *API Group* list and click the API Group instance to which you want to add the SLA tier.
13-
. From the left menu, click *SLA Tiers* and then click *Add SLA tier* on the details page.
14+
. Click *SLA Tiers* and then click *Add SLA tier* on the details page.
1415
. Enter a name for the SLA tier, for example `Premium`.
1516
. Optionally add a description.
1617
. Select either *Manual* or *Automatic* for *Approval* method.

modules/ROOT/pages/api-groups-creating-groups.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ You create an API Group at the organization level.
3535

3636
To create API Groups:
3737

38-
. From the left menu in *API Manager*, click *API Groups > Create API Group*.
38+
. Navigate to *Anypoint Platform* > *API Manager*.
39+
. Click *API Groups* > *Create API Group*.
3940
. In the *API Group name* field, specify a name for the API Group that you want to create: for example, `Social Chatter`.
4041
. In the *API Group version* field, specify the version for the API Group: for example, `v1`.
4142
. Optionally, in the *API Group instance label* field, specify a label for the API Group, such as `Internal` if you want to use it for internal purposes.
@@ -59,7 +60,7 @@ To add a new API instance to a new API Group:
5960

6061
. On the *Creating a new group* page, select an environment from the *Select environment* drop-down list:
6162
. From the *Select an API* list, select the API instance that you want to add.
62-
. From the *Select a version / instance* list, select the version of the API Instance that you want to add to the group.
63+
. From the *Select a version / instance* list, select the version of the API instance that you want to add to the group.
6364
. If you want to include additional API instances in the API Group, click *Add* and specify the details.
6465
. If the API instance and the API Group belong in different business groups:
6566
.. Click *Add Organization*.

modules/ROOT/pages/api-groups-deleting-groups.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ Before you begin, ensure that you have the API Group Administrator permissions t
1212

1313
To delete an API Group:
1414

15-
. From the left menu in *API Manager*, click *API Groups*.
15+
. Navigate to *Anypoint Platform* > *API Manager*.
16+
. Click *API Groups*.
1617
. Select the version of the API Group that you want to delete.
17-
. From the top-right corner of the window, click *...* > *Delete*.
18+
. Click *...* > *Delete*.
1819

1920
== See Also
2021
* xref:api-groups-landing-page.adoc[API Groups]

modules/ROOT/pages/api-groups-deprecating-groups.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ Before you begin, ensure that you have the API Group Administrator permissions t
1313

1414
To deprecate an API Group:
1515

16-
. From the left menu in *API Manager*, click *API Groups*.
16+
. Navigate to *Anypoint Platform* > *API Manager*.
17+
. Click *API Groups*.
1718
. Select the version of the API Group that you want to deprecate.
18-
. From the top-right corner of the window, click *...* > *Deprecate*.
19+
. Click *...* > *Deprecate*.
1920

2021

2122
== See Also

modules/ROOT/pages/api-groups-manage-api-group-instance-contracts.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ After you grant access to API Group instances in Exchange, a contract is automat
88
== Applied Contracts
99

1010
With API Groups, an application can have multiple contracts with the same API in these scenarios:
11-
* An application requests access to an API, and the request is approved.
12-
+
11+
12+
* An application requests access to an API and the request is approved. +
1313
In this case, a direct contract is created between the application and the API. This is known as _API instance contracts_.
14-
* An application requests access to an API Group instance that consists of an API instance with which the application already has a direct contract.
15-
+
14+
* An application requests access to an API Group instance that consists of an API instance with which the application already has a direct contract. +
1615
This is known as _API Group instance contracts_.
1716

1817
When an application has multiple contracts with the same API instance, only one contract is active at any given time. This is known as _Applied contracts_.
@@ -58,9 +57,10 @@ Note that a contract is applied for an API but not for an API Group instance. Fo
5857

5958
To view API Group instance contracts:
6059

61-
. In *API Manager*, click *API Groups*.
60+
. Navigate to *Anypoint Platform* > *API Manager*.
61+
. Click *API Groups*.
6262
. From the API Group instance details page, click the `version:instance` link for the API Group instance.
63-
. From the left navigation, click *Contracts* and expand the instance for which you want to view the contract information:
63+
. Click *Contracts* and expand the instance for which you want to view the contract information:
6464
+
6565
image:api-group-instance-contracts.png[View Contracts for API Group Instance]
6666
+
@@ -73,7 +73,7 @@ To manage API Group instance contracts:
7373
. From the API Group instance details page, click the `version:instance` link for the API Group instance.
7474
+
7575
The API Group instance details page is displayed.
76-
. From the left navigation, click *Contracts* and expand the instance for which you want to view the contract information:
76+
. Click *Contracts* and expand the instance for which you want to view the contract information:
7777
+
7878
image:api-group-instance-manage-contracts.png[Manage Contracts for API Group Instance]
7979
+

modules/ROOT/pages/api-groups-modifying-groups.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ You might want to add API instances to an existing API Group to widen the busine
4848

4949
To add API instances to an existing API Group:
5050

51-
. From the left menu in *API Manager*, click *API Groups*.
51+
. Navigate to *Anypoint Platform* > *API Manager*.
52+
. Click *API Groups*.
5253
. On the API Groups details page, expand the API Group to view its available versions.
5354
. Click *Add group instance* for the version of the API Group that you want to add the API instance to.
5455
+
@@ -70,7 +71,8 @@ If your business requirements change, you might want to modify an API Group by r
7071

7172
To remove an API instance from an API Group:
7273

73-
. From the left menu in *API Manager*, click *API Groups*.
74+
. Navigate to *Anypoint Platform* > *API Manager*.
75+
. Click *API Groups*.
7476
. On the API Groups page, expand the API Group to view its available versions.
7577
. Expand the API Group version to view its available instances.
7678
. Click the API Group instance to view the instance details.
@@ -88,7 +90,8 @@ If you modify an API Group to add a new API or delete an existing API based on c
8890

8991
To create additional versions of an API Group:
9092

91-
. From the left menu in *API Manager*, click *API Groups*:
93+
. Navigate to *Anypoint Platform* > *API Manager*.
94+
. Click *API Groups*.
9295
. Click *Add group version* for the API Group.
9396
. In the *API Group Version* field, specify the version number that you want to create: for example, `v1.1` or `v2.0`.
9497
. In the *API Group instance label* field, enter a label to uniquely identify this instance of the group.

0 commit comments

Comments
 (0)