Skip to content

Commit 09af431

Browse files
authored
Merge branch 'v2.x' into W-17113338-API-manager-hyperforce-fa
2 parents fd89de6 + 10acee4 commit 09af431

3 files changed

Lines changed: 77 additions & 5 deletions

File tree

modules/ROOT/pages/create-instance-task-flex.adoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,17 @@ In the following diagram, different routes manage requests to flight information
5252

5353
image:multiple-upstreams.png[Flex Gateway manages the traffic to multiple upstreams]
5454

55+
=== Limits
56+
57+
[%header%autowidth.spread,cols="a,>.<a,a"]
58+
|===
59+
| Limit | Value | Notes
60+
| Upstreams per API | 50 | Each API supports 50 upstreams. The 50 upstreams can consist of a combination of different routes.
61+
| Routes per API | 50 | Each API supports 50 routes.
62+
| Upstreams per route| 10|
63+
| Headers per route rule | 10|
64+
| ===
65+
5566
=== Routes
5667

5768
Each API instance supports up to 50 routes and each route can support up to 10 upstream services. Configure what requests a route can receive by defining route rules and a route order. At least one route per API instance is required.
@@ -60,10 +71,6 @@ Before adding additional routes, enter an optional *Route label* for clarity.
6071

6172
You can add additional routes by clicking *Add Route*, and you can delete routes by clicking the *Trash Can* icon (image:trash-can-icon.png[2%,2%]). If only one route is defined, you cannot delete that route.
6273

63-
=== Limits
64-
65-
include::partial$api-manager-limits.adoc[]
66-
6774
==== Route Rules
6875

6976
You can direct requests to different routes by using route rules.
@@ -163,6 +170,7 @@ Configure the following fields for each upstream service:
163170

164171

165172

173+
166174
//promote-api
167175
include::partial$task-promote-api.adoc[]
168176

modules/ROOT/pages/create-instance-task-mule.adoc

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,55 @@ include::partial$api-configuration-tables.adoc[tags=mule-proxy-upstream]
5959
+
6060
include::partial$task-add-api-instance.adoc[tags=last-steps]
6161

62+
== Create New API Asset
63+
64+
NOTE: This feature is only available on GovCloud environments. If you want to create an API asset in other environments, refer to xref:exchange::to-create-an-asset.adoc#create-an-api-asset[]
65+
66+
An API asset specifies an interface completely, including its functions, descriptions, how to handle return codes, and dependencies.
67+
68+
Creating an asset sets the asset type, which cannot be changed. All versions of an asset always have the same type.
69+
70+
To create an API asset:
71+
72+
. In API Manager, click *Add API*.
73+
74+
. From the dropdown list, select *Create new API asset*
75+
76+
. Enter a name for the asset.
77+
78+
. Select the asset type from the drop-down list:
79+
80+
** REST API - RAML: Provide a RAML API specification file. RAML specifications must be a RAML file (.raml).
81+
82+
** REST API - OAS: Provide an OAS API specification file. OAS specifications can be either a YAML (.yaml) or JSON (.json) file. Exchange supports OAS 2.0 and OAS 3.0 specifications.
83+
84+
** SOAP API - WSDL: Provide a WSDL API specification file. SOAP specifications file can be either a WSDL (.wsdl) or XML (.xml) file.
85+
86+
** AsyncAPI: Provide an AsyncAPI specification file in a YAML (.yaml) or JSON (.json) file.
87+
88+
** AsyncAPI with Avro schemas: Provide an Avro fragment in an AVSC (.avsc) file.
89+
90+
** API Spec Fragment - RAML: Provide an API Fragment RAML specification file. Fragment specifications must be a RAML file (.raml).
91+
92+
** API Spec Fragment - JSON: Provide an API Fragment JSON specification (.json) file.
93+
94+
** API Spec Fragment - OpenAPI Specification (OAS): Provide an API Fragment OpenAPI specification file either JSON or YAML.
95+
96+
** HTTP API: This asset does not require a file. This asset type provides an API endpoint that is defined by API Manager.
97+
98+
. For assets that require a file:
99+
100+
.. Click *Choose File* to locate the API specification file.
101+
102+
.. Select the main file of the API. +
103+
If the file is a ZIP, the selected main file must be in the root directory of the ZIP file. If the file is not a ZIP or if the file is a ZIP file with only one main file, then the main file is selected automatically.
104+
105+
. If you want to edit the *GroupId*, *AssetId*, *Version*, and *API version* (GAV), click *Advanced*. +
106+
Exchange generates the group ID, asset ID, and version (GAV) for you, and you can change these values as needed. You can change an API’s asset version and version separately. Use the advanced settings to change the asset version.
107+
108+
. Choose an option for *Lifecycle state*. The default is Stable.
109+
110+
. Click *Publish*.
62111

63112
//promote-api
64113
include::partial$task-promote-api.adoc[]

modules/ROOT/pages/using-api-alerts.adoc

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,19 @@ include::_attributes.adoc[]
44
endif::[]
55
:keywords: alerts, api, api alerts
66

7-
Anypoint Platform alerts you about request behavior, performance issues, actions related to client application contracts, and runtime events. The platform supports three types of alerts: API alerts, contracts alerts, and runtime alerts. API alerts and contracts alerts are managed by Anypoint API Manager (API Manager). Runtime alerts are managed by Anypoint Runtime Manager (Runtime Manager).
7+
Anypoint Platform alerts you about request behavior, performance issues, actions related to client application contracts, and runtime events.
8+
9+
The platform supports three types of alerts:
10+
11+
* API alerts
12+
* Contracts alerts
13+
* Runtime alerts
14+
15+
API alerts and contracts alerts are managed by Anypoint API Monitoring.
16+
Runtime alerts are managed by Anypoint Runtime Manager (Runtime Manager).
17+
Refer to xref:gateway::flex-use-api-alerts.adoc[Using Flex Gateway API Alert] to learn how to use the new API Monitoring alerts.
18+
19+
NOTE: Customers who were already using legacy Analytics-based API Alerts on API Manager instead of API Monitoring can continue to access this functionality until November 30, 2024. This functionality is not available for new clients.
820

921
[NOTE]
1022
API Alerts aren't available on Hyperforce deployments.
@@ -54,6 +66,9 @@ After an alert is triggered, API Manager sends the first set of two notification
5466

5567
Note: API Alerts are sent from `no-reply@mulesoft.com`. This cannot be customized.
5668

69+
The alert email can be sent before the corresponding sliding window has fully closed. +
70+
Although the alert condition is evaluated based on the sliding window, the condition may be met before all metrics for the window arrive. For example: If the alert condition is set to "error count > 1 in a 5-minute window" and 10 errors occur within the first minute, the alert email is sent during that first minute, even though the sliding window continues to accumulate metrics for the remaining 4 minutes.
71+
5772
== Contracts Alerts
5873

5974
API Manager automatically notifies users when actions related to contracts occur. For instance, when a client application requests access to an API instance, API Manager sends a notification with the status of the request. Depending on the configuration, status might indicate that the request is pending manual approval, or it might indicate that the request has been auto-approved.

0 commit comments

Comments
 (0)