@azure-tools/typespec-azure-core 0.40.0-dev.3 → 0.40.0-dev.5

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.
Files changed (4) hide show
  1. package/README.md +38 -38
  2. package/lib/foundations.tsp +1 -0
  3. package/lib/models.tsp +1 -0
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -102,9 +102,9 @@ Identifies a ModelProperty as containing the final location for the operation re
102
102
 
103
103
  ##### Parameters
104
104
 
105
- | Name | Type | Description |
106
- | ----------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
107
- | finalResult | `union Model \| void` | Sets the expected return value for the final result. Overrides<br />any value provided in the decorated property, if the property uses ResourceLocation<Resource>. |
105
+ | Name | Type | Description |
106
+ | ----------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
107
+ | finalResult | `Model \| void` | Sets the expected return value for the final result. Overrides<br />any value provided in the decorated property, if the property uses ResourceLocation<Resource>. |
108
108
 
109
109
  #### `@finalOperation`
110
110
 
@@ -123,7 +123,7 @@ Identifies that an operation is the final operation for an LRO.
123
123
  | Name | Type | Description |
124
124
  | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- |
125
125
  | linkedOperation | `Operation` | The linked Operation |
126
- | parameters | `model {}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
126
+ | parameters | `{}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
127
127
 
128
128
  #### `@fixed`
129
129
 
@@ -169,7 +169,7 @@ Identifies an EnumMember as a long-running "Canceled" terminal state.
169
169
 
170
170
  ##### Target
171
171
 
172
- `union EnumMember | UnionVariant`
172
+ `EnumMember | UnionVariant`
173
173
 
174
174
  ##### Parameters
175
175
 
@@ -204,7 +204,7 @@ Identifies an enum member as a long-running "Failed" terminal state.
204
204
 
205
205
  ##### Target
206
206
 
207
- `union EnumMember | UnionVariant`
207
+ `EnumMember | UnionVariant`
208
208
 
209
209
  ##### Parameters
210
210
 
@@ -240,7 +240,7 @@ status.
240
240
 
241
241
  ##### Target
242
242
 
243
- `union Enum | Union | ModelProperty`
243
+ `Enum | Union | ModelProperty`
244
244
 
245
245
  ##### Parameters
246
246
 
@@ -257,7 +257,7 @@ Identifies an EnumMember as a long-running "Succeeded" terminal state.
257
257
 
258
258
  ##### Target
259
259
 
260
- `union EnumMember | UnionVariant`
260
+ `EnumMember | UnionVariant`
261
261
 
262
262
  ##### Parameters
263
263
 
@@ -296,7 +296,7 @@ Identifies that an operation is used to retrieve the next page for paged operati
296
296
  | Name | Type | Description |
297
297
  | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- |
298
298
  | linkedOperation | `Operation` | The linked Operation |
299
- | parameters | `model {}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
299
+ | parameters | `{}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
300
300
 
301
301
  #### `@operationLink`
302
302
 
@@ -312,11 +312,11 @@ Identifies an operation that is linked to the target operation.
312
312
 
313
313
  ##### Parameters
314
314
 
315
- | Name | Type | Description |
316
- | --------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- |
317
- | linkedOperation | `Operation` | The linked Operation |
318
- | linkType | `valueof scalar string` | A string indicating the role of the linked operation |
319
- | parameters | `model {}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
315
+ | Name | Type | Description |
316
+ | --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------- |
317
+ | linkedOperation | `Operation` | The linked Operation |
318
+ | linkType | `valueof string` | A string indicating the role of the linked operation |
319
+ | parameters | `{}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
320
320
 
321
321
  #### `@pagedResult`
322
322
 
@@ -348,9 +348,9 @@ Identifies a model property as containing the location to poll for operation sta
348
348
 
349
349
  ##### Parameters
350
350
 
