Support spring cloud gateway

[Caoxuyang]

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:

• The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
• You believe there is no need for you to request breaking change approval, for any reason.
  Such claims must be reviewed, and the process is the same.

Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

• For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

• New resource provider.
• New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
• Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
• Update existing version to fix OpenAPI spec quality issues in S360.
• Other, please clarify:
  • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

• I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
• I have reviewed following Resource Provider guidelines, including
  ARM resource provider contract and
  REST guidelines (estimated time: 4 hours).
  I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

• First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
• To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
• If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
  This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

[openapi-pipeline-app]

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

[openapi-pipeline-app]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

Compared specs (v0.10.12)	new version	base version
JavaComponents.json	2024-08-02-preview(eb37940)	2024-02-02-preview(main)

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-preview-2024-08	package-preview-2024-08(eb37940)	package-preview-2024-08(release-app-Microsoft.App-2024-08-02-preview)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ PatchBodyParametersSchema	Properties of a PATCH request body must not be required, property:componentType. Location: Microsoft.App/preview/2024-08-02-preview/JavaComponents.json#L260
⚠️ MissingSegmentsInNestedResourceListOperation	A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.App/preview/2024-08-02-preview/JavaComponents.json#L36
⚠️ SummaryAndDescriptionMustNotBeSame	The summary and description values should not be same. Location: Microsoft.App/preview/2024-08-02-preview/JavaComponents.json#L297

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

️⚠️ azure-sdk-for-python warning [Detail]

For more instructions, please refer to the FAQ .
• ⚠️Warning in generating from 9c52533ffcab6d7737512600542851e2955f284c. SDK Automation 14.0.0

  command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
  cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
  cmderr	[automation_init.sh] npm notice
  cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
  cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
  cmderr	[automation_init.sh] npm notice To update run: npm install -g npm@10.8.1
  cmderr	[automation_init.sh] npm notice
  command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

• ️✔️azure-mgmt-appcontainers [Preview SDK Changes]

️🔄 azure-sdk-for-java inProgress [Detail]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

For more instructions, please refer to the FAQ .
• ️✔️Succeeded in generating from 9c52533ffcab6d7737512600542851e2955f284c. SDK Automation 14.0.0

  command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
  command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

• ️✔️sdk/resourcemanager/appcontainers/armappcontainers [Preview SDK Changes]

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

For more instructions, please refer to the FAQ .
• ️✔️Succeeded in generating from 9c52533ffcab6d7737512600542851e2955f284c. SDK Automation 14.0.0

  command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
  warn	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
  command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

• ️✔️@azure/arm-appcontainers [Preview SDK Changes]

️❌ azure-resource-manager-schemas failed [Detail]

For more instructions, please refer to the FAQ .
• ❌Code Generator Failed in generating from 9c52533ffcab6d7737512600542851e2955f284c. Schema Automation 14.0.0

  command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
  cmderr	[initScript.sh] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
  cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
  cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
  cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
  cmderr	[initScript.sh] npm notice
  cmderr	[initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
  cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
  cmderr	[initScript.sh] npm notice To update run: npm install -g npm@10.8.1
  cmderr	[initScript.sh] npm notice
  error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
  warn	Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
  command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:500
  cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
  cmderr	[generateScript.sh]            ^
  cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
  cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
  cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
  cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
  cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
  cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
  cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
  cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
  cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
  cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
  cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
  cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
  cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
  cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
  cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:500:12)
  cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:504:19)
  cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:739:36)
  cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:955:32)
  cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:1043:43)
  cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
  cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:1046:12)
  cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
  cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
  cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
  error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
  warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.

️️✔️ azure-powershell succeeded [Detail] [Expand]

For more instructions, please refer to the FAQ .
• ️✔️Succeeded in generating from 9c52533ffcab6d7737512600542851e2955f284c. SDK Automation 14.0.0

  command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
  command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

• ️✔️Az.app.DefaultTag [Preview SDK Changes]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/appcontainers/armappcontainers	https://apiview.dev/Assemblies/Review/77a1e1c7ff4c495e8e1c9cf369fdf74a?revisionId=5088d0f9702846148c5a1ab59415caf4
JavaScript	@azure/arm-appcontainers	https://apiview.dev/Assemblies/Review/ba41cd9978b542efb0688a072b2319a1?revisionId=f1541c62a7e549d4bef145442e39c5df
Swagger	Microsoft.App	https://apiview.dev/Assemblies/Review/53999dbad23b45cba7812a00a713cab8?revisionId=73309db7364b4fa1893519c6bd0c5029

