Merge branch 'v2.x' into W-10587108-private-idp-requires-public-access-bsj

bjoson-mulesoft · web-flow · commit 18fcf2037695 · 2022-08-26T13:30:04.000-07:00
diff --git a/modules/ROOT/assets/images/approve-requests-api-manager.png b/modules/ROOT/assets/images/approve-requests-api-manager.png
diff --git a/modules/ROOT/assets/images/revoke-access-to-api.png b/modules/ROOT/assets/images/revoke-access-to-api.png
diff --git a/modules/ROOT/pages/analytics-chart.adoc b/modules/ROOT/pages/analytics-chart.adoc
@@ -11,7 +11,7 @@ API Analytics provides a summary in chart form of requests, top apps, and latenc
 
 The requests summary chart lists the total number of requests to your API by the duration you choose. The chart shows the HTTP status codes specified by W3C. For example:
 
-image::analytics-request.png["Requests June 1,2017"]
+image::analytics-request.png["Summary chart of the total number of requests for June 1, 2017, shown by one hour duration."]
 
 Graph lines are provided for:
 
@@ -25,23 +25,23 @@ The top apps summary chart lists the number of requests made to the API by each
 
 The graph lists the number of requests over the duration you select, for example:
 
-image::analytics-top-apps.png[]
+image::analytics-top-apps.png["Summary chart of requests for the top five applications for June 1, 2017, shown by one hour duration."]
 
 == Reviewing Latency Summary Chart
 
 The latency summary chart lists the average API latency for the period selected. The higher the latency, the lower the performance. The y-axis in the chart lists the average latency in milliseconds (ms).
 
-The following example shows that worst average performance during the hour occurred at 8:30 am.
+The following example shows that the worst average performance in the one-hour period was at 8:30 am.
 
-image::analytics-performance.png[Avg Latency 2.74k]
+image::analytics-performance.png["A latency summary chart showing the average latency for the highest point on the chart, which is 8:30 am."]
 
 == Including Policy Violations in Charts
 
 *Note:* Users must have the View Policies permission set to view policies or edit a Policy Violation alert.
 
 Enable or disable the tracking of policy violations by checking the Include Policy Violations checkbox on an Analytics chart screen. The chart shows traffic rejected, or not rejected, by a policy.
 
-image::policy-violations-dashboard.png[]
+image::policy-violations-dashboard.png["An analytics chart screen with the Include Policy Violations checkbox indicated with a callout."]
 
 == See Also
 
diff --git a/modules/ROOT/pages/building-https-proxy.adoc b/modules/ROOT/pages/building-https-proxy.adoc
@@ -123,7 +123,7 @@ To deploy your API Proxy to a standalone server, provide secured properties for
 .. Click the *Actions* button in the top-right corner of your screen and select *Download Proxy*.
 . Take note of your API Instance ID under *API Instance*.
 +
-image::building-https-proxy-541ec.png[]
+image::building-https-proxy-541ec.png["The Download Proxy form with the API Instance ID highlighted by a rectangle."]
 +
 . When running your standalone Mule instance, you need to provide the keystore and key passphrases as -D arguments, along with your API Proxy's API Instance ID. +
 For example, if your API instance ID is 15464957, you need to pass the arguments:
diff --git a/modules/ROOT/pages/classify-api-task.adoc b/modules/ROOT/pages/classify-api-task.adoc
@@ -23,30 +23,30 @@ If the API is not running, follow the single-step classification process in this
 
 == Classifying the API instance on API Manager
 
-. In API Manager, click the environment control, labeled SANDBOX, in this example:
+. In API Manager, click the environment control, which is labeled SANDBOX in this example:
 +
-image::environment3.png[]
+image::environment3.png["API Manager API Administration with the environment sandbox selected."]
 +
 If you do not have a suitable environment you want to classify the API into, create the environment in Access Management.
 See xref:access-management::environments.adoc#to-create-a-new-environment[To Create a New Environment] and xref:environments-concept.adoc[Reviewing Environment Concepts] for more information.
 +
 . Select *Unclassified*.
 +
