Skip to content

W-17316074 Managed Flex API #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marinasasso merged 6 commits into from
Mar 17, 2025
Merged

W-17316074 Managed Flex API #592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8818a15
Edits
glenn-rodgers-sf Jan 14, 2025
312ad2d
Update api-configuration-tables.adoc
glenn-rodgers-sf Jan 31, 2025
c7c7451
Merge branch 'v2.x' into W-17316074-managed-flex-api-gr
glenn-rodgers-sf Feb 7, 2025
b052d38
Merge branch 'v2.x' into W-17316074-managed-flex-api-gr
glenn-rodgers-sf Mar 12, 2025
6049676
Update status from DISCONNECTED to *Not Running*
marinasasso Mar 14, 2025
cca1b9c
Apply suggestions from code review
glenn-rodgers-sf Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions modules/ROOT/pages/_partials/api-configuration-tables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//tag::flex-downstream[]
//tag::flex-downstream-self-managed[]
[%header%autowidth.spread,cols="15%,35%,15%,35%"]
|===
| Field Name | Description | Required | Notes
Expand All @@ -9,9 +9,20 @@
| *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.
| *Advanced Options* | | |
| *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No |
|===
//end::flex-downstream-self-managed[]

//tag::flex-downstream-managed[]
[%header%autowidth.spread,cols="15%,35%,15%,35%"]
|===
| Field Name | Description | Required | Notes
| *Base path* | Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash `/`. | Yes |
| *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].
| *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.
| *Advanced Options* | | |
| *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No |
|===
//end::flex-downstream[]
//end::flex-downstream-managed[]

//tag::flex-upstream[]
[%header%autowidth.spread,cols="15%,35%,15%,35%"]
Expand Down
16 changes: 13 additions & 3 deletions modules/ROOT/pages/create-instance-task-flex.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include::partial$task-add-api-instance.adoc[tags=intro1;flex-intro;intro2]
+
[NOTE]
--
If you do not see a Flex Gateway listed, or you see a Flex Gateway but its status is DISCONNECTED,
If you don't see a Flex Gateway listed, or you see a Flex Gateway but its status is *Not Running*,
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.
--

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

. Configure the downstream configuration settings:
+
include::partial$api-configuration-tables.adoc[tags=flex-downstream]
.Managed Flex Gateway
[%collapsible]
====
include::partial$api-configuration-tables.adoc[tags=flex-downstream-managed]
====
+
.Self-Managed Flex Gateway (Connected Mode)
[%collapsible]
====
include::partial$api-configuration-tables.adoc[tags=flex-downstream-self-managed]
====
. Click *Next*.
. Configure one of the following upstream configurations:
** *Single Upstream Service* +
Expand Down Expand Up @@ -179,4 +189,4 @@ include::partial$task-import-api.adoc[]

== Notes

* 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.
* 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.