@azure-tools/typespec-azure-core 0.45.0-dev.2 → 0.45.0-dev.4

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 (20) hide show
  1. package/dist/src/lib.d.ts +195 -195
  2. package/dist/src/rules/byos.d.ts +1 -1
  3. package/dist/src/rules/casing.d.ts +1 -1
  4. package/dist/src/rules/composition-over-inheritance.d.ts +2 -2
  5. package/dist/src/rules/friendly-name.d.ts +1 -1
  6. package/dist/src/rules/known-encoding.d.ts +1 -1
  7. package/dist/src/rules/no-generic-numeric.d.ts +2 -2
  8. package/dist/src/rules/no-string-discriminator.d.ts +1 -1
  9. package/dist/src/rules/non-breaking-versioning.d.ts +1 -1
  10. package/dist/src/rules/prevent-multiple-discriminator.d.ts +1 -1
  11. package/dist/src/rules/property-naming.d.ts +1 -1
  12. package/dist/src/rules/record-types.d.ts +2 -2
  13. package/dist/src/rules/require-docs.d.ts +1 -1
  14. package/dist/src/rules/require-key-visibility.d.ts +1 -1
  15. package/dist/src/rules/response-schema-multi-status-code.d.ts +1 -1
  16. package/dist/src/rules/rpc-operation-request-body.d.ts +1 -1
  17. package/dist/src/rules/spread-discriminated-model.d.ts +1 -1
  18. package/dist/src/rules/use-standard-ops.d.ts +1 -1
  19. package/lib/models.tsp +11 -4
  20. package/package.json +6 -6
package/dist/src/lib.d.ts CHANGED
@@ -1,553 +1,553 @@
1
1
  export declare const $lib: import("@typespec/compiler").TypeSpecLibrary<{
2
2
  "lro-status-union-non-string": {
3
- default: import("@typespec/compiler").CallableMessage<[string]>;
3
+ readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
4
4
  };
5
5
  "lro-status-property-invalid-type": {
6
- default: string;
6
+ readonly default: "Property type must be a union of strings or an enum.";
7
7
  };
8
8
  "lro-status-missing": {
9
- default: import("@typespec/compiler").CallableMessage<[string]>;
9
+ readonly default: import("@typespec/compiler").CallableMessage<["states"]>;
10
10
  };
11
11
  "lro-status-monitor-invalid-result-property": {
12
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
12
+ readonly default: import("@typespec/compiler").CallableMessage<["resultType", "decorator"]>;
13
13
  };
14
14
  "invalid-final-state": {
15
- badValue: import("@typespec/compiler").CallableMessage<[string]>;
16
- notPut: string;
17
- noHeader: import("@typespec/compiler").CallableMessage<[string]>;
15
+ readonly badValue: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
16
+ readonly notPut: "The final state value 'original-uri' can only be used in http PUT operations";
17
+ readonly noHeader: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
18
18
  };
19
19
  "bad-record-type": {
20
- extendUnknown: import("@typespec/compiler").CallableMessage<[string, string, string, string]>;
21
- recordWithProperties: import("@typespec/compiler").CallableMessage<[string, string, string]>;
20
+ readonly extendUnknown: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName", "keyword"]>;
21
+ readonly recordWithProperties: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName"]>;
22
22
  };
23
23
  "request-parameter-invalid": {
24
- default: import("@typespec/compiler").CallableMessage<[string]>;
24
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
25
25
  };
26
26
  "response-property-invalid": {
27
- default: import("@typespec/compiler").CallableMessage<[string]>;
27
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
28
28
  };
29
29
  "operation-link-parameter-invalid": {
30
- default: string;
30
+ readonly default: "Parameters must be of template type RequestParameter<T> or ResponseProperty<T>.";
31
31
  };
32
32
  "operation-link-parameter-invalid-target": {
33
- default: import("@typespec/compiler").CallableMessage<[string]>;
33
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
34
34
  };
35
35
  "invalid-resource-type": {
36
- missingKey: import("@typespec/compiler").CallableMessage<[string]>;
37
- missingSegment: import("@typespec/compiler").CallableMessage<[string]>;
36
+ readonly missingKey: import("@typespec/compiler").CallableMessage<["name"]>;
37
+ readonly missingSegment: import("@typespec/compiler").CallableMessage<["name"]>;
38
38
  };
39
39
  "polling-operation-return-model": {
40
- default: string;
40
+ readonly default: "An operation annotated with @pollingOperation must return a model or union of model.";
41
41
  };
42
42
  "polling-operation-no-status-monitor": {
43
- default: string;
43
+ readonly default: "The operation linked in @pollingOperation must return a valid status monitor. The status monitor model must contain a 'status' property, or a property decorated with '@lroStatus'. The status field must be of Enum or Union type and contain terminal status values for success and failure.";
44
44
  };
45
45
  "polling-operation-no-lro-success": {
46
- default: string;
46
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates successful completion. This known value may be named 'Succeeded' or marked with the '@lroSucceeded' decorator.";
47
47
  };
48
48
  "polling-operation-no-lro-failure": {
49
- default: string;
49
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates failure. This known value may be named 'Failed' or marked with the '@lroFailed' decorator.";
50
50
  };
51
51
  "polling-operation-no-ref-or-link": {
52
- default: string;
52
+ readonly default: "An operation decorated with '@pollingOperation' must either return a response with an 'Operation-Location' header that will contain a runtime link to the polling operation, or specify parameters and return type properties to map into the polling operation parameters. A map into polling operation parameters can be created using the '@pollingOperationParameter' decorator";
53
53
  };
54
54
  "invalid-final-operation": {
55
- default: string;
55
+ readonly default: "The operation linked in the '@finalOperation' decorator must have a 200 response that includes a model.";
56
56
  };
57
57
  "invalid-trait-property-count": {
58
- default: import("@typespec/compiler").CallableMessage<[string]>;
58
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
59
59
  };
60
60
  "invalid-trait-property-type": {
61
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
61
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
62
62
  };
63
63
  "invalid-trait-context": {
64
- default: string;
64
+ readonly default: "The trait context can only be an enum member, union of enum members, or `unknown`.";
65
65
  };
66
66
  "trait-property-without-location": {
67
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
67
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
68
68
  };
69
69
  "expected-trait-missing": {
70
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
70
+ readonly default: import("@typespec/compiler").CallableMessage<["trait", "message"]>;
71
71
  };
72
72
  "client-request-id-trait-missing": {
73
- default: import("@typespec/compiler").CallableMessage<[]>;
73
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
74
74
  };
75
75
  "repeatable-requests-trait-missing": {
76
- default: import("@typespec/compiler").CallableMessage<[]>;
76
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
77
77
  };
78
78
  "conditional-requests-trait-missing": {
79
- default: import("@typespec/compiler").CallableMessage<[]>;
79
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
80
80
  };
81
81
  "expected-trait-diagnostic-missing": {
82
- default: string;
82
+ readonly default: "Expected trait entries must have a \"diagnostic\" field with a valid diagnostic code for the missing trait.";
83
83
  };
84
84
  "invalid-parameter": {
85
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
85
+ readonly default: import("@typespec/compiler").CallableMessage<["propertyName", "kind"]>;
86
86
  };
87
87
  "expected-success-response": {
88
- default: string;
88
+ readonly default: "The operation must have a success response";
89
89
  };
90
90
  "lro-polling-data-missing-from-operation-response": {
91
- default: string;
91
+ readonly default: "At least one operation response must contain a field marked with `@lroStatus`";
92
92
  };
93
93
  "no-object": {
94
- default: string;
94
+ readonly default: "Don't use 'object'.\n - If you want an object with any properties, use `Record<unknown>`\n - If you meant anything, use `unknown`.";
95
95
  };
96
96
  "verb-conflict": {
97
- default: import("@typespec/compiler").CallableMessage<[string, string, string]>;
97
+ readonly default: import("@typespec/compiler").CallableMessage<["templateName", "requiredVerb", "verb"]>;
98
98
  };
99
99
  "rpc-operation-needs-route": {
100
- default: string;
100
+ readonly default: "The operation needs a @route";
101
101
  };
102
102
  "union-enums-multiple-kind": {
103
- default: import("@typespec/compiler").CallableMessage<[string]>;
103
+ readonly default: import("@typespec/compiler").CallableMessage<["kinds"]>;
104
104
  };
105
105
  "union-enums-invalid-kind": {
106
- default: import("@typespec/compiler").CallableMessage<[string]>;
106
+ readonly default: import("@typespec/compiler").CallableMessage<["kind"]>;
107
107
  };
108
108
  "union-enums-circular": {
109
- default: string;
109
+ readonly default: "Union is referencing itself and cannot be resolved as an enum.";
110
110
  };
111
111
  }, Record<string, any>, "items" | "fixed" | "trait" | "pagedResult" | "nextLink" | "lroStatus" | "lroSucceeded" | "lroCanceled" | "lroFailed" | "lroResult" | "lroErrorResult" | "pollingOperationParameter" | "pollingLocationInfo" | "finalLocations" | "finalLocationResults" | "finalStateOverride" | "needsRoute" | "ensureVerb" | "embeddingVector" | "armResourceIdentifierConfig" | "operationLink" | "requestParameter" | "responseParameter" | "resourceOperation" | "traitSource" | "traitContext" | "traitLocation">;