-image::switch-environment.png[]
+image::switch-environment.png[The Switch Environment dialog showing the environments.]
 +
-. Click *Switch.
+. Click *Switch*.
 +
 A list of unclassified APIs appears.
 +
-image::classify.png[]
+image::classify.png[API Administration dialog box showing a list of unclassified APIs.]
 +
-. Click Classify.
-. Under Target Environment, select the environment for the API from the list of environments available to you. For example, select Test.
-. In Instance Label, optionally type a unique instance name. For example, type `abc-api-1`.
+. Click *Classify*.
+. For *Target environment*, select the environment for the API from the list of environments available to you. For example, select *Test*.
+. For *Instance name*, optionally type a unique instance name. For example, type `abc-api-1`.
 +
-In environments, APIs can have more than a single instance. Therefore, an instance name is required to uniquely identify it.
+For environments, APIs can have more than a single instance. Therefore, an instance name is required to uniquely identify it.
 +
-image::classify-instance.png[]
+image::classify-instance.png[The Classify dialog box with example values in the Target environments and Instance name fields.]
 
 === API Analytics Impact
 
diff --git a/modules/ROOT/pages/delete-api-task.adoc b/modules/ROOT/pages/delete-api-task.adoc
@@ -15,7 +15,7 @@ To delete API instances from API Manager:
 +
 The API *Settings* detail appears:
 +
-image::api-settings.png[]
+image::api-settings.png[API Manager administration settings.]
 
 . Select *Actions* > *Delete API*.
 . Click *Delete* to confirm. 
diff --git a/modules/ROOT/pages/deprecate-api-latest-task.adoc b/modules/ROOT/pages/deprecate-api-latest-task.adoc
@@ -10,7 +10,7 @@ While transitioning consumers of your API to an updated instance, you can preven
 +
 The API *Settings* detail appears:
 +
-image::api-settings.png[]
+image::api-settings.png[API Manager administration settings.]
 
 . Select *Actions* > *Deprecate API*.
 . Click *Ok*. 
diff --git a/modules/ROOT/pages/edit-enable-disable-alerts-task.adoc b/modules/ROOT/pages/edit-enable-disable-alerts-task.adoc
@@ -5,11 +5,11 @@ endif::[]
 
 When creating an alert, you can select if the alert will be enabled or disabled. You can also edit an existing alert and enable or disable the alert.
 
-. In API Manager click *API Administration* on the left navigation bar.
-. Click the API instance, and version that you want to edit and click *Alerts*.
+. In API Manager click *API Administration* on the navigation bar.
+. Click the API instance and version that you want to edit and then click *Alerts*.
 . Click the *Edit* button on the alert you want to edit.
 +
-image::edit-enable-disable-alerts-task-7e2ac.png[]
+image::edit-enable-disable-alerts-task-7e2ac.png[The API instance alerts list showing an example alert.]
 
 == See Also
 
diff --git a/modules/ROOT/pages/environments-concept.adoc b/modules/ROOT/pages/environments-concept.adoc
@@ -5,7 +5,7 @@ endif::[]
 
 The support for environments in strategic components of Anypoint Platform eliminates the need to construct version names to reflect an environment. The administrator grants permissions per environment. A user who is granted environment access permission has full access to operations inside the specific environment:
 
-image::environment3.png[]
+image::environment3.png["API Manager API Administration with the environment sandbox selected."]
 
 API Manager environment administrator only relates to actions inside of API Manager. The API Manager Environment Administration permission allows you to do the following things:
 
@@ -18,7 +18,7 @@ As organization administrator, you grant permissions to users as described in th
 
 When you navigate to API Manager, you see the environment control bearing the name of your default environment on the upper left. In this example, Sandbox is the default environment:
 
-image::environment3.png[]
+image::environment3.png["API Manager API Administration with the environment sandbox selected."]
 
 When you click the environment control, a list of your production and sandbox environments appears.
 
diff --git a/modules/ROOT/pages/find-api-id-task.adoc b/modules/ROOT/pages/find-api-id-task.adoc
@@ -11,4 +11,4 @@ API Manager generates the `apiId` of new APIs managed by API Manager for use wit
 +
 The API ID is displayed under *API Instance*.
 +
