@typespec/openapi 0.63.0-dev.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.
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
|
+
```
|
|
@@ -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 = {
|
|
@@ -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
|
|
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);
|