112
112
  export declare const reportDiagnostic: <C extends "lro-status-union-non-string" | "lro-status-property-invalid-type" | "lro-status-missing" | "lro-status-monitor-invalid-result-property" | "invalid-final-state" | "bad-record-type" | "request-parameter-invalid" | "response-property-invalid" | "operation-link-parameter-invalid" | "operation-link-parameter-invalid-target" | "invalid-resource-type" | "polling-operation-return-model" | "polling-operation-no-status-monitor" | "polling-operation-no-lro-success" | "polling-operation-no-lro-failure" | "polling-operation-no-ref-or-link" | "invalid-final-operation" | "invalid-trait-property-count" | "invalid-trait-property-type" | "invalid-trait-context" | "trait-property-without-location" | "expected-trait-missing" | "client-request-id-trait-missing" | "repeatable-requests-trait-missing" | "conditional-requests-trait-missing" | "expected-trait-diagnostic-missing" | "invalid-parameter" | "expected-success-response" | "lro-polling-data-missing-from-operation-response" | "no-object" | "verb-conflict" | "rpc-operation-needs-route" | "union-enums-multiple-kind" | "union-enums-invalid-kind" | "union-enums-circular", M extends keyof {
113
113
  "lro-status-union-non-string": {
114
- default: import("@typespec/compiler").CallableMessage<[string]>;
114
+ readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
115
115
  };
116
116
  "lro-status-property-invalid-type": {
117
- default: string;
117
+ readonly default: "Property type must be a union of strings or an enum.";
118
118
  };
119
119
  "lro-status-missing": {
120
- default: import("@typespec/compiler").CallableMessage<[string]>;
120
+ readonly default: import("@typespec/compiler").CallableMessage<["states"]>;
121
121
  };
122
122
  "lro-status-monitor-invalid-result-property": {
123
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
123
+ readonly default: import("@typespec/compiler").CallableMessage<["resultType", "decorator"]>;
124
124
  };
125
125
  "invalid-final-state": {
126
- badValue: import("@typespec/compiler").CallableMessage<[string]>;
127
- notPut: string;
128
- noHeader: import("@typespec/compiler").CallableMessage<[string]>;
126
+ readonly badValue: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
127
+ readonly notPut: "The final state value 'original-uri' can only be used in http PUT operations";
128
+ readonly noHeader: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
129
129
  };
130
130
  "bad-record-type": {
131
- extendUnknown: import("@typespec/compiler").CallableMessage<[string, string, string, string]>;
132
- recordWithProperties: import("@typespec/compiler").CallableMessage<[string, string, string]>;
131
+ readonly extendUnknown: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName", "keyword"]>;
132
+ readonly recordWithProperties: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName"]>;
133
133
  };
134
134
  "request-parameter-invalid": {
135
- default: import("@typespec/compiler").CallableMessage<[string]>;
135
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
136
136
  };
137
137
  "response-property-invalid": {
138
- default: import("@typespec/compiler").CallableMessage<[string]>;
138
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
139
139
  };
140
140
  "operation-link-parameter-invalid": {
141
- default: string;
141
+ readonly default: "Parameters must be of template type RequestParameter<T> or ResponseProperty<T>.";
142
142
  };
143
143
  "operation-link-parameter-invalid-target": {
144
- default: import("@typespec/compiler").CallableMessage<[string]>;
144
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
145
145
  };
146
146
  "invalid-resource-type": {
147
- missingKey: import("@typespec/compiler").CallableMessage<[string]>;
148
- missingSegment: import("@typespec/compiler").CallableMessage<[string]>;
147
+ readonly missingKey: import("@typespec/compiler").CallableMessage<["name"]>;
148
+ readonly missingSegment: import("@typespec/compiler").CallableMessage<["name"]>;
149
149
  };
150
150
  "polling-operation-return-model": {
151
- default: string;
151
+ readonly default: "An operation annotated with @pollingOperation must return a model or union of model.";
152
152
  };
153
153
  "polling-operation-no-status-monitor": {
154
- default: string;
154
+ readonly default: "The operation linked in @pollingOperation must return a valid status monitor. The status monitor model must contain a 'status' property, or a property decorated with '@lroStatus'. The status field must be of Enum or Union type and contain terminal status values for success and failure.";
155
155
  };
156
156
  "polling-operation-no-lro-success": {
157
- default: string;
157
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates successful completion. This known value may be named 'Succeeded' or marked with the '@lroSucceeded' decorator.";
158
158
  };
159
159
  "polling-operation-no-lro-failure": {
160
- default: string;
160
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates failure. This known value may be named 'Failed' or marked with the '@lroFailed' decorator.";
161
161
  };
162
162
  "polling-operation-no-ref-or-link": {
163
- default: string;
163
+ readonly default: "An operation decorated with '@pollingOperation' must either return a response with an 'Operation-Location' header that will contain a runtime link to the polling operation, or specify parameters and return type properties to map into the polling operation parameters. A map into polling operation parameters can be created using the '@pollingOperationParameter' decorator";
164
164
  };
165
165
  "invalid-final-operation": {
166
- default: string;
166
+ readonly default: "The operation linked in the '@finalOperation' decorator must have a 200 response that includes a model.";
167
167
  };
168
168
  "invalid-trait-property-count": {
169
- default: import("@typespec/compiler").CallableMessage<[string]>;
169
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
170
170
  };
171
171
  "invalid-trait-property-type": {
172
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
172
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
173
173
  };
174
174
  "invalid-trait-context": {
175
- default: string;
175
+ readonly default: "The trait context can only be an enum member, union of enum members, or `unknown`.";
176
176
  };
177
177
  "trait-property-without-location": {
178
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
178
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
179
179
  };
180
180
  "expected-trait-missing": {
181
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
181
+ readonly default: import("@typespec/compiler").CallableMessage<["trait", "message"]>;
182
182
  };
183
183
  "client-request-id-trait-missing": {
184
- default: import("@typespec/compiler").CallableMessage<[]>;
184
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
185
185
  };
186
186
  "repeatable-requests-trait-missing": {
187
- default: import("@typespec/compiler").CallableMessage<[]>;
187
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
188
188
  };
189
189
  "conditional-requests-trait-missing": {
190
- default: import("@typespec/compiler").CallableMessage<[]>;
190
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
191
191
  };
192
192
  "expected-trait-diagnostic-missing": {
193
- default: string;
193
+ readonly default: "Expected trait entries must have a \"diagnostic\" field with a valid diagnostic code for the missing trait.";
194
194
  };
195
195
  "invalid-parameter": {
196
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
196
+ readonly default: import("@typespec/compiler").CallableMessage<["propertyName", "kind"]>;
197
197
  };
198
198
  "expected-success-response": {
199
- default: string;
199
+ readonly default: "The operation must have a success response";
200
200
  };
201
201
  "lro-polling-data-missing-from-operation-response": {
202
- default: string;
202
+ readonly default: "At least one operation response must contain a field marked with `@lroStatus`";
203
203
  };
204
204
  "no-object": {
205
- default: string;
205
+ readonly default: "Don't use 'object'.\n - If you want an object with any properties, use `Record<unknown>`\n - If you meant anything, use `unknown`.";
206
206
  };
207
207
  "verb-conflict": {
208
- default: import("@typespec/compiler").CallableMessage<[string, string, string]>;
208
+ readonly default: import("@typespec/compiler").CallableMessage<["templateName", "requiredVerb", "verb"]>;
209
209
  };
210
210
  "rpc-operation-needs-route": {
211
- default: string;
211
+ readonly default: "The operation needs a @route";
212
212
  };
213
213
  "union-enums-multiple-kind": {
214
- default: import("@typespec/compiler").CallableMessage<[string]>;
214
+ readonly default: import("@typespec/compiler").CallableMessage<["kinds"]>;
215
215
  };
216
216
  "union-enums-invalid-kind": {
217
- default: import("@typespec/compiler").CallableMessage<[string]>;
217
+ readonly default: import("@typespec/compiler").CallableMessage<["kind"]>;
218
218
  };
219
219
  "union-enums-circular": {
220
- default: string;
220
+ readonly default: "Union is referencing itself and cannot be resolved as an enum.";
221
221
  };
222
222
  }[C]>(program: import("@typespec/compiler").Program, diag: import("@typespec/compiler").DiagnosticReport<{
223
223
  "lro-status-union-non-string": {
224
- default: import("@typespec/compiler").CallableMessage<[string]>;
224
+ readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
225
225
  };
226
226
  "lro-status-property-invalid-type": {
227
- default: string;
227
+ readonly default: "Property type must be a union of strings or an enum.";
228
228
  };
229
229
  "lro-status-missing": {
230
- default: import("@typespec/compiler").CallableMessage<[string]>;
230
+ readonly default: import("@typespec/compiler").CallableMessage<["states"]>;
231
231
  };
232
232
  "lro-status-monitor-invalid-result-property": {
233
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
233
+ readonly default: import("@typespec/compiler").CallableMessage<["resultType", "decorator"]>;
234
234
  };
235
235
  "invalid-final-state": {
236
- badValue: import("@typespec/compiler").CallableMessage<[string]>;
237
- notPut: string;
238
- noHeader: import("@typespec/compiler").CallableMessage<[string]>;
236
+ readonly badValue: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
237
+ readonly notPut: "The final state value 'original-uri' can only be used in http PUT operations";
238
+ readonly noHeader: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
239
239
  };
240
240
  "bad-record-type": {
241
- extendUnknown: import("@typespec/compiler").CallableMessage<[string, string, string, string]>;
242
- recordWithProperties: import("@typespec/compiler").CallableMessage<[string, string, string]>;
241
+ readonly extendUnknown: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName", "keyword"]>;
242
+ readonly recordWithProperties: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName"]>;
243
243
  };
244
244
  "request-parameter-invalid": {
245
- default: import("@typespec/compiler").CallableMessage<[string]>;
245
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
246
246
  };
247
247
  "response-property-invalid": {
248
- default: import("@typespec/compiler").CallableMessage<[string]>;
248
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
249
249
  };
250
250
  "operation-link-parameter-invalid": {
251
- default: string;
251
+ readonly default: "Parameters must be of template type RequestParameter<T> or ResponseProperty<T>.";
252
252
  };
253
253
  "operation-link-parameter-invalid-target": {
254
- default: import("@typespec/compiler").CallableMessage<[string]>;
254
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
255
255
  };
256
256
  "invalid-resource-type": {
257
- missingKey: import("@typespec/compiler").CallableMessage<[string]>;
258
- missingSegment: import("@typespec/compiler").CallableMessage<[string]>;
257
+ readonly missingKey: import("@typespec/compiler").CallableMessage<["name"]>;
258
+ readonly missingSegment: import("@typespec/compiler").CallableMessage<["name"]>;
259
259
  };
260
260
  "polling-operation-return-model": {
261
- default: string;
261
+ readonly default: "An operation annotated with @pollingOperation must return a model or union of model.";
262
262
  };
263
263
  "polling-operation-no-status-monitor": {
264
- default: string;
264
+ readonly default: "The operation linked in @pollingOperation must return a valid status monitor. The status monitor model must contain a 'status' property, or a property decorated with '@lroStatus'. The status field must be of Enum or Union type and contain terminal status values for success and failure.";
265
265
  };
266
266
  "polling-operation-no-lro-success": {
267
- default: string;
267
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates successful completion. This known value may be named 'Succeeded' or marked with the '@lroSucceeded' decorator.";
268
268
  };
269
269
  "polling-operation-no-lro-failure": {
270
- default: string;
270
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates failure. This known value may be named 'Failed' or marked with the '@lroFailed' decorator.";
271
271
  };
272
272
  "polling-operation-no-ref-or-link": {
273
- default: string;
273
+ readonly default: "An operation decorated with '@pollingOperation' must either return a response with an 'Operation-Location' header that will contain a runtime link to the polling operation, or specify parameters and return type properties to map into the polling operation parameters. A map into polling operation parameters can be created using the '@pollingOperationParameter' decorator";
274
274
  };
275
275
  "invalid-final-operation": {
276
- default: string;
276
+ readonly default: "The operation linked in the '@finalOperation' decorator must have a 200 response that includes a model.";
277
277
  };
278
278
  "invalid-trait-property-count": {
279
- default: import("@typespec/compiler").CallableMessage<[string]>;
279
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
280
280
  };
281
281
  "invalid-trait-property-type": {
282
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
282
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
283
283
  };
284
284
  "invalid-trait-context": {
285
- default: string;
285
+ readonly default: "The trait context can only be an enum member, union of enum members, or `unknown`.";
286
286
  };
287
287
  "trait-property-without-location": {
288
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
288
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
289
289
  };
290
290
  "expected-trait-missing": {
291
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
291
+ readonly default: import("@typespec/compiler").CallableMessage<["trait", "message"]>;
292
292
  };
293
293
  "client-request-id-trait-missing": {
294
- default: import("@typespec/compiler").CallableMessage<[]>;
294
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
295
295
  };
296
296
  "repeatable-requests-trait-missing": {
297
- default: import("@typespec/compiler").CallableMessage<[]>;
297
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
298
298
  };
299
299
  "conditional-requests-trait-missing": {
300
- default: import("@typespec/compiler").CallableMessage<[]>;
300
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
301
301
  };
302
302
  "expected-trait-diagnostic-missing": {
303
- default: string;
303
+ readonly default: "Expected trait entries must have a \"diagnostic\" field with a valid diagnostic code for the missing trait.";
304
304
  };
305
305
  "invalid-parameter": {
306
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
306
+ readonly default: import("@typespec/compiler").CallableMessage<["propertyName", "kind"]>;
307
307
  };
308
308
  "expected-success-response": {
309
- default: string;
309
+ readonly default: "The operation must have a success response";
310
310
  };
311
311
  "lro-polling-data-missing-from-operation-response": {
312
- default: string;
312
+ readonly default: "At least one operation response must contain a field marked with `@lroStatus`";
313
313
  };
314
314
  "no-object": {
315
- default: string;
315
+ readonly default: "Don't use 'object'.\n - If you want an object with any properties, use `Record<unknown>`\n - If you meant anything, use `unknown`.";
316
316
  };
317
317
  "verb-conflict": {
318
- default: import("@typespec/compiler").CallableMessage<[string, string, string]>;
318
+ readonly default: import("@typespec/compiler").CallableMessage<["templateName", "requiredVerb", "verb"]>;
319
319
  };
320
320
  "rpc-operation-needs-route": {
321
- default: string;
321
+ readonly default: "The operation needs a @route";
322
322
  };
323
323
  "union-enums-multiple-kind": {
324
- default: import("@typespec/compiler").CallableMessage<[string]>;
324
+ readonly default: import("@typespec/compiler").CallableMessage<["kinds"]>;
325
325
  };
326
326
  "union-enums-invalid-kind": {
327
- default: import("@typespec/compiler").CallableMessage<[string]>;
327
+ readonly default: import("@typespec/compiler").CallableMessage<["kind"]>;
328
328
  };
329
329
  "union-enums-circular": {
330
- default: string;
330
+ readonly default: "Union is referencing itself and cannot be resolved as an enum.";
331
331
  };
332
332
  }, C, M>) => void, createDiagnostic: <C extends "lro-status-union-non-string" | "lro-status-property-invalid-type" | "lro-status-missing" | "lro-status-monitor-invalid-result-property" | "invalid-final-state" | "bad-record-type" | "request-parameter-invalid" | "response-property-invalid" | "operation-link-parameter-invalid" | "operation-link-parameter-invalid-target" | "invalid-resource-type" | "polling-operation-return-model" | "polling-operation-no-status-monitor" | "polling-operation-no-lro-success" | "polling-operation-no-lro-failure" | "polling-operation-no-ref-or-link" | "invalid-final-operation" | "invalid-trait-property-count" | "invalid-trait-property-type" | "invalid-trait-context" | "trait-property-without-location" | "expected-trait-missing" | "client-request-id-trait-missing" | "repeatable-requests-trait-missing" | "conditional-requests-trait-missing" | "expected-trait-diagnostic-missing" | "invalid-parameter" | "expected-success-response" | "lro-polling-data-missing-from-operation-response" | "no-object" | "verb-conflict" | "rpc-operation-needs-route" | "union-enums-multiple-kind" | "union-enums-invalid-kind" | "union-enums-circular", M extends keyof {
333
333
  "lro-status-union-non-string": {
334
- default: import("@typespec/compiler").CallableMessage<[string]>;
334
+ readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
335
335
  };
336
336
  "lro-status-property-invalid-type": {
337
- default: string;
337
+ readonly default: "Property type must be a union of strings or an enum.";
338
338
  };
339
339
  "lro-status-missing": {
340
- default: import("@typespec/compiler").CallableMessage<[string]>;
340
+ readonly default: import("@typespec/compiler").CallableMessage<["states"]>;
341
341
  };
342
342
  "lro-status-monitor-invalid-result-property": {
343
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
343
+ readonly default: import("@typespec/compiler").CallableMessage<["resultType", "decorator"]>;
344
344
  };
345
345
  "invalid-final-state": {
346
- badValue: import("@typespec/compiler").CallableMessage<[string]>;
347
- notPut: string;
348
- noHeader: import("@typespec/compiler").CallableMessage<[string]>;
346
+ readonly badValue: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
347
+ readonly notPut: "The final state value 'original-uri' can only be used in http PUT operations";
348
+ readonly noHeader: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
349
349
  };
350
350
  "bad-record-type": {
351
- extendUnknown: import("@typespec/compiler").CallableMessage<[string, string, string, string]>;
352
- recordWithProperties: import("@typespec/compiler").CallableMessage<[string, string, string]>;
351
+ readonly extendUnknown: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName", "keyword"]>;
352
+ readonly recordWithProperties: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName"]>;
353
353
  };
354
354
  "request-parameter-invalid": {
355
- default: import("@typespec/compiler").CallableMessage<[string]>;
355
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
356
356
  };
357
357
  "response-property-invalid": {
358
- default: import("@typespec/compiler").CallableMessage<[string]>;
358
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
359
359
  };
360
360
  "operation-link-parameter-invalid": {
361
- default: string;
361
+ readonly default: "Parameters must be of template type RequestParameter<T> or ResponseProperty<T>.";
362
362
  };
363
363
  "operation-link-parameter-invalid-target": {
364
- default: import("@typespec/compiler").CallableMessage<[string]>;
364
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
365
365
  };
366
366
  "invalid-resource-type": {
367
- missingKey: import("@typespec/compiler").CallableMessage<[string]>;
368
- missingSegment: import("@typespec/compiler").CallableMessage<[string]>;
367
+ readonly missingKey: import("@typespec/compiler").CallableMessage<["name"]>;
368
+ readonly missingSegment: import("@typespec/compiler").CallableMessage<["name"]>;
369
369
  };
370
370
  "polling-operation-return-model": {
371
- default: string;
371
+ readonly default: "An operation annotated with @pollingOperation must return a model or union of model.";
372
372
  };
373
373
  "polling-operation-no-status-monitor": {
374
- default: string;
374
+ readonly default: "The operation linked in @pollingOperation must return a valid status monitor. The status monitor model must contain a 'status' property, or a property decorated with '@lroStatus'. The status field must be of Enum or Union type and contain terminal status values for success and failure.";
375
375
  };
376
376
  "polling-operation-no-lro-success": {
377
- default: string;
377
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates successful completion. This known value may be named 'Succeeded' or marked with the '@lroSucceeded' decorator.";
378
378
  };
379
379
  "polling-operation-no-lro-failure": {
380
- default: string;
380
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates failure. This known value may be named 'Failed' or marked with the '@lroFailed' decorator.";
381
381
  };
382
382
  "polling-operation-no-ref-or-link": {
383
- default: string;
383
+ readonly default: "An operation decorated with '@pollingOperation' must either return a response with an 'Operation-Location' header that will contain a runtime link to the polling operation, or specify parameters and return type properties to map into the polling operation parameters. A map into polling operation parameters can be created using the '@pollingOperationParameter' decorator";
384
384
  };
385
385
  "invalid-final-operation": {
386
- default: string;
386
+ readonly default: "The operation linked in the '@finalOperation' decorator must have a 200 response that includes a model.";
387
387
  };
388
388
  "invalid-trait-property-count": {
389
- default: import("@typespec/compiler").CallableMessage<[string]>;
389
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
390
390
  };
391
391
  "invalid-trait-property-type": {
392
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
392
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
393
393
  };
394
394
  "invalid-trait-context": {
395
- default: string;
395
+ readonly default: "The trait context can only be an enum member, union of enum members, or `unknown`.";
396
396
  };
397
397
  "trait-property-without-location": {
398
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
398
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
399
399
  };
400
400
  "expected-trait-missing": {
401
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
401
+ readonly default: import("@typespec/compiler").CallableMessage<["trait", "message"]>;
402
402
  };
403
403
  "client-request-id-trait-missing": {
404
- default: import("@typespec/compiler").CallableMessage<[]>;
404
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
405
405
  };
406
406
  "repeatable-requests-trait-missing": {
407
- default: import("@typespec/compiler").CallableMessage<[]>;
407
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
408
408
  };
409
409
  "conditional-requests-trait-missing": {
410
- default: import("@typespec/compiler").CallableMessage<[]>;
410
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
411
411
  };
412
412
  "expected-trait-diagnostic-missing": {
413
- default: string;
413
+ readonly default: "Expected trait entries must have a \"diagnostic\" field with a valid diagnostic code for the missing trait.";
414
414
  };
415
415
  "invalid-parameter": {
416
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
416
+ readonly default: import("@typespec/compiler").CallableMessage<["propertyName", "kind"]>;
417
417
  };
418
418
  "expected-success-response": {
419
- default: string;
419
+ readonly default: "The operation must have a success response";
420
420
  };
421
421
  "lro-polling-data-missing-from-operation-response": {
422
- default: string;
422
+ readonly default: "At least one operation response must contain a field marked with `@lroStatus`";
423
423
  };
424
424
  "no-object": {
425
- default: string;
425
+ readonly default: "Don't use 'object'.\n - If you want an object with any properties, use `Record<unknown>`\n - If you meant anything, use `unknown`.";
426
426
  };
427
427
  "verb-conflict": {
428
- default: import("@typespec/compiler").CallableMessage<[string, string, string]>;
428
+ readonly default: import("@typespec/compiler").CallableMessage<["templateName", "requiredVerb", "verb"]>;
429
429
  };
430
430
  "rpc-operation-needs-route": {
431
- default: string;
431
+ readonly default: "The operation needs a @route";
432
432
  };
433
433
  "union-enums-multiple-kind": {
434
- default: import("@typespec/compiler").CallableMessage<[string]>;
434
+ readonly default: import("@typespec/compiler").CallableMessage<["kinds"]>;
435
435
  };
436
436
  "union-enums-invalid-kind": {
437
- default: import("@typespec/compiler").CallableMessage<[string]>;
437
+ readonly default: import("@typespec/compiler").CallableMessage<["kind"]>;
438
438
  };
439
439
  "union-enums-circular": {
440
- default: string;
440
+ readonly default: "Union is referencing itself and cannot be resolved as an enum.";
441
441
  };
442
442
  }[C]>(diag: import("@typespec/compiler").DiagnosticReport<{
443
443
  "lro-status-union-non-string": {
444
- default: import("@typespec/compiler").CallableMessage<[string]>;
444
+ readonly default: import("@typespec/compiler").CallableMessage<["type"]>;
445
445
  };
446
446
  "lro-status-property-invalid-type": {
447
- default: string;
447
+ readonly default: "Property type must be a union of strings or an enum.";
448
448
  };
449
449
  "lro-status-missing": {
450
- default: import("@typespec/compiler").CallableMessage<[string]>;
450
+ readonly default: import("@typespec/compiler").CallableMessage<["states"]>;
451
451
  };
452
452
  "lro-status-monitor-invalid-result-property": {
453
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
453
+ readonly default: import("@typespec/compiler").CallableMessage<["resultType", "decorator"]>;
454
454
  };
455
455
  "invalid-final-state": {
456
- badValue: import("@typespec/compiler").CallableMessage<[string]>;
457
- notPut: string;
458
- noHeader: import("@typespec/compiler").CallableMessage<[string]>;
456
+ readonly badValue: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
457
+ readonly notPut: "The final state value 'original-uri' can only be used in http PUT operations";
458
+ readonly noHeader: import("@typespec/compiler").CallableMessage<["finalStateValue"]>;
459
459
  };
460
460
  "bad-record-type": {
461
- extendUnknown: import("@typespec/compiler").CallableMessage<[string, string, string, string]>;
462
- recordWithProperties: import("@typespec/compiler").CallableMessage<[string, string, string]>;
461
+ readonly extendUnknown: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName", "keyword"]>;
462
+ readonly recordWithProperties: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName"]>;
463
463
  };
464
464
  "request-parameter-invalid": {
465
- default: import("@typespec/compiler").CallableMessage<[string]>;
465
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
466
466
  };
467
467
  "response-property-invalid": {
468
- default: import("@typespec/compiler").CallableMessage<[string]>;
468
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
469
469
  };
470
470
  "operation-link-parameter-invalid": {
471
- default: string;
471
+ readonly default: "Parameters must be of template type RequestParameter<T> or ResponseProperty<T>.";
472
472
  };
473
473
  "operation-link-parameter-invalid-target": {
474
- default: import("@typespec/compiler").CallableMessage<[string]>;
474
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
475
475
  };
476
476
  "invalid-resource-type": {
477
- missingKey: import("@typespec/compiler").CallableMessage<[string]>;
478
- missingSegment: import("@typespec/compiler").CallableMessage<[string]>;
477
+ readonly missingKey: import("@typespec/compiler").CallableMessage<["name"]>;
478
+ readonly missingSegment: import("@typespec/compiler").CallableMessage<["name"]>;
479
479
  };
480
480
  "polling-operation-return-model": {
481
- default: string;
481
+ readonly default: "An operation annotated with @pollingOperation must return a model or union of model.";
482
482
  };
483
483
  "polling-operation-no-status-monitor": {
484
- default: string;
484
+ readonly default: "The operation linked in @pollingOperation must return a valid status monitor. The status monitor model must contain a 'status' property, or a property decorated with '@lroStatus'. The status field must be of Enum or Union type and contain terminal status values for success and failure.";
485
485
  };
486
486
  "polling-operation-no-lro-success": {
487
- default: string;
487
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates successful completion. This known value may be named 'Succeeded' or marked with the '@lroSucceeded' decorator.";
488
488
  };
489
489
  "polling-operation-no-lro-failure": {
490
- default: string;
490
+ readonly default: "The status monitor returned from the polling operation must have a status property, with a known status value the indicates failure. This known value may be named 'Failed' or marked with the '@lroFailed' decorator.";
491
491
  };
492
492
  "polling-operation-no-ref-or-link": {
493
- default: string;
493
+ readonly default: "An operation decorated with '@pollingOperation' must either return a response with an 'Operation-Location' header that will contain a runtime link to the polling operation, or specify parameters and return type properties to map into the polling operation parameters. A map into polling operation parameters can be created using the '@pollingOperationParameter' decorator";
494
494
  };
495
495
  "invalid-final-operation": {
496
- default: string;
496
+ readonly default: "The operation linked in the '@finalOperation' decorator must have a 200 response that includes a model.";
497
497
  };
498
498
  "invalid-trait-property-count": {
499
- default: import("@typespec/compiler").CallableMessage<[string]>;
499
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName"]>;
500
500
  };
501
501
  "invalid-trait-property-type": {
502
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
502
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
503
503
  };
504
504
  "invalid-trait-context": {
505
- default: string;
505
+ readonly default: "The trait context can only be an enum member, union of enum members, or `unknown`.";
506
506
  };
507
507
  "trait-property-without-location": {
508
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
508
+ readonly default: import("@typespec/compiler").CallableMessage<["modelName", "propertyName"]>;
509
509
  };
510
510
  "expected-trait-missing": {
511
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
511
+ readonly default: import("@typespec/compiler").CallableMessage<["trait", "message"]>;
512
512
  };
513
513
  "client-request-id-trait-missing": {
514
- default: import("@typespec/compiler").CallableMessage<[]>;
514
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
515
515
  };
516
516
  "repeatable-requests-trait-missing": {
517
- default: import("@typespec/compiler").CallableMessage<[]>;
517
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
518
518
  };
519
519
  "conditional-requests-trait-missing": {
520
- default: import("@typespec/compiler").CallableMessage<[]>;
520
+ readonly default: import("@typespec/compiler").CallableMessage<[]>;
521
521
  };
522
522
  "expected-trait-diagnostic-missing": {
523
- default: string;
523
+ readonly default: "Expected trait entries must have a \"diagnostic\" field with a valid diagnostic code for the missing trait.";
524
524
  };
525
525
  "invalid-parameter": {
526
- default: import("@typespec/compiler").CallableMessage<[string, string]>;
526
+ readonly default: import("@typespec/compiler").CallableMessage<["propertyName", "kind"]>;
527
527
  };
528
528
  "expected-success-response": {
529
- default: string;
529
+ readonly default: "The operation must have a success response";
530
530
  };
531
531
  "lro-polling-data-missing-from-operation-response": {
532
- default: string;
532
+ readonly default: "At least one operation response must contain a field marked with `@lroStatus`";
533
533
  };
534
534
  "no-object": {
535
- default: string;
535
+ readonly default: "Don't use 'object'.\n - If you want an object with any properties, use `Record<unknown>`\n - If you meant anything, use `unknown`.";
536
536
  };
537
537
  "verb-conflict": {
538
- default: import("@typespec/compiler").CallableMessage<[string, string, string]>;
538
+ readonly default: import("@typespec/compiler").CallableMessage<["templateName", "requiredVerb", "verb"]>;
539
539
  };
540
540
  "rpc-operation-needs-route": {
541
- default: string;
541
+ readonly default: "The operation needs a @route";
542
542
  };
543
543
  "union-enums-multiple-kind": {
544
- default: import("@typespec/compiler").CallableMessage<[string]>;
544
+ readonly default: import("@typespec/compiler").CallableMessage<["kinds"]>;
545
545
  };
546
546
  "union-enums-invalid-kind": {
547
- default: import("@typespec/compiler").CallableMessage<[string]>;
547
+ readonly default: import("@typespec/compiler").CallableMessage<["kind"]>;
548
548
  };
549
549
  "union-enums-circular": {
550
- default: string;
550
+ readonly default: "Union is referencing itself and cannot be resolved as an enum.";
551
551
  };
552
552
  }, C, M>) => import("@typespec/compiler").Diagnostic, AzureCoreStateKeys: Record<"items" | "fixed" | "trait" | "pagedResult" | "nextLink" | "lroStatus" | "lroSucceeded" | "lroCanceled" | "lroFailed" | "lroResult" | "lroErrorResult" | "pollingOperationParameter" | "pollingLocationInfo" | "finalLocations" | "finalLocationResults" | "finalStateOverride" | "needsRoute" | "ensureVerb" | "embeddingVector" | "armResourceIdentifierConfig" | "operationLink" | "requestParameter" | "responseParameter" | "resourceOperation" | "traitSource" | "traitContext" | "traitLocation", symbol>;
