@azure-tools/typespec-autorest 0.69.0-dev.3 → 0.69.0

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 (2) hide show
  1. package/README.md +20 -0
  2. package/package.json +22 -23
package/README.md CHANGED
@@ -44,6 +44,8 @@ See [Configuring output directory for more info](https://typespec.io/docs/handbo
44
44
 
45
45
  ### `output-dir`
46
46
 
47
+ _Deprecated: This option is deprecated._
48
+
47
49
  **Type:** `string`
48
50
 
49
51
  Deprecated DO NOT USE. Use built-in emitter-output-dir instead
@@ -95,6 +97,8 @@ Directory where the examples are located. Default: `{project-root}/examples`.
95
97
 
96
98
  ### `examples-directory`
97
99
 
100
+ _Deprecated: This option is deprecated._
101
+
98
102
  **Type:** `string`
99
103
 
100
104
  DEPRECATED. Use examples-dir instead
@@ -119,6 +123,8 @@ Path to the common-types.json file folder. Default: '${project-root}/../../commo
119
123
 
120
124
  **Type:** `"crlf" | "lf"`
121
125
 
126
+ **Default:** `"lf"`
127
+
122
128
  Set the newline character for emitting files.
123
129
 
124
130
  ### `omit-unreachable-types`
@@ -131,12 +137,16 @@ Omit unreachable types. By default all types declared under the service namespac
131
137
 
132
138
  **Type:** `string`
133
139
 
140
+ **Default:** `"omit"`
141
+
134
142
  Decide how to deal with the Version enum when when `omit-unreachable-types` is not set. Default to 'omit'
135
143
 
136
144
  ### `include-x-typespec-name`
137
145
 
138
146
  **Type:** `"inline-only" | "never"`
139
147
 
148
+ **Default:** `"never"`
149
+
140
150
  If the generated openapi types should have the `x-typespec-name` extension set with the name of the TypeSpec type that created it.
141
151
  This extension is meant for debugging and should not be depended on.
142
152
 
@@ -144,24 +154,32 @@ This extension is meant for debugging and should not be depended on.
144
154
 
145
155
  **Type:** `boolean`
146
156
 
157
+ **Default:** `false`
158
+
147
159
  Create read-only property schema for lro status
148
160
 
149
161
  ### `emit-lro-options`
150
162
 
151
163
  **Type:** `"none" | "final-state-only" | "all"`
152
164
 
165
+ **Default:** `"final-state-only"`
166
+
153
167
  Determine whether and how to emit x-ms-long-running-operation-options for lro resolution
154
168
 
155
169
  ### `emit-common-types-schema`
156
170
 
157
171
  **Type:** `"never" | "for-visibility-changes"`
158
172
 
173
+ **Default:** `"for-visibility-changes"`
174
+
159
175
  Determine whether and how to emit schemas for common-types rather than referencing them
160
176
 
161
177
  ### `xml-strategy`
162
178
 
163
179
  **Type:** `"xml-service" | "none"`
164
180
 
181
+ **Default:** `"xml-service"`
182
+
165
183
  Strategy for applying XML serialization metadata to schemas.
166
184
 
167
185
  ### `output-splitting`
@@ -174,6 +192,8 @@ Determines whether output should be split into multiple files. The only supporte
174
192
 
175
193
  **Type:** `boolean`
176
194
 
195
+ **Default:** `false`
196
+
177
197
  When enabled, the emitter will not copy example files to the output directory. Instead, it will reference the source example files using relative file paths.
178
198
 
179
199
  ## Decorators
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@azure-tools/typespec-autorest",
3
- "version": "0.69.0-dev.3",
3
+ "version": "0.69.0",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "TypeSpec library for emitting openapi from the TypeSpec REST protocol binding",
6
6
  "homepage": "https://azure.github.io/typespec-azure",
@@ -41,15 +41,15 @@
41
41
  "!dist/test/**"
42
42
  ],