351
- | Name | Type | Description |
352
- | ------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
353
- | options | `model Azure.Core.PollingOptions` | PollingOptions for the poller pointed to by this link. Overrides<br />settings derived from property value it is decorating, if the value of the<br />property is ResourceLocation<Resource> |
351
+ | Name | Type | Description |
352
+ | ------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
353
+ | options | [`PollingOptions`](#pollingoptions) | PollingOptions for the poller pointed to by this link. Overrides<br />settings derived from property value it is decorating, if the value of the<br />property is ResourceLocation<Resource> |
354
354
 
355
355
  #### `@pollingOperation`
356
356
 
@@ -369,7 +369,7 @@ Identifies that an operation is a polling operation for an LRO.
369
369
  | Name | Type | Description |
370
370
  | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- |
371
371
  | linkedOperation | `Operation` | The linked Operation |
372
- | parameters | `model {}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
372
+ | parameters | `{}` | Map of `RequestParameter<Name>` and/or `ResponseProperty<Name>` that will<br />be passed to the linked operation request. |
373
373
 
374
374
  #### `@pollingOperationParameter`
375
375
 
@@ -385,9 +385,9 @@ Used to define how to call custom polling operations for long-running operations
385
385
 
386
386
  ##### Parameters
387
387
 
388
- | Name | Type | Description |
389
- | --------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
390
- | targetParameter | `union ModelProperty \| string` | A reference to the polling operation parameter this parameter<br />provides a value for, or the name of that parameter. The default value is the name of<br />the decorated parameter or property. |
388
+ | Name | Type | Description |
389
+ | --------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
390
+ | targetParameter | `ModelProperty \| string` | A reference to the polling operation parameter this parameter<br />provides a value for, or the name of that parameter. The default value is the name of<br />the decorated parameter or property. |
391
391
 
392
392
  ### Azure.Core.Foundations
393
393
 
@@ -425,9 +425,9 @@ Identifies a property on a request model that serves as a linked operation param
425
425
 
426
426
  ##### Parameters
427
427
 
428
- | Name | Type | Description |
429
- | ---- | ----------------------- | --------------------------- |
430
- | name | `valueof scalar string` | Property name on the target |
428
+ | Name | Type | Description |
429
+ | ---- | ---------------- | --------------------------- |
430
+ | name | `valueof string` | Property name on the target |
431
431
 
432
432
  #### `@responseProperty`
433
433
 
@@ -443,9 +443,9 @@ Identifies a property on _all_ non-error response models that serve as a linked
443
443
 
444
444
  ##### Parameters
445
445
 
446
- | Name | Type | Description |
447
- | ---- | ----------------------- | --------------------------- |
448
- | name | `valueof scalar string` | Property name on the target |
446
+ | Name | Type | Description |
447
+ | ---- | ---------------- | --------------------------- |
448
+ | name | `valueof string` | Property name on the target |
449
449
 
450
450
  ### Azure.Core.Traits
451
451
 
@@ -466,13 +466,13 @@ checks.
466
466
  ##### Target
467
467
 
468
468
  The model type to mark as a trait.
469
- `(intrinsic) unknown`
469
+ `unknown`
470
470
 
471
471
  ##### Parameters
472
472
 
473
- | Name | Type | Description |
474
- | --------- | ----------------------- | -------------------------------------------------------------------------------------------------- |
475
- | traitName | `valueof scalar string` | An optional name to uniquely identify the trait. If unspecified,<br />the model type name is used. |
473
+ | Name | Type | Description |
474
+ | --------- | ---------------- | -------------------------------------------------------------------------------------------------- |
475
+ | traitName | `valueof string` | An optional name to uniquely identify the trait. If unspecified,<br />the model type name is used. |
476
476
 
477
477
  #### `@traitAdded`
478
478
 
@@ -485,13 +485,13 @@ to either a trait model type or its envelope property.
485
485
 
486
486
  ##### Target
487
487
 
488
- `union Model | ModelProperty`
488
+ `Model | ModelProperty`
489
489
 
490
490
  ##### Parameters
491
491
 
492
- | Name | Type | Description |
493
- | ------------ | -------------------------- | ------------------------------------------------- |
494
- | addedVersion | `union EnumMember \| null` | The enum member representing the service version. |
492
+ | Name | Type | Description |
493
+ | ------------ | -------------------- | ------------------------------------------------- |
494
+ | addedVersion | `EnumMember \| null` | The enum member representing the service version. |
495
495
 
496
496
  #### `@traitContext`
497
497
 
@@ -508,9 +508,9 @@ The trait envelope property where the context will be applied.
508
508
 
509
509
  ##### Parameters
510
510
 
511
- | Name | Type | Description |
512
- | -------- | -------------------------------------- | ------------------------------------------------------------------------------------------ |
513
- | contexts | `union EnumMember \| Union \| unknown` | An enum member or union of enum members representing the trait's<br />applicable contexts. |
511
+ | Name | Type | Description |
512
+ | -------- | -------------------------------- | ------------------------------------------------------------------------------------------ |
513
+ | contexts | `EnumMember \| Union \| unknown` | An enum member or union of enum members representing the trait's<br />applicable contexts. |
514
514
 
515
515
  #### `@traitLocation`
516
516
 
package/lib/foundations.tsp CHANGED
@@ -251,6 +251,7 @@ model CustomPage<
251
251
 
252
252
  @doc("The link to the next page of items")
253
253
  @nextLink
254
+ @visibility("read")
254
255
  nextLink?: ResourceLocation<Resource>;
255
256
 
256
257
  // Include custom response fields
package/lib/models.tsp CHANGED
@@ -21,6 +21,7 @@ model Page<Resource extends TypeSpec.Reflection.Model> {
21
21
 
22
22
  @doc("The link to the next page of items")
23
23
  @nextLink
24
+ @visibility("read")
24
25
  nextLink?: ResourceLocation<Resource>;
25
26
  }
26
27
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@azure-tools/typespec-azure-core",
3
- "version": "0.40.0-dev.3",
3
+ "version": "0.40.0-dev.5",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "TypeSpec Azure Core library",
6
6
  "homepage": "https://azure.github.io/typespec-azure",