Skip to content

Commit 41cc2a8

Browse files
Merge branch 'v2.x' into W-14222043-Cloudhub-2.0-Proxy-KL
2 parents 7ab0d4e + 4c698d1 commit 41cc2a8

5 files changed

Lines changed: 17 additions & 23 deletions

File tree

modules/ROOT/pages/_partials/task-add-api-instance.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ See xref:runtime-fabric::proxy-deploy-runtime-fabric.adoc[Deploying API Proxies
9999
.. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version.
100100
+
101101
For more information about versions in Exchange, see xref:exchange::asset-versions.adoc[].
102-
.. If you chose a *RAML/OAS* asset type, view the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is non-conformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[].
102+
.. If you chose a *RAML/OAS* asset type, view the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is nonconformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[].
103103

104104
* Click **Create new API**:
105105
[arabic]
@@ -118,7 +118,7 @@ Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are
118118
.. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version.
119119
+
120120
For more information about versions in Exchange, see xref:exchange::asset-versions.adoc[].
121-
.. If you chose a *RAML/OAS* asset type, view the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is non-conformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[].
121+
.. If you chose a *RAML/OAS* asset type, view the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is nonconformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[].
122122
. Click *Next*.
123123
//end::asset-type-options-flex[]
124124

@@ -138,7 +138,7 @@ This option is not available for Flex Gateway runtime at this time.
138138
.. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version.
139139
+
140140
For more information about versions in Exchange, see xref:exchange::asset-versions.adoc[].
141-
.. If you chose a *RAML/OAS* asset type, view the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is non-conformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[].
141+
.. If you chose a *RAML/OAS* asset type, view the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is nonconformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[].
142142
. Click *Next*.
143143
//end::asset-type-options[]
144144

@@ -152,7 +152,7 @@ NOTE: Anypoint API Manager supports OpenAPI Specification (OAS) 3.0, with the ex
152152
.. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version.
153153
+
154154
For more information about versions in Exchange, see xref:exchange::asset-versions.adoc[].
155-
.. View the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is non-conformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[]
155+
.. View the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is nonconformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[]
156156
. Click *Next*.
157157
//end::raml-oas[]
158158

modules/ROOT/pages/_partials/task-promote-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[promote-api]]
2-
== Promote API from Environment
2+
== Promote an API Instance from Another Environment
33

44
. Navigate to *Anypoint Platform* > *API Manager*.
55
. In *API Administration*, click **Add API** and select **Promote API from environment**.

modules/ROOT/pages/govern-api-instances.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To create custom rulesets that enforce your own API management standards, see xr
2020

2121
[[view-api-manager]]
2222

23-
== View and Fix Instance Conformance issues in API Manager
23+
== View and Fix Instance Conformance Issues in API Manager
2424

2525
To view the conformance status of an API instance:
2626

modules/ROOT/pages/latest-overview-concept.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ see xref:api-contracts-landing-page.adoc[Client Applications and Contracts].
103103

104104
=== API Instances
105105

106-
An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Service Mesh. API instances are managed by API Manager after they are created using add, promote, or import options. API instances remain under management until they are deleted.
106+
An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Service Mesh. API instances are managed by API Manager after they are created by using the add, promote, or import options. API instances remain under management until they are deleted.
107107

108108
The API Summary shows key information about a deployed API instance:
109109

@@ -166,9 +166,9 @@ To edit an API instance, see xref:edit-api-endpoint-task.adoc[Edit an API Instan
166166

167167
API Governance is integrated with API Manager to identify the conformance status of your API instances.
168168

169-
API Governance tests API instance against Rulesets to determine conformance issues such as missing policies and missing TLS contexts.
169+
API Governance tests API instances against rulesets to determine conformance issues such as missing policies and missing TLS contexts.
170170

171-
You can view the governance validation report details to get the information you need to fix the conformance issues. The validation report is available both in API Manager on the Governance Report page and in API Governance.
171+
You can view the governance validation report details to get the information you need to fix conformance issues. The validation report is available both in API Manager on the Governance Report page and in API Governance.
172172

173173
To learn more about governing your API instances, see xref:govern-api-instances.adoc[Govern API Instances].
174174

modules/ROOT/pages/promote-api-task.adoc

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,19 @@ ifndef::env-site,env-github[]
33
include::_attributes.adoc[]
44
endif::[]
55

6-
A tight integration of Anypoint Platform components extends the use of environments to API management. In this procedure, you change the environment of an API.
6+
Before promoting an API instance to another environment, ensure that you have the `Manage APIs Configuration` permission.
77

8-
You must have `Manage APIs Configuration` permission to promote an API and `Access Management` permission to set permissions for viewing and managing an entity. You can only promote an entity (Policies, Alerts, and so forth) if you have permission to view the source and permission to manage the destination over each entity. Typical view permissions are `View API Configuration` and `View Policies`, as explained in xref:environment-permission-task.adoc[To Grant Permission to Access Environments]. Set the permissions as needed before proceeding.
8+
You can only promote an entity, such as policies or alerts, if you have both the permissions to view the entity and to manage its destination. For example, you must have the `View Policies` and `Manage Policies` permissions to promote a policy.
99

10-
. Navigate to *Anypoint Platform* > *API Manager*.
11-
. In *API Administration*lick *Add API* and select *Promote API from environment*.
12-
. For *Source Environment*, select the environment of the API to promote.
13-
. For *API*, enter the name of the API and then select it from the APIs in the source environment.
14-
. For *API Version*, select the version of the API.
15-
. Optionally, for *API instance label*, select the API instance name if you created any instances.
16-
. Select or deselect entities to include in the promotion: Policies, SLAs, Alerts, and API Configuration.
17-
. Optionally, if your external client provider differs in the environment to which your are promoting the API, select the provider in the *Client provider* list.
18-
. Click *Promote*.
10+
To promote an API instance:
1911

20-
Promoting an API affects only the API definition, not the existing deployed applications subscribed to the API. After promoting an API, the API Name remains the same, but the API ID changes.
12+
include::partial$task-promote-api.adoc[]
2113

22-
For existing applications that need to subscribe to a promoted API, you need to make the following changes:
14+
Promoting an API instance affects only the API definition, not the existing deployed applications subscribed to the instance. After promoting an API, the *API Label* remains the same, but the *API Instance ID* changes.
2315

24-
. Update the API ID.
16+
For existing applications that must subscribe to a promoted API instance:
17+
18+
. Update the *API Instance ID* within the application.
2519
. Because each environment has a different client ID and secret, update the application's client ID and secret.
2620

2721
== See Also

0 commit comments

Comments
 (0)