diff --git a/gateway/1.10/check-changes-gateway.sh b/gateway/1.10/check-changes-gateway.sh new file mode 100755 index 000000000..e4f9e7439 --- /dev/null +++ b/gateway/1.10/check-changes-gateway.sh @@ -0,0 +1,58 @@ +#!/bin/bash + +# ============================= +# Script to compare changes between two versioned directories +# +# NOTE: This script depends on the main script located at: +# docs-team-wiki/handy-scripts/check-changes.sh +# Ensure that script is available and up to date. +# +# Usage: Run this script to check if all changes made to gateway/curr-rel in the +# 'latest' branch after the new Flex Gateway release branch is created have ALSO +# been applied to gateway/new-rel in the 'RELEASE_BRANCH' branch. + +# For example, for the Flex Gateway 1.10.0 release: +# Checks that changes made under the gateway/1.9 directory in branch 'latest', +# after the 'flex-1-10-release' release branch is created are also applied in the +# gateway/1.10 release folder in the 'flex-1-10-release' release branch. +# +# To update the script to work after creating a new release (e.g., 1.5): +# 1. Update branch names (LATEST_BRANCH and RELEASE_BRANCH). +# 2. Update version numbers (OLD_VERSION and NEW_VERSION). +# 3. Update BASE_COMMIT to the commit hash where the new release branch +# (RELEASE_BRANCH for next release) split from 'latest'. To find the commit +# hash, use command 'git merge-base latest RELEASE_BRANCH'. For example: +# git merge-base latest flex-1-10-release +# +# ============================= + +# Error check for dependency script +if [ ! -f "../../../docs-team-wiki/handy-scripts/check-changes.sh" ]; then + echo "Error: Required script 'docs-team-wiki/handy-scripts/check-changes.sh' not found. Please ensure it exists and is up to date." >&2 + exit 1 +fi + +# Commit hash where the release branch split from 'latest'. +# To update for a new release, set this to the commit where the new release branch +# was created. Use command 'git merge-base latest RELEASE_BRANCH'. For example: +# git merge-base latest flex-1-10-release +BASE_COMMIT=ed60617a8219dc89414e71698c77e31d55983a0c + +# Name of the main branch (usually 'latest') +LATEST_BRANCH=latest +# Name of the release branch (e.g., 'flex-1-10-release') +RELEASE_BRANCH=flex-1-10-release + +# Previous version directory (e.g., '1.9') +OLD_VERSION=1.9 +# New version directory (e.g., '1.10') +NEW_VERSION=1.10 + +# Call the generic check-changes.sh script with the appropriate arguments +../../../docs-team-wiki/handy-scripts/check-changes.sh \ + --folder gateway \ + --old-version "$OLD_VERSION" \ + --new-version "$NEW_VERSION" \ + --latest-branch "$LATEST_BRANCH" \ + --release-branch "$RELEASE_BRANCH" \ + --base-commit "$BASE_COMMIT" diff --git a/gateway/1.10/modules/ROOT/pages/flex-troubleshoot-soap-apis.adoc b/gateway/1.10/modules/ROOT/pages/flex-troubleshoot-soap-apis.adoc new file mode 100644 index 000000000..1ccb435b3 --- /dev/null +++ b/gateway/1.10/modules/ROOT/pages/flex-troubleshoot-soap-apis.adoc @@ -0,0 +1,29 @@ += Troubleshooting SOAP APIs +ifndef::env-site,env-github[] +include::_attributes.adoc[] +endif::[] +:imagesdir: ../assets/images + +Flex Gateway does not natively support SOAP APIs and does not provide any schema validation for XML. However, you can publish an HTTP API instance to a secure SOAP upstream service. + +To create an HTTP API instance to a secure SOAP API upstream service, refer to the following: + +* xref:flex-gateway-publish-apis-conn.adoc[] +* xref:flex-gateway-publish-apis-local.adoc[] + +== Publish a Soap API + +Refer to the following video for additional information about how to publish a SOAP API as an HTTP API instance: + +++++ +include::_partials/soap-api-video.html[] +++++ + +== SOAP API Policy Limitations + +Flex Gateway policies return JSON error messages when the policy blocks a request. Most SOAP clients cannot read the JSON messages. + +SOAP APIs do not support the following policies: + +* xref:policies-included-schema-validation.adoc[] +* xref:policies-included-json-threat-protection.adoc[]