Skip to content

Commit 4280973

Browse files
glenn-rodgers-sfmarinasassoCrispy-Salesforce
authored
W-17316074 Managed Flex API (#592)
* Edits * Update api-configuration-tables.adoc * Update status from DISCONNECTED to *Not Running* * Apply suggestions from code review Co-authored-by: Cristian Pose <101070178+Crispy-Salesforce@users.noreply.github.com> --------- Co-authored-by: Marina B <mbukowski@salesforce.com> Co-authored-by: Cristian Pose <101070178+Crispy-Salesforce@users.noreply.github.com>
1 parent a15fb03 commit 4280973

2 files changed

Lines changed: 26 additions & 5 deletions

File tree

modules/ROOT/pages/_partials/api-configuration-tables.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//tag::flex-downstream[]
1+
//tag::flex-downstream-self-managed[]
22
[%header%autowidth.spread,cols="15%,35%,15%,35%"]
33
|===
44
| Field Name | Description | Required | Notes
@@ -9,9 +9,20 @@
99
| *Instance label* | Specifies a label for the API. | No | If you have multiple managed instances of the same API, add a label to differentiate each instance from the others.
1010
| *Advanced Options* | | |
1111
| *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No |
12+
|===
13+
//end::flex-downstream-self-managed[]
14+
15+
//tag::flex-downstream-managed[]
16+
[%header%autowidth.spread,cols="15%,35%,15%,35%"]
17+
|===
18+
| Field Name | Description | Required | Notes
19+
| *Base path* | Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash `/`. | Yes |
1220
| *Client provider* | Specifies a client provider for the API. | No | Anypoint Platform acts as the client provider by default. To configure an external client provider, see xref:access-management::managing-api-clients.adoc[Client Providers].
21+
| *Instance label* | Specifies a label for the API. | No | If you have multiple managed instances of the same API, add a label to differentiate each instance from the others.
22+
| *Advanced Options* | | |
23+
| *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No |
1324
|===
14-
//end::flex-downstream[]
25+
//end::flex-downstream-managed[]
1526

1627
//tag::flex-upstream[]
1728
[%header%autowidth.spread,cols="15%,35%,15%,35%"]

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

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ include::partial$task-add-api-instance.adoc[tags=intro1;flex-intro;intro2]
1616
+
1717
[NOTE]
1818
--
19-
If you do not see a Flex Gateway listed, or you see a Flex Gateway but its status is DISCONNECTED,
19+
If you don't see a Flex Gateway listed, or you see a Flex Gateway but its status is *Not Running*,
2020
See xref:gateway::flex-install.adoc[Install Flex Gateway] and xref:gateway::flex-conn-reg-run.adoc[Register and Run in Connected Mode] for more information.
2121
--
2222

@@ -26,7 +26,17 @@ include::partial$task-add-api-instance.adoc[tags=mid-steps;asset-type-options-fl
2626

2727
. Configure the downstream configuration settings:
2828
+
29-
include::partial$api-configuration-tables.adoc[tags=flex-downstream]
29+
.Managed Flex Gateway
30+
[%collapsible]
31+
====
32+
include::partial$api-configuration-tables.adoc[tags=flex-downstream-managed]
33+
====
34+
+
35+
.Self-Managed Flex Gateway (Connected Mode)
36+
[%collapsible]
37+
====
38+
include::partial$api-configuration-tables.adoc[tags=flex-downstream-self-managed]
39+
====
3040
. Click *Next*.
3141
. Configure one of the following upstream configurations:
3242
** *Single Upstream Service* +
@@ -179,4 +189,4 @@ include::partial$task-import-api.adoc[]
179189

180190
== Notes
181191

182-
* Although OpenAPI Specification (OAS) 3.0 is supported, the callback feature is not. To work around this issue, either handle the callback outside of the Mule runtime engine domain or use an OAS 3.0 specification that does not use callbacks.
192+
* Although OpenAPI Specification (OAS) 3.0 is supported, the callback feature is not. To work around this issue, either handle the callback outside of the Mule runtime engine domain or use an OAS 3.0 specification that doesn't use callbacks.

0 commit comments

Comments
 (0)