-image::display-api-id-api-manager.png[]
+image::display-api-id-api-manager.png[The API Manager page with an API instance selected.]
diff --git a/modules/ROOT/pages/getting-started-proxy.adoc b/modules/ROOT/pages/getting-started-proxy.adoc
@@ -18,7 +18,7 @@ in API Manager.
 +
 An API Instance is a proxy of an API that serves the upstream. API instances support the application of policies
 and can be deployed to an API gateway. 
-. xref:gateway::policies-included-apply.adoc[Apply a Policy in API Manager]
+. xref:policies::policies-included-apply.adoc[Apply a Policy in API Manager]
 +
 A policy extends the functionality of an API and enforces certain capabilities such as security. A policy
 can control access and traffic. For example, a policy can generally control authentication, access,
diff --git a/modules/ROOT/pages/latest-overview-concept.adoc b/modules/ROOT/pages/latest-overview-concept.adoc
@@ -20,7 +20,7 @@ Before using API Manager, familiarize yourself with the user interface and the t
 
 To access API Manager, log in to Anypoint Platform and select *API Manager* from the main menu:
 
-image::api-manager-ui-overview.png[97%,97%]
+image::api-manager-ui-overview.png["API Manager page navigation shown with callouts.",97%,97%]
 
 <1> The environment selector. Anypoint Platform enables you to create and manage separate deployment environments for APIs and applications. API Manager displays all environments except design environments. For details, see xref:switch-environment-task.adoc[Switching Environments].
 
@@ -30,13 +30,13 @@ image::api-manager-ui-overview.png[97%,97%]
 An _API group_ is an API asset that enables organizations to publish a group of API instances as a single unit. For details, see xref:api-groups-landing-page.adoc[API Groups].
 * *Automated Policies* 
 +
-Policy automation enables security architects and administrators to secure and govern every API running in an environment. For details, see xref:gateway::policies-automated-overview.adoc[Automated Policies].
+Policy automation enables security architects and administrators to secure and govern every API running in an environment. For details, see xref:policies::policies-automated-overview.adoc[Automated Policies].
 * *Client Applications*
 +
 _Applications_ are external services that consume APIs. For details about applications and their related contracts, see xref:view-api-contracts.adoc[View API Instance Contracts].
 * *Custom Policies*
 +
-_Custom policies_ are policies that anyone can develop and apply to their APIs, with the intention of extending existing functionality or defining new functionality. For details, see xref:gateway::policies-custom-overview.adoc[Custom Policies].
+_Custom policies_ are policies that anyone can develop and apply to their APIs, with the intention of extending existing functionality or defining new functionality. For details, see xref:policies::policies-custom-overview.adoc[Custom Policies].
 * *DataGraph Administration*
 +
 Anypoint DataGraph enables you to unify all the data within your application network in a unified schema. For details, see xref:datagraph::index.adoc[Anypoint DataGraph Overview].
diff --git a/modules/ROOT/pages/prepare-raml-task.adoc b/modules/ROOT/pages/prepare-raml-task.adoc
@@ -33,15 +33,15 @@ And then you can apply this trait in each individual operation like this:
 +
 In the list of policies, the RAML snippet link contains the RAML trait or OAS components you need to add to the API specification.
 +
-image::raml-snippet.png[]
+image::raml-snippet.png["The API Manager Policies page."]
 . Click *API Specification Snippet*.
 . Select the API type to match your specification:
 ** RAML 0.8 or RAML 1.0 to match the API RAML version.
 +
-image::snippet-rate-limiting.png[]
+image::snippet-rate-limiting.png["The API Specification Snippet page with RAML 0.8 selected."]
 ** Or OAS 2.0 to match the API OAS version.
 +
-image::prepare-raml-task-2b676.png[]
+image::prepare-raml-task-2b676.png["The API Specification Snippet page with OAS 2.0 selected."]
 +
 OAS Snippets are not displayed for all policy versions. +
 See the table below to see the policies and the versions that display their OAS snippets:
