@typespec/openapi 0.62.0 → 0.63.0-dev.1

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 (5) hide show
  1. package/README.md +17 -0
  2. package/dist/generated-defs/TypeSpec.OpenAPI.d.ts +6 -0
  3. package/dist/generated-defs/TypeSpec.OpenAPI.d.ts.map +1 -1
  4. package/lib/decorators.tsp +9 -0
  5. package/package.json +8 -7
package/README.md CHANGED
@@ -168,3 +168,20 @@ Specify OpenAPI additional information.
168
168
  | ----------- | ------------------------------------- | ---------------------- |
169
169
  | name | `valueof string` | tag name |
170
170
  | tagMetadata | [valueof `TagMetadata`](#tagmetadata) | Additional information |
171
+
172
+ ##### Examples
173
+
174
+ ```typespec
175
+ @service
176
+ @tagMetadata(
177
+ "Tag Name",
178
+ #{
179
+ description: "Tag description",
180
+ externalDocs: #{ url: "https://example.com", description: "More info.", `x-custom`: "string" },
181
+ `x-custom`: "string",
182
+ }
183
+ )
184
+ namespace PetStore {
185
+
186
+ }
187
+ ```
package/dist/generated-defs/TypeSpec.OpenAPI.d.ts CHANGED
@@ -70,6 +70,12 @@ export type InfoDecorator = (context: DecoratorContext, target: Namespace, addit
70
70
  *
71
71
  * @param name tag name
72
72
  * @param tagMetadata Additional information
73
+ * @example
74
+ * ```typespec
75
+ * @service()
76
+ * @tagMetadata("Tag Name", #{description: "Tag description", externalDocs: #{url: "https://example.com", description: "More info.", `x-custom`: "string"}, `x-custom`: "string"})
77
+ * namespace PetStore {}
78
+ * ```
73
79
  */
74
80
  export type TagMetadataDecorator = (context: DecoratorContext, target: Namespace, name: string, tagMetadata: TagMetadata) => void;
75
81
  export type TypeSpecOpenAPIDecorators = {
package/dist/generated-defs/TypeSpec.OpenAPI.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"TypeSpec.OpenAPI.d.ts","sourceRoot":"","sources":["../../generated-defs/TypeSpec.OpenAPI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE9F,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;CACtC;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,SAAS,EACjB,WAAW,EAAE,MAAM,KAChB,IAAI,CAAC;AAEV;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,IAAI,KACR,IAAI,CAAC;AAEV;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC;AAE1F;;;;;;;;;;GAUG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAClC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,GAAG,EAAE,MAAM,EACX,WAAW,CAAC,EAAE,MAAM,KACjB,IAAI,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,CAC1B,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,SAAS,EACjB,cAAc,EAAE,IAAI,KACjB,IAAI,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,WAAW,KACrB,IAAI,CAAC;AAEV,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE,oBAAoB,CAAC;IAClC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,eAAe,EAAE,wBAAwB,CAAC;IAC1C,YAAY,EAAE,qBAAqB,CAAC;IACpC,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,oBAAoB,CAAC;CACnC,CAAC"}
1
+ {"version":3,"file":"TypeSpec.OpenAPI.d.ts","sourceRoot":"","sources":["../../generated-defs/TypeSpec.OpenAPI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE9F,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;CACtC;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,SAAS,EACjB,WAAW,EAAE,MAAM,KAChB,IAAI,CAAC;AAEV;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,IAAI,KACR,IAAI,CAAC;AAEV;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC;AAE1F;;;;;;;;;;GAUG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAClC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,GAAG,EAAE,MAAM,EACX,WAAW,CAAC,EAAE,MAAM,KACjB,IAAI,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,CAC1B,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,SAAS,EACjB,cAAc,EAAE,IAAI,KACjB,IAAI,CAAC;AAEV;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,WAAW,KACrB,IAAI,CAAC;AAEV,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE,oBAAoB,CAAC;IAClC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,eAAe,EAAE,wBAAwB,CAAC;IAC1C,YAAY,EAAE,qBAAqB,CAAC;IACpC,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,oBAAoB,CAAC;CACnC,CAAC"}
package/lib/decorators.tsp CHANGED
@@ -118,6 +118,7 @@ model TagMetadata {
118
118
  /** An external Docs information of the API. */
119
119
  externalDocs?: ExternalDocs;
120
120
 
121
+ /** Attach some custom data, The extension key must start with `x-`. */
121
122
  ...Record<unknown>;
122
123
  }
123
124
 
@@ -129,6 +130,7 @@ model ExternalDocs {
129
130
  /** Optional description */
130
131
  description?: string;
131
132
 
133
+ /** Attach some custom data, The extension key must start with `x-`. */
132
134
  ...Record<unknown>;
133
135
  }
134
136
 
@@ -136,5 +138,12 @@ model ExternalDocs {
136
138
  * Specify OpenAPI additional information.
137
139
  * @param name tag name
138
140
  * @param tagMetadata Additional information
141
+ *
142
+ * @example
143
+ * ```typespec
144
+ * @service()
145
+ * @tagMetadata("Tag Name", #{description: "Tag description", externalDocs: #{url: "https://example.com", description: "More info.", `x-custom`: "string"}, `x-custom`: "string"})
146
+ * namespace PetStore {}
147
+ * ```
139
148
  */
140
149
  extern dec tagMetadata(target: Namespace, name: valueof string, tagMetadata: valueof TagMetadata);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@typespec/openapi",
3
- "version": "0.62.0",
3
+ "version": "0.63.0-dev.1",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "TypeSpec library providing OpenAPI concepts",
6
6
  "homepage": "https://typespec.io",
@@ -39,23 +39,24 @@
39
39
  "!dist/test/**"
40
40
  ],
41
41
  "peerDependencies": {
42
- "@typespec/compiler": "~0.62.0",
43
- "@typespec/http": "~0.62.0"
42
+ "@typespec/compiler": "~0.62.0 || >=0.63.0-dev <0.63.0",
43
+ "@typespec/http": "~0.62.0 || >=0.63.0-dev <0.63.0"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@types/node": "~22.7.5",
47
+ "@typespec/compiler": "~0.62.0 || >=0.63.0-dev <0.63.0",
48
+ "@typespec/http": "~0.62.0 || >=0.63.0-dev <0.63.0",
49
+ "@typespec/library-linter": "~0.62.0 || >=0.63.0-dev <0.63.0",
50
+ "@typespec/rest": "~0.62.0 || >=0.63.0-dev <0.63.0",
47
51
  "@vitest/coverage-v8": "^2.1.2",
48
52
  "@vitest/ui": "^2.1.2",
49
53
  "c8": "^10.1.2",
50
54
  "rimraf": "~6.0.1",
51
55
  "typescript": "~5.6.3",
52
56
  "vitest": "^2.1.2",
53
- "@typespec/compiler": "~0.62.0",
54
- "@typespec/http": "~0.62.0",
55
- "@typespec/rest": "~0.62.0",
56
- "@typespec/library-linter": "~0.62.0",
57
57
  "@typespec/tspd": "~0.46.0"
58
58
  },
59
+ "dependencies": {},
59
60
  "scripts": {
60
61
  "clean": "rimraf ./dist ./temp",
61
62
  "build": "pnpm gen-extern-signature && tsc -p . && pnpm lint-typespec-library && pnpm api-extractor",