@typespec/openapi 0.47.0-dev.0 → 0.47.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/dist/src/decorators.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { DecoratorContext, Model, Operation, Program, Type, TypeSpecValue } from "@typespec/compiler";
|
|
2
|
-
import { ExtensionKey } from "./types.js";
|
|
1
|
+
import { DecoratorContext, Model, Namespace, Operation, Program, Type, TypeSpecValue } from "@typespec/compiler";
|
|
2
|
+
import { AdditionalInfo, ExtensionKey } from "./types.js";
|
|
3
3
|
export declare const namespace = "OpenAPI";
|
|
4
4
|
/**
|
|
5
5
|
* Set a specific operation ID.
|
|
@@ -34,4 +34,6 @@ export interface ExternalDocs {
|
|
|
34
34
|
*/
|
|
35
35
|
export declare function $externalDocs(context: DecoratorContext, target: Type, url: string, description?: string): void;
|
|
36
36
|
export declare function getExternalDocs(program: Program, entity: Type): ExternalDocs | undefined;
|
|
37
|
+
export declare function $info(context: DecoratorContext, entity: Namespace, model: Model): void;
|
|
38
|
+
export declare function getInfo(program: Program, entity: Namespace): AdditionalInfo | undefined;
|
|
37
39
|
//# sourceMappingURL=decorators.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,EACL,SAAS,EACT,OAAO,EACP,IAAI,EAEJ,aAAa,EACd,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,EACL,SAAS,EACT,SAAS,EACT,OAAO,EACP,IAAI,EAEJ,aAAa,EACd,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1D,eAAO,MAAM,SAAS,YAAY,CAAC;AAGnC;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,QAEtF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAEtF;AAID,wBAAgB,UAAU,CACxB,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,aAAa,QAerB;AAED,wBAAgB,YAAY,CAC1B,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,IAAI,EACZ,aAAa,EAAE,YAAY,EAC3B,IAAI,EAAE,OAAO,QAOd;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,WAAW,CAAC,YAAY,EAAE,GAAG,CAAC,CAE5F;AAYD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,QAGxE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO,CAEzE;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAGD;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,GAAG,EAAE,MAAM,EACX,WAAW,CAAC,EAAE,MAAM,QAOrB;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,YAAY,GAAG,SAAS,CAExF;AAGD,wBAAgB,KAAK,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,QAI/E;AAED,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,GAAG,cAAc,GAAG,SAAS,CAEvF"}
|
package/dist/src/decorators.js
CHANGED
|
@@ -82,4 +82,13 @@ export function $externalDocs(context, target, url, description) {
|
|
|
82
82
|
export function getExternalDocs(program, entity) {
|
|
83
83
|
return program.stateMap(externalDocsKey).get(entity);
|
|
84
84
|
}
|
|
85
|
+
const infoKey = createStateSymbol("info");
|
|
86
|
+
export function $info(context, entity, model) {
|
|
87
|
+
const [data, diagnostics] = typespecTypeToJson(model, context.getArgumentTarget(0));
|
|
88
|
+
context.program.reportDiagnostics(diagnostics);
|
|
89
|
+
context.program.stateMap(infoKey).set(entity, data);
|
|
90
|
+
}
|
|
91
|
+
export function getInfo(program, entity) {
|
|
92
|
+
return program.stateMap(infoKey).get(entity);
|
|
93
|
+
}
|
|
85
94
|
//# sourceMappingURL=decorators.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,kBAAkB,GAEnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAG/D,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAC;AAEnC,MAAM,eAAe,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;AAC1D;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,OAAyB,EAAE,MAAiB,EAAE,IAAY;IACrF,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC9D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,OAAgB,EAAE,MAAiB;IAChE,OAAO,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;AAElE,MAAM,UAAU,UAAU,CACxB,OAAyB,EACzB,MAAY,EACZ,aAAqB,EACrB,KAAoB;IAEpB,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE;QACzC,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;KACJ;IAED,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,GAAG,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9D,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;KAChD;IACD,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,aAA6B,EAAE,IAAI,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,OAAgB,EAChB,MAAY,EACZ,aAA2B,EAC3B,IAAa;;IAEb,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAChE,MAAM,cAAc,GAAG,MAAA,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,mCAAI,IAAI,GAAG,EAAe,CAAC;IAC/E,cAAc,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAExC,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAgB,EAAE,MAAY;;IAC1D,OAAO,MAAA,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,mCAAI,IAAI,GAAG,EAAqB,CAAC;AAC3F,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAW;IACxC,OAAO,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;AAChE,MAAM,UAAU,gBAAgB,CAAC,OAAyB,EAAE,MAAa;IACvE,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB,EAAE,MAAY;IAC9D,OAAO,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAC1D,CAAC;AAMD,MAAM,eAAe,GAAG,iBAAiB,CAAC,cAAc,CAAC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,OAAyB,EACzB,MAAY,EACZ,GAAW,EACX,WAAoB;IAEpB,MAAM,GAAG,GAAiB,EAAE,GAAG,EAAE,CAAC;IAClC,IAAI,WAAW,EAAE;QACf,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;KAC/B;IACD,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAAgB,EAAE,MAAY;IAC5D,OAAO,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAC1C,MAAM,UAAU,KAAK,CAAC,OAAyB,EAAE,MAAiB,EAAE,KAAY;IAC9E,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,GAAG,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAE,CAAC,CAAC;IACrF,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAC/C,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,OAAgB,EAAE,MAAiB;IACzD,OAAO,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC"}
|
package/dist/src/types.d.ts
CHANGED
|
@@ -1,2 +1,27 @@
|
|
|
1
1
|
export type ExtensionKey = `x-${string}`;
|
|
2
|
+
/**
|
|
3
|
+
* OpenAPI additional information
|
|
4
|
+
*/
|
|
5
|
+
export interface AdditionalInfo {
|
|
6
|
+
/** A URL to the Terms of Service for the API. MUST be in the format of a URL. */
|
|
7
|
+
termsOfService?: string;
|
|
8
|
+
/** The contact information for the exposed API. */
|
|
9
|
+
contact?: Contact;
|
|
10
|
+
/** The license information for the exposed API. */
|
|
11
|
+
license?: License;
|
|
12
|
+
}
|
|
13
|
+
export interface Contact {
|
|
14
|
+
/** The identifying name of the contact person/organization. */
|
|
15
|
+
name?: string;
|
|
16
|
+
/** The URL pointing to the contact information. MUST be in the format of a URL. */
|
|
17
|
+
url?: string;
|
|
18
|
+
/** The email address of the contact person/organization. MUST be in the format of an email address. */
|
|
19
|
+
email?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface License {
|
|
22
|
+
/** The license name used for the API. */
|
|
23
|
+
name: string;
|
|
24
|
+
/** A URL to the license used for the API. MUST be in the format of a URL. */
|
|
25
|
+
url?: string;
|
|
26
|
+
}
|
|
2
27
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/src/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,KAAK,MAAM,EAAE,CAAC"}
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,KAAK,MAAM,EAAE,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,iFAAiF;IACjF,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,mDAAmD;IACnD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,mDAAmD;IACnD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,mFAAmF;IACnF,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,uGAAuG;IACvG,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,OAAO;IACtB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,6EAA6E;IAC7E,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}
|
package/lib/decorators.tsp
CHANGED
|
@@ -60,3 +60,43 @@ extern dec defaultResponse(target: Model);
|
|
|
60
60
|
* ```
|
|
61
61
|
*/
|
|
62
62
|
extern dec externalDocs(target: unknown, url: valueof string, description?: valueof string);
|
|
63
|
+
|
|
64
|
+
/** Additional information for the OpenAPI document. */
|
|
65
|
+
model AdditionalInfo {
|
|
66
|
+
/** A URL to the Terms of Service for the API. MUST be in the format of a URL. */
|
|
67
|
+
termsOfService?: url;
|
|
68
|
+
|
|
69
|
+
/** The contact information for the exposed API. */
|
|
70
|
+
contact?: Contact;
|
|
71
|
+
|
|
72
|
+
/** The license information for the exposed API. */
|
|
73
|
+
license?: License;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/** Contact information for the exposed API. */
|
|
77
|
+
model Contact {
|
|
78
|
+
/** The identifying name of the contact person/organization. */
|
|
79
|
+
name?: string;
|
|
80
|
+
|
|
81
|
+
/** The URL pointing to the contact information. MUST be in the format of a URL. */
|
|
82
|
+
url?: url;
|
|
83
|
+
|
|
84
|
+
/** The email address of the contact person/organization. MUST be in the format of an email address. */
|
|
85
|
+
email?: string;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/** License information for the exposed API. */
|
|
89
|
+
model License {
|
|
90
|
+
/** The license name used for the API. */
|
|
91
|
+
name: string;
|
|
92
|
+
|
|
93
|
+
/** A URL to the license used for the API. MUST be in the format of a URL. */
|
|
94
|
+
url?: url;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Specify OpenAPI additional information.
|
|
99
|
+
* The service `title` and `version` are already specified using `@service`.
|
|
100
|
+
* @param additionalInfo Additional information
|
|
101
|
+
*/
|
|
102
|
+
extern dec info(target: Namespace, additionalInfo: AdditionalInfo);
|
package/package.json
CHANGED