diff --git a/modules/ROOT/pages/rate-limit-1.2.0-task.adoc b/modules/ROOT/pages/rate-limit-1.2.0-task.adoc
@@ -9,11 +9,11 @@ The identifier is a DataWeave expression that maps to a String, creating a selec
 
 You specify the identifier when you apply the policy.
 
-image::rate-limit-identifier.png[]
+image::rate-limit-identifier.png["The Apply Rate limiting policy page."]
 
 This example makes Rate limiting effective for every method. The quota is independent for each method (3 requests per 10 seconds). Such a policy configuration could result in the events over a hypothetical period of time shown below:
 
-image::three-req-per-10.png[]
+image::three-req-per-10.png["A graphic that shows symbols for accepted and rejected post and get requests on a timeline with brackets showing window sizes for two 10-second intervals."]
 
 The example shows the following things:
 
@@ -33,7 +33,7 @@ If the identifier is not sent in the request, it defaults to an empty identifier
 
 The following image illustrates the latter case, which corresponds to a 3-requests-per-10-seconds quota with the DataWeave expression: `#[attributes.queryParam[‘customIdentifier’]]` as the policy identifier:
 
-image::rate-limit-identifier.png[]
+image::rate-limit-identifier.png["The Apply Rate limiting policy page."]
 
 In the case, the following actions occur:
 
@@ -46,7 +46,7 @@ The rate limiting engine is HTTP agnostic, depending solely on the resolution of
 
 For example, you can configure a rate limiting policy with an identifier that uses one bucket for all Class A & C LAN requests, and another one for everything else.
 
-image::dw-apply-limiting.png[]
+image::dw-apply-limiting.png["The Apply Rate limiting policy page with identifier attributes highlighted."]
 
 This configuration creates a false or a true bucket that corresponds to the locality of the IP that made the request.
 
diff --git a/modules/ROOT/pages/switch-environment-task.adoc b/modules/ROOT/pages/switch-environment-task.adoc
@@ -14,7 +14,7 @@ This procedure assumes you added multiple environments in Access Management > En
 
 . In API Manager, click the environment control. In the following example, this control is labeled SANDBOX:
 +
-image::environment3.png[The environment control button]
+image::environment3.png["API Manager API Administration with the environment sandbox selected."]
 +
 . In Switch Environment, select one of the other listed environments from among the available environments.
 +
diff --git a/modules/ROOT/pages/viewing-api-analytics.adoc b/modules/ROOT/pages/viewing-api-analytics.adoc
@@ -17,11 +17,11 @@ When you access the analytics for your APIs, by default you land on your Overvie
 * *Requests by Application*: Bar chart that shows the number of requests from each of the top five registered applications.
 * *Requests by Platform*: Ring chart that shows the number of requests broken down by platform.
 
-image::overviewdash1.png[]
+image::overviewdash1.png["The API Manager Analytics dashboard."]
 
 By default, these charts display the data for APIs in your organization for the past day. You can use the filters at the top left of the page to change the date range or filter to particular APIs. The time ranges reflect your local time zone.
 
-image::filters.png[]
+image::filters.png["The Date Range filter drop-down menu showing available date range selections."]
 
 When selecting a custom time interval, the numbers of request of your requests by day line chart are not normalized. For example, monthly chart will show number of requests per 4 hours. For two months, the same chart shows requests per 8 hours. If you are using a line chart in a custom dashboard and need to define a custom interval, you need to explicitly set an aggregation interval.
 
@@ -36,7 +36,7 @@ All of the charts on the Overview Dashboard are cross-filtered. If you filter th
 |*Requests by Platform* |Click one or more segments to filter to just those results. Hover over a segment for a tooltip displaying the name of the application and the total number of requests from that application for that time period. |Click the segment(s) again to reset the chart.
 |===
 
-To export the data for any of these charts, click Export image:export.png[].
+To export the data for any of these charts, click the Export icon (image:export.png["Curved arrow".]).
 
 If you have filtered data on one of the charts to show only selected data, the export icon triggers an export of a .csv file of the full data for that chart, filtered by whatever date range and API selection you have made using the filters in the upper left of the page. Exported files are limited to a maximum of 1 million records.
 