43
43
  "peerDependencies": {
44
- "@azure-tools/typespec-azure-core": "^0.68.0 || >=0.69.0-dev <0.69.0",
45
- "@azure-tools/typespec-azure-resource-manager": "^0.68.0 || >=0.69.0-dev <0.69.0",
46
- "@azure-tools/typespec-client-generator-core": "^0.68.4 || >=0.69.0-dev <0.69.0",
47
- "@typespec/compiler": "^1.12.0",
48
- "@typespec/http": "^1.12.0",
49
- "@typespec/openapi": "^1.12.0",
50
- "@typespec/rest": "^0.82.0 || >=0.83.0-dev <0.83.0",
51
- "@typespec/versioning": "^0.82.0 || >=0.83.0-dev <0.83.0",
52
- "@typespec/xml": "^0.82.0 || >=0.83.0-dev <0.83.0"
44
+ "@azure-tools/typespec-azure-core": "^0.69.0",
45
+ "@azure-tools/typespec-azure-resource-manager": "^0.69.0",
46
+ "@typespec/compiler": "^1.13.0",
47
+ "@typespec/openapi": "^1.13.0",
48
+ "@azure-tools/typespec-client-generator-core": "^0.69.0",
49
+ "@typespec/http": "^1.13.0",
50
+ "@typespec/versioning": "^0.83.0",
51
+ "@typespec/xml": "^0.83.0",
52
+ "@typespec/rest": "^0.83.0"
53
53
  },
54
54
  "peerDependenciesMeta": {
55
55
  "@typespec/xml": {
@@ -57,25 +57,24 @@
57
57
  }
58
58
  },
59
59
  "devDependencies": {
60
- "@azure-tools/typespec-azure-core": "^0.68.0 || >=0.69.0-dev <0.69.0",
61
- "@azure-tools/typespec-azure-resource-manager": "^0.68.0 || >=0.69.0-dev <0.69.0",
62
- "@azure-tools/typespec-client-generator-core": "^0.68.4 || >=0.69.0-dev <0.69.0",
63
60
  "@types/node": "^25.5.2",
64
- "@typespec/compiler": "^1.12.0",
65
- "@typespec/http": "^1.12.0",
66
- "@typespec/json-schema": "^1.12.0",
67
- "@typespec/library-linter": "^0.82.0 || >=0.83.0-dev <0.83.0",
68
- "@typespec/openapi": "^1.12.0",
69
- "@typespec/rest": "^0.82.0 || >=0.83.0-dev <0.83.0",
70
- "@typespec/tspd": "^0.74.2 || >=0.75.0-dev <0.75.0",
71
- "@typespec/versioning": "^0.82.0 || >=0.83.0-dev <0.83.0",
72
61
  "@vitest/coverage-v8": "^4.1.3",
73
62
  "@vitest/ui": "^4.1.3",
74
63
  "rimraf": "^6.1.3",
75
64
  "typescript": "~6.0.2",
76
- "vitest": "^4.1.3"
65
+ "vitest": "^4.1.3",
66
+ "@azure-tools/typespec-azure-core": "^0.69.0",
67
+ "@azure-tools/typespec-azure-resource-manager": "^0.69.0",
68
+ "@azure-tools/typespec-client-generator-core": "^0.69.0",
69
+ "@typespec/compiler": "^1.13.0",
70
+ "@typespec/http": "^1.13.0",
71
+ "@typespec/json-schema": "^1.13.0",
72
+ "@typespec/library-linter": "^0.83.0",
73
+ "@typespec/openapi": "^1.13.0",
74
+ "@typespec/rest": "^0.83.0",
75
+ "@typespec/tspd": "^0.75.0",
76
+ "@typespec/versioning": "^0.83.0"
77
77
  },
78
- "dependencies": {},
79
78
  "scripts": {
80
79
  "clean": "rimraf ./dist ./temp",
81
80
  "build": "npm run gen-extern-signature && npm run regen-autorest-openapi-schema && tsc -p tsconfig.build.json && npm run lint-typespec-library",