@typespec/http 0.54.0-dev.6 → 0.54.0-dev.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -158,9 +158,9 @@ Specify this property is to be sent or received as an HTTP header.
|
|
|
158
158
|
|
|
159
159
|
##### Parameters
|
|
160
160
|
|
|
161
|
-
| Name | Type
|
|
162
|
-
| ------------------- |
|
|
163
|
-
| headerNameOrOptions | `
|
|
161
|
+
| Name | Type | Description |
|
|
162
|
+
| ------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
163
|
+
| headerNameOrOptions | `string \| TypeSpec.Http.HeaderOptions` | Optional name of the header when sent over HTTP or header options.<br />By default the header name will be the property name converted from camelCase to kebab-case. (e.g. `contentType` -> `content-type`) |
|
|
164
164
|
|
|
165
165
|
##### Examples
|
|
166
166
|
|
|
@@ -196,13 +196,13 @@ Specify if inapplicable metadata should be included in the payload for the given
|
|
|
196
196
|
|
|
197
197
|
##### Target
|
|
198
198
|
|
|
199
|
-
`
|
|
199
|
+
`unknown`
|
|
200
200
|
|
|
201
201
|
##### Parameters
|
|
202
202
|
|
|
203
|
-
| Name | Type
|
|
204
|
-
| ----- |
|
|
205
|
-
| value | `valueof
|
|
203
|
+
| Name | Type | Description |
|
|
204
|
+
| ----- | ----------------- | --------------------------------------------------------------- |
|
|
205
|
+
| value | `valueof boolean` | If true, inapplicable metadata will be included in the payload. |
|
|
206
206
|
|
|
207
207
|
#### `@patch`
|
|
208
208
|
|
|
@@ -240,9 +240,9 @@ Explicitly specify that this property is to be interpolated as a path parameter.
|
|
|
240
240
|
|
|
241
241
|
##### Parameters
|
|
242
242
|
|
|
243
|
-
| Name | Type
|
|
244
|
-
| --------- |
|
|
245
|
-
| paramName | `valueof
|
|
243
|
+
| Name | Type | Description |
|
|
244
|
+
| --------- | ---------------- | --------------------------------------------------- |
|
|
245
|
+
| paramName | `valueof string` | Optional name of the parameter in the url template. |
|
|
246
246
|
|
|
247
247
|
##### Examples
|
|
248
248
|
|
|
@@ -309,9 +309,9 @@ Specify this property is to be sent as a query parameter.
|
|
|
309
309
|
|
|
310
310
|
##### Parameters
|
|
311
311
|
|
|
312
|
-
| Name | Type
|
|
313
|
-
| ------------------ |
|
|
314
|
-
| queryNameOrOptions | `
|
|
312
|
+
| Name | Type | Description |
|
|
313
|
+
| ------------------ | -------------------------------------- | ------------------------------------------------------------------------------- |
|
|
314
|
+
| queryNameOrOptions | `string \| TypeSpec.Http.QueryOptions` | Optional name of the query when included in the url or query parameter options. |
|
|
315
315
|
|
|
316
316
|
##### Examples
|
|
317
317
|
|
|
@@ -342,14 +342,14 @@ it will be used as a prefix to the route URI of the operation.
|
|
|
342
342
|
|
|
343
343
|
##### Target
|
|
344
344
|
|
|
345
|
-
`
|
|
345
|
+
`Namespace | Interface | Operation`
|
|
346
346
|
|
|
347
347
|
##### Parameters
|
|
348
348
|
|
|
349
|
-
| Name | Type
|
|
350
|
-
| ------- |
|
|
351
|
-
| path | `valueof
|
|
352
|
-
| options | `
|
|
349
|
+
| Name | Type | Description |
|
|
350
|
+
| ------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
351
|
+
| path | `valueof string` | Relative route path. Cannot include query parameters. |
|
|
352
|
+
| options | `{...}` | Set of parameters used to configure the route. Supports `{shared: true}` which indicates that the route may be shared by several operations. |
|
|
353
353
|
|
|
354
354
|
##### Examples
|
|
355
355
|
|
|
@@ -372,11 +372,11 @@ Specify the endpoint for this service.
|
|
|
372
372
|
|
|
373
373
|
##### Parameters
|
|
374
374
|
|
|
375
|
-
| Name | Type
|
|
376
|
-
| ----------- |
|
|
377
|
-
| url | `valueof
|
|
378
|
-
| description | `valueof
|
|
379
|
-
| parameters | `
|
|
375
|
+
| Name | Type | Description |
|
|
376
|
+
| ----------- | ----------------- | ------------------------------------------------------- |
|
|
377
|
+
| url | `valueof string` | Server endpoint |
|
|
378
|
+
| description | `valueof string` | Description of the endpoint |
|
|
379
|
+
| parameters | `Record<unknown>` | Optional set of parameters used to interpolate the url. |
|
|
380
380
|
|
|
381
381
|
##### Examples
|
|
382
382
|
|
|
@@ -455,13 +455,13 @@ Specify authentication for a whole service or specific methods. See the [documen
|
|
|
455
455
|
|
|
456
456
|
##### Target
|
|
457
457
|
|
|
458
|
-
`
|
|
458
|
+
`Namespace | Interface | Operation`
|
|
459
459
|
|
|
460
460
|
##### Parameters
|
|
461
461
|
|
|
462
|
-
| Name | Type
|
|
463
|
-
| ---- |
|
|
464
|
-
| auth | `
|
|
462
|
+
| Name | Type | Description |
|
|
463
|
+
| ---- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
464
|
+
| auth | `{} \| Union \| {}[]` | Authentication configuration. Can be a single security scheme, a union(either option is valid authentication) or a tuple (must use all authentication together) |
|
|
465
465
|
|
|
466
466
|
##### Examples
|
|
467
467
|
|