Support explode in Query

[lmazuel]

Support of:

@route("/c1/here") op c1(@query(#{ explode: true }) foo: string[]): void;

to mean that the url should explode the query parameter, for instance here foo=a&foo=b if we pass ["a","b"] at the SDK level.

TypeSpec

Beta Give feedback

1. URI templates support microsoft/typespec#3736
   compiler:core deprecation design:accepted lib:http +4
   

Spec

Beta Give feedback

1. Support explode in Query Scenario tests cadl-ranch#666
   +0
2. Support explode in Query TCGC Author doc #1319
   docs lib:tcgc +2
   

Implementation

Beta Give feedback

1. Support explode in Query TCGC Implementation #1320
   lib:tcgc +1
   
2. Support explode in Query Implementation autorest.python#2755
   +0
   
3. Support explode in Query Implementation autorest.java#2897
   +0
   
4. Support explode in Query Implementation autorest.typescript#2735
   0 of 3
   HRLC RLC p0 +3
   
5. Support explode in Query Implementation autorest.csharp#4967
   DPG DPG/RLC v2.1 +2
   
6. Support explode in Query Implementation autorest.go#1423
   +0
   
7. https://github.com/Azure/autorest.cpp/issues/374
8. https://github.com/Azure/autorest.rust/issues/83

[tadelesh]

also this feature could cover the following uri template case:

@route("/action{?name*}") op action(name: string[]): void;

[MaryGao]

@lmazuel I want to clarify the scopes for this feature. According to uri temlate design, I think we mainly have below cases.

• explode: true/false
• serialized object: array/object/primitive
• optionality: optional/required

Are they all in scope of this issue?

Also there are some legacy cases which are moved from format to encode, we have some cadl-ranch cases to cover array's serliazation, but for object I guest it is not ready yet(at least for JS).

Are all workable cases in scope or only cases of cadl-ranch having in scope?

[lmazuel]

"explode" just means this:

• explode: true => a=1&a=2
• explode: false => a=1,2

This is orthogonale to how you serialize an array, an object, or a primitive. You should already have those scenarios covered, independently of "explode"

As of today, TypeSpec implies CSV (comma separated), it's not in scope to discuss pipe or space. DeepObject is not in scope either.

Optionality or required has nothing to do with the feature (the query parameter can be optional or required, it doesn't impact the value). Explode is about the value, not the optionality or not of the query key.

[lmazuel]

Additional note about after a comment I saw on the cadl-ranch PR, if "explode" is used on a non-array parameter, it's just ignored. The way url template RFC is written, given people could use a union like string | string[] and therefore there are scenario when it may be possible that a primitive type is associated with "explode". This is ok, just the explode should be ignored (not a failure)