[openapi-pipeline-app]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail]

The following breaking changes are detected by comparison with the latest preview version:

Rule

Message

❌ Runtime Exception

"new":"https://github.com/Azure/azure-rest-api-specs/blob/c1e33fb32e20d4f9a4f5e061ef96c5160be3ae2b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/JavaComponents.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.107/common/temp/node_modules/.pnpm/@Azure+oad@0.10.12/node_modules/autorest/dist/app.js" --v2 --input-file=specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-mhJ1Ld 2: ERROR: Syntax error: unexpected end of the stream within a flow collection 3: - file:///mnt/vss/work/1/azure-rest-api-specs/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdateSpringCloudGateway.json:120:4 4: FATAL: swagger-document/loader - FAILED 5: FATAL: Error: Syntax errors encountered. 6: Error: Syntax errors encountered."

️🔄LintDiff inProgress [Detail]

️❌Avocado: 1 Errors, 0 Warnings failed [Detail]

Rule

Message

❌ JSON_PARSE

The file is not a valid JSON file. json: [preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate_SpringCloudGateway.json"}]({"kind":"structure","code":"unexpected end of file","position":{"line":1,"column":1},"token":"}","message":"unexpected end of file, token: }, line: 1, column: 1","url":"/mnt/vss/_work/1/c93b354fd9c14905bb574a8834c4d69b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate_SpringCloudGateway.json"})

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/c1e33fb32e20d4f9a4f5e061ef96c5160be3ae2b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json"
❌ unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/c1e33fb32e20d4f9a4f5e061ef96c5160be3ae2b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json"

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️⌛PR Summary pending [Detail]

️⌛Automated merging requirements met pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️⌛ azure-sdk-for-python pending [Detail]

️⌛ azure-sdk-for-java pending [Detail]

️⌛ azure-sdk-for-go pending [Detail]

️⌛ azure-sdk-for-js pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

[ramoka178]

Are all files committed as needed ? Only seeing 1 file which as new definitions that are not being used ?

Also, please put the first commit to have the latest swagger you have today. Subsequent commits to have the changes you want to make in this PR. This way, reviewers can check what is changing in this PR .

[Caoxuyang]

Are all files committed as needed ? Only seeing 1 file which as new definitions that are not being used ?

Also, please put the first commit to have the latest swagger you have today. Subsequent commits to have the changes you want to make in this PR. This way, reviewers can check what is changing in this PR .

Okay. Squashed together.

[Caoxuyang]

@ramoka178 It seems that I don't have the permission to edit the labels for my pr. Do you have any clue why this is happening? I used to be able to do so.

[bowen5]

LGTM

[TimLovellSmith]

Want to check, is this an azure resource id or not?

Having a writable 'id' property in an Azure rest api is unusual, except in the context of adding references to other resources. In which case often there are few other properties to configure.

It could be confusing compared to Azure resource ids.

[TimLovellSmith]

Would there be a good alternative name for this property?

[TimLovellSmith]

And maybe I'll have more questions, like what 'scope' is it uniquely identifying things in?

[Caoxuyang]

No it's not a Azure resource ID. It can be values like "route1".

The reason is that this spring cloud gateway is an open source middleware. We want to keep the naming convention with the open source configuration to let customers pick it up easier.

[Caoxuyang]

This is a sample configuration for oss scg:

[TimLovellSmith]

OK, probably the best approach is just to be very explicit in the documentation / description of the property as to what its expected to contain / look like, and e.g. explain what SCG configuration property you're exposing.

[TimLovellSmith]

Declare as "format": "uri" if its an uri, right

[Caoxuyang]

It can be some non url values like "lb:customer-service", which means the gateway will ask the real ip/uri from a service discovery service. So I think string can better surve the case.

[Caoxuyang]

And it maybe consist of other formated "uri"s that I'm not aware of, if the customer is using some other service discovery component to work with the gateway.

[TimLovellSmith]

Hmm. Is "lb:customer-service" an URI? I guess the answer is maybe, 'lb' is not a well-known scheme. But... maybe its well known in SCG context? I have no idea! :-) (yet)

But more to the point, you now appear to be claiming that it is an URI (in the description) and yet also that its not an URI. Surely only one of these can be the truth?