@@ -47,7 +47,7 @@ For more information, see xref:environment-permission-task.adoc[Setting permissi
 
 Enable or disable the tracking of policy violations by checking the Include Policy Violations checkbox on the dashboard. The dashboard will show traffic rejected, or not rejected, by a policy.
 
-image::policy-violations-chart.png[]
+image::policy-violations-chart.png["The API Manager policy violations chart with the Include Policy Violations checkbox selected."]
 
 == Creating Custom Charts
 
@@ -70,23 +70,23 @@ To create a custom chart, click Manage Charts:
 +
 Create Chart appears.
 +
-image::createchart.png[]
+image::createchart.png["The create chart page."]
 +
 . Fill in a *Title*, and, optionally, a *Description*.
 . Click a chart type graphic:
 +
 [%header,cols="20a,20a,60a"]
 |===
 |Icon |Chart Type |Chart Options
-|image:line-chart-icon.png[] |Line chart
+|image:line-chart-icon.png["Thumbnail graphic of a line chart."] |Line chart
 |Data Source, Metric: _metrics_ and Total, Data Interval: _durations_
-|image:bar-chart-icon.png[] |Bar chart
+|image:bar-chart-icon.png["Thumbnail graphic of a bar chart."] |Bar chart
 |Data Source, Metric: _metrics_ and Total, Group By: _categories_
-|image:stack-chart-icon.png[] |Stack chart
+|image:stack-chart-icon.png["Thumbnail graphic of a stack chart."] |Stack chart
 |Data Source, Metric: _metrics_ and Total, Group By: _categories_, Then By: _categories_
-|image:ring-chart-icon.png[] |Ring chart
+|image:ring-chart-icon.png["Thumbnail graphic of a ring chart."] |Ring chart
 |Data Source, Metric: _metrics_ and Total, Group By: _categories_
-|image:map-chart-icon.png[] |Map chart
+|image:map-chart-icon.png["Thumbnail graphic of a map chart."] |Map chart
 |Data Source, Metric: _metrics_ and Total
 |===
 +
@@ -151,13 +151,13 @@ The custom chart appears.
 * Select Application to display each application in a different column.
 * Select Violated Policy Name as the stack within each column.
 +
-image::create-chart-2.png[]
+image::create-chart-2.png["The bottom part of the create chart page showing Application selected for Group By and Violated Policy Name selected for Then By."]
 +
 . Save the chart.
 +
 The chart appears:
 +
-image::analytics-violated-policies-2.png[]
+image::analytics-violated-policies-2.png["A chart that shows policy violations grouped by application."]
 
 == Creating a Custom Dashboard
 
@@ -173,13 +173,13 @@ To access your custom dashboard, click the Custom Dashboard. The first time you
 +
 The custom dashboard appears.
 
-image::custom-dashboard.png[]
+image::custom-dashboard.png["A custom dashboard with several custom charts."]
 
 Use the date range picker to adjust the time period for all the charts on your dashboard.
 
 == Exporting Analytics Data
 
-You can export your analytics data from the charts displayed on your Overview Dashboard or your Custom Dashboard. On either dashboard, click Export image:export.png[] to download a CSV file with the data for that chart.
+You can export your analytics data from the charts displayed on your Overview Dashboard or your Custom Dashboard. On either dashboard, click the Export icon (image:export.png["Curved arrow".]) to download a CSV file with the data for that chart.
 
 
 The data you download reflects filtering options you selected. However, if you are exporting chart data from the Overview Dashboard and you have selected one or more subsections of a chart, the exported files do not include filtering options. Exported files contain the full data for that chart.

Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ To deploy your API Proxy to a standalone server, provide secured properties for`
`123`	`123`	`.. Click the Actions button in the top-right corner of your screen and select Download Proxy.`
`124`	`124`	`. Take note of your API Instance ID under API Instance.`
`125`	`125`	`+`
`126`		`-image::building-https-proxy-541ec.png[]`
	`126`	`+image::building-https-proxy-541ec.png["The Download Proxy form with the API Instance ID highlighted by a rectangle."]`
`127`	`127`	`+`
`128`	`128`	`. When running your standalone Mule instance, you need to provide the keystore and key passphrases as -D arguments, along with your API Proxy's API Instance ID. +`
`129`	`129`	`For example, if your API instance ID is 15464957, you need to pass the arguments:`
Original file line number	Diff line number	Diff line change
`@@ -23,30 +23,30 @@ If the API is not running, follow the single-step classification process in this`
`23`	`23`
`24`	`24`	`== Classifying the API instance on API Manager`
`25`	`25`
`26`		`-. In API Manager, click the environment control, labeled SANDBOX, in this example:`
	`26`	`+. In API Manager, click the environment control, which is labeled SANDBOX in this example:`
`27`	`27`	`+`
`28`		`-image::environment3.png[]`
	`28`	`+image::environment3.png["API Manager API Administration with the environment sandbox selected."]`
`29`	`29`	`+`
`30`	`30`	`If you do not have a suitable environment you want to classify the API into, create the environment in Access Management.`
`31`	`31`	`See xref:access-management::environments.adoc#to-create-a-new-environment[To Create a New Environment] and xref:environments-concept.adoc[Reviewing Environment Concepts] for more information.`
`32`	`32`	`+`
`33`	`33`	`. Select Unclassified.`
`34`	`34`	`+`
`35`		`-image::switch-environment.png[]`
	`35`	`+image::switch-environment.png[The Switch Environment dialog showing the environments.]`
`36`	`36`	`+`
`37`		`-. Click *Switch.`
	`37`	`+. Click Switch.`
`38`	`38`	`+`
`39`	`39`	`A list of unclassified APIs appears.`
`40`	`40`	`+`
`41`		`-image::classify.png[]`
	`41`	`+image::classify.png[API Administration dialog box showing a list of unclassified APIs.]`
`42`	`42`	`+`
`43`		`-. Click Classify.`
`44`		`-. Under Target Environment, select the environment for the API from the list of environments available to you. For example, select Test.`
`45`		-. In Instance Label, optionally type a unique instance name. For example, type `abc-api-1`.
	`43`	`+. Click Classify.`
	`44`	`+. For Target environment, select the environment for the API from the list of environments available to you. For example, select Test.`
	`45`	+. For Instance name, optionally type a unique instance name. For example, type `abc-api-1`.
`46`	`46`	`+`
`47`		`-In environments, APIs can have more than a single instance. Therefore, an instance name is required to uniquely identify it.`
	`47`	`+For environments, APIs can have more than a single instance. Therefore, an instance name is required to uniquely identify it.`
`48`	`48`	`+`
`49`		`-image::classify-instance.png[]`
	`49`	`+image::classify-instance.png[The Classify dialog box with example values in the Target environments and Instance name fields.]`
`50`	`50`
`51`	`51`	`=== API Analytics Impact`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ To delete API instances from API Manager:`
`15`	`15`	`+`
`16`	`16`	`The API Settings detail appears:`
`17`	`17`	`+`
`18`		`-image::api-settings.png[]`
	`18`	`+image::api-settings.png[API Manager administration settings.]`
`19`	`19`
`20`	`20`	`. Select Actions > Delete API.`
`21`	`21`	`. Click Delete to confirm.`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ While transitioning consumers of your API to an updated instance, you can preven`
`10`	`10`	`+`
`11`	`11`	`The API Settings detail appears:`
`12`	`12`	`+`
`13`		`-image::api-settings.png[]`
	`13`	`+image::api-settings.png[API Manager administration settings.]`
`14`	`14`
`15`	`15`	`. Select Actions > Deprecate API.`
`16`	`16`	`. Click Ok.`
Original file line number	Diff line number	Diff line change
@@ -11,4 +11,4 @@ API Manager generates the `apiId` of new APIs managed by API Manager for use wit
`11`	`11`	`+`
`12`	`12`	`The API ID is displayed under API Instance.`
`13`	`13`	`+`
`14`		`-image::display-api-id-api-manager.png[]`
	`14`	`+image::display-api-id-api-manager.png[The API Manager page with an API instance selected.]`