Skip to content

Commit 069b536

Browse files
authored
W-15945517 API Manager Limits (#561)
* Add API Manager Limits page and API Group Limits topic
1 parent 73c7e89 commit 069b536

3 files changed

Lines changed: 28 additions & 16 deletions

File tree

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,4 @@
7878
* xref:troubleshooting-landing-page.adoc[Troubleshooting]
7979
** xref:troubleshooting-archetype-error-when-creating-policy.adoc[Archetype Error When Deploying Policies]
8080
** xref:troubleshooting-config-properties-apiid-error.adoc[Deployment Error when Configuring API Autodiscovery]
81+
* xref:limits.adoc[]

modules/ROOT/pages/api-groups-landing-page.adoc

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ When you create an API Group, you can customize instances of that group with dif
99

1010
Because each API Group instance can include several API instances, and each instance can be included in multiple API Group instance solutions, package customization options are limitless.
1111

12-
== How API Groups Works
12+
== How API Groups Work
1313

1414
As an API Group Administrator, you create an API Group for a specific organization and environment. API Groups are versioned, like the APIs contained within them, to more easily incorporate updates.
1515

@@ -31,9 +31,9 @@ This instance has 4 API instances: `Facebook v1` (PROD) and `Twitter v1` (PROD)
3131

3232
The API Group instance `QA` is published and an asset called `API Group Social Media V1` is created. If the API Group instance `PROD` is published, no asset is created. In this case, `PROD` is linked only to the existing asset because the API Group `Social Media` and the version `v1` are the same.
3333

34-
== Example Issue to Solve Using API Groups
34+
== API Groups Example
3535

36-
To better understand how API Groups facilitates API consumer engagement, consider the needs of a fictitious company named Good Weather, which forecasts atmospheric conditions for a given location and time by using meteorology.
36+
To better understand how API Groups facilitate API consumer engagement, consider the needs of a fictitious company named Good Weather, which forecasts atmospheric conditions for a given location and time by using meteorology.
3737

3838
Good Weather enables customers to access requested results using the following APIs:
3939

@@ -47,7 +47,9 @@ Good Weather enables customers to access requested results using the following A
4747
* Tropical API
4848
* Translations API
4949

50-
Currently, the process that customers must follow to access and use the APIs is not efficient, requiring:
50+
=== Example Problem Statement
51+
52+
The process that Good Weather customers follow to access and use the APIs is not efficient, requiring:
5153

5254
* Searching the Good Weather company portal to find appropriate APIs to actualize a business flow
5355
+
@@ -59,9 +61,9 @@ This complicates the task of upgrading or downgrading of services.
5961
+
6062
The API packaging does not restrict access down to the individual call and data elements. This introduces security issues and unnecessary overhead.
6163

62-
== API Groups Solution
64+
=== Example Solution using API Groups
6365

64-
Using API Groups, Good Weather can package different APIs based on consumer requirements and scenarios, with specific SLAs that do not clash with the requirements for other consumers. Good Weather can quickly adapt and absorb API changes. Using API Groups:
66+
Using API Groups, Good Weather can package different APIs based on consumer requirements and scenarios, with specific SLAs that do not conflict with the requirements for other consumers. Good Weather can quickly adapt and absorb API changes. Using API Groups:
6567

6668
* Good Weather can package different sets of APIs to target different consumers' requirements.
6769
* API consumers can access a collection of related APIs instead of individual APIs, simplifying asset discovery on the Good Weather portal.
@@ -81,24 +83,18 @@ The following table illustrates the API Group packages that Good Weather created
8183
| | | Translations API
8284
|===
8385

84-
== API Groups Permissions
86+
== API Group Permissions
8587

86-
To perform all tasks pertaining to API groups, the API Group Administrator permissions is required. This permission is set at the business group-level and gives the user access to:
88+
To perform all tasks pertaining to API groups, the API Group Administrator permission is required. This permission is set at the business group-level and gives the user access to:
8789

8890
* Create, update, and delete API Groups within the business group
8991
* View all API instances in the business group to be able to add API instances to the API Group
9092
* Configure SLA tiers and manage contracts with API Groups
9193

92-
93-
9494
== See Also
9595

96-
* xref:api-groups-landing-page.adoc[API Groups]
97-
* xref:api-groups-creating-groups.adoc[Create Groups]
98-
* xref:api-groups-modifying-groups.adoc[Modify Groups]
99-
* xref:api-groups-publishing-to-exchange.adoc[Publish API Groups to Exchange]
100-
* xref:api-groups-deprecating-groups.adoc[Deprecate Groups]
101-
* xref:api-groups-deleting-groups.adoc[Delete API Groups]
96+
* xref:limits.adoc#api-group-limits[API Group Limits]
97+
10298

10399

104100

modules/ROOT/pages/limits.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
= Limits in API Manager
2+
ifndef::env-site,env-github[]
3+
include::_attributes.adoc[]
4+
endif::[]
5+
:keywords: api, instance, manager
6+
7+
API Manager limits the number of features allowed for each business group.
8+
9+
== API Group Limits
10+
11+
Each business group can have a maximum of:
12+
13+
* 1200 API Groups
14+
* 1200 API Group Versions
15+
* 2000 API Group Instances

0 commit comments

Comments
 (0)