553
553
  //# sourceMappingURL=lib.d.ts.map
package/dist/src/rules/byos.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const byosRule: import("@typespec/compiler").LinterRuleDefinition<"byos", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["contentType"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=byos.d.ts.map
package/dist/src/rules/casing.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const casingRule: import("@typespec/compiler").LinterRuleDefinition<"casing-style", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string, string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["type", "casing"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=casing.d.ts.map
package/dist/src/rules/composition-over-inheritance.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const compositionOverInheritanceRule: import("@typespec/compiler").LinterRuleDefinition<"composition-over-inheritance", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string, string, string]>;
3
- readonly instance: import("@typespec/compiler").CallableMessage<[string, string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["name", "baseModel", "baseModel"]>;
3
+ readonly instance: import("@typespec/compiler").CallableMessage<["name", "baseModel"]>;
4
4
  }>;
5
5
  //# sourceMappingURL=composition-over-inheritance.d.ts.map
package/dist/src/rules/friendly-name.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { CallableMessage } from "@typespec/compiler";
2
2
  export declare const friendlyNameRule: import("@typespec/compiler").LinterRuleDefinition<"friendly-name", {
3
- readonly scope: CallableMessage<[string]>;
3
+ readonly scope: CallableMessage<["kind"]>;
4
4
  readonly template: CallableMessage<[]>;
5
5
  }>;
6
6
  //# sourceMappingURL=friendly-name.d.ts.map
package/dist/src/rules/known-encoding.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const knownEncodingRule: import("@typespec/compiler").LinterRuleDefinition<"known-encoding", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string, string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["encoding", "knownEncodings"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=known-encoding.d.ts.map
package/dist/src/rules/no-generic-numeric.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const noGenericNumericRule: import("@typespec/compiler").LinterRuleDefinition<"no-generic-numeric", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string, string]>;
3
- readonly extend: import("@typespec/compiler").CallableMessage<[string, string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["name", "alternative"]>;
3
+ readonly extend: import("@typespec/compiler").CallableMessage<["name", "alternative"]>;
4
4
  }>;
5
5
  //# sourceMappingURL=no-generic-numeric.d.ts.map
package/dist/src/rules/no-string-discriminator.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const noStringDiscriminatorRule: import("@typespec/compiler").LinterRuleDefinition<"no-string-discriminator", {
2
2
  readonly default: "Use an extensible union instead of a plain string (ex: `union PetKind { cat: \"cat\", dog: \"dog\", string };`)";
3
- readonly noProp: import("@typespec/compiler").CallableMessage<[string]>;
3
+ readonly noProp: import("@typespec/compiler").CallableMessage<["propName"]>;
4
4
  }>;
5
5
  //# sourceMappingURL=no-string-discriminator.d.ts.map
package/dist/src/rules/non-breaking-versioning.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const nonBreakingVersioningRule: import("@typespec/compiler").LinterRuleDefinition<"non-breaking-versioning", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["action"]>;
3
3
  readonly addedRequired: "Adding required property is a breaking change.";
4
4
  readonly optionalNoDefault: "Property made optional should have a default value.";
5
5
  }>;
package/dist/src/rules/prevent-multiple-discriminator.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const preventMultipleDiscriminator: import("@typespec/compiler").LinterRuleDefinition<"no-multiple-discriminator", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string, string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["name", "values"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=prevent-multiple-discriminator.d.ts.map
package/dist/src/rules/property-naming.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const propertyNameRule: import("@typespec/compiler").LinterRuleDefinition<"property-name-conflict", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["propertyName"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=property-naming.d.ts.map
package/dist/src/rules/record-types.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const recordTypeRule: import("@typespec/compiler").LinterRuleDefinition<"bad-record-type", {
2
- readonly extendUnknown: import("@typespec/compiler").CallableMessage<[string, string, string, string]>;
3
- readonly recordWithProperties: import("@typespec/compiler").CallableMessage<[string, string, string]>;
2
+ readonly extendUnknown: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName", "keyword"]>;
3
+ readonly recordWithProperties: import("@typespec/compiler").CallableMessage<["name", "keyword", "typeName"]>;
4
4
  }>;
5
5
  //# sourceMappingURL=record-types.d.ts.map
package/dist/src/rules/require-docs.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const requireDocumentation: import("@typespec/compiler").LinterRuleDefinition<"documentation-required", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string, string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["kind", "name"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=require-docs.d.ts.map
package/dist/src/rules/require-key-visibility.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const requireKeyVisibility: import("@typespec/compiler").LinterRuleDefinition<"key-visibility-required", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=require-key-visibility.d.ts.map
package/dist/src/rules/response-schema-multi-status-code.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const responseSchemaMultiStatusCodeRule: import("@typespec/compiler").LinterRuleDefinition<"response-schema-problem", {
2
- readonly multipleSuccessSchemas: import("@typespec/compiler").CallableMessage<[string]>;
2
+ readonly multipleSuccessSchemas: import("@typespec/compiler").CallableMessage<["name"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=response-schema-multi-status-code.d.ts.map
package/dist/src/rules/rpc-operation-request-body.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const rpcOperationRequestBodyRule: import("@typespec/compiler").LinterRuleDefinition<"rpc-operation-request-body", {
2
2
  readonly default: "There is an issue with the RPCOperation request body.";
3
- readonly noBodyAllowed: import("@typespec/compiler").CallableMessage<[string]>;
3
+ readonly noBodyAllowed: import("@typespec/compiler").CallableMessage<["verb"]>;
4
4
  }>;
5
5
  //# sourceMappingURL=rpc-operation-request-body.d.ts.map
package/dist/src/rules/spread-discriminated-model.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export declare const spreadDiscriminatedModelRule: import("@typespec/compiler").LinterRuleDefinition<"spread-discriminated-model", {
2
- readonly default: import("@typespec/compiler").CallableMessage<[string]>;
2
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
3
3
  }>;
4
4
  //# sourceMappingURL=spread-discriminated-model.d.ts.map
package/dist/src/rules/use-standard-ops.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare function __unsupported_enable_checkStandardOperations(enabled: boolean): void;
2
2
  export declare const useStandardOperations: import("@typespec/compiler").LinterRuleDefinition<"use-standard-operations", {
3
- readonly default: import("@typespec/compiler").CallableMessage<[string]>;
3
+ readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
4
4
  }>;
5
5
  //# sourceMappingURL=use-standard-ops.d.ts.map
package/lib/models.tsp CHANGED
@@ -358,11 +358,18 @@ scalar azureLocation extends string;
358
358
  /**
359
359
  * A type definition that refers the id to an Azure Resource Manager resource.
360
360
  *
361
- * Sample usage:
362
- * otherArmId: ResourceIdentifier;
363
- * networkId: ResourceIdentifier<[{type:"\\Microsoft.Network\\vnet"}]>
364
- * vmIds: ResourceIdentifier<[{type:"\\Microsoft.Compute\\vm", scopes["*"]}]>
365
361
  * @template AllowedResourceTypes An array of allowed resource types for the resource reference
362
+ *
363
+ * @example
364
+ *
365
+ * ```tsp
366
+ * model MyModel {
367
+ * otherArmId: armResourceIdentifier;
368
+ * networkId: armResourceIdentifier<[{type:"Microsoft.Network/vnet"}]>
369
+ * vmIds: armResourceIdentifier<[{type:"Microsoft.Compute/vm", scopes: ["*"]}]>
370
+ * scoped: armResourceIdentifier<[{type:"Microsoft.Compute/vm", scopes: ["tenant", "resourceGroup"]}]>
371
+ * }
372
+ * ```
366
373
  */
367
374
  @doc("A type definition that refers the id to an Azure Resource Manager resource.")
368
375
  @format("arm-id")
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@azure-tools/typespec-azure-core",
3
- "version": "0.45.0-dev.2",
3
+ "version": "0.45.0-dev.4",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "TypeSpec Azure Core library",
6
6
  "homepage": "https://azure.github.io/typespec-azure",
@@ -51,12 +51,12 @@
51
51
  "@typespec/openapi": "~0.58.0 || >=0.59.0-dev <0.59.0",
52
52
  "@typespec/rest": "~0.58.0 || >=0.59.0-dev <0.59.0",
53
53
  "@typespec/versioning": "~0.58.0 || >=0.59.0-dev <0.59.0",
54
- "@vitest/coverage-v8": "^1.6.0",
55
- "@vitest/ui": "^1.6.0",
54
+ "@vitest/coverage-v8": "^2.0.4",
55
+ "@vitest/ui": "^2.0.4",
56
56
  "c8": "^10.1.2",
57
- "rimraf": "~5.0.7",
58
- "typescript": "~5.5.3",
59
- "vitest": "^1.6.0",
57
+ "rimraf": "~6.0.1",
58
+ "typescript": "~5.5.4",
59
+ "vitest": "^2.0.4",
60
60
  "@typespec/tspd": "~0.46.0"
61
61
  },
62
62
  "dependencies": {},