@typespec/openapi 0.49.0-dev.1 → 0.49.0-dev.3
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
|
@@ -10,7 +10,7 @@ npm install @typespec/openapi
|
|
|
10
10
|
|
|
11
11
|
## Decorators
|
|
12
12
|
|
|
13
|
-
### OpenAPI
|
|
13
|
+
### TypeSpec.OpenAPI
|
|
14
14
|
|
|
15
15
|
- [`@defaultResponse`](#@defaultresponse)
|
|
16
16
|
- [`@extension`](#@extension)
|
|
@@ -24,7 +24,7 @@ Specify that this model is to be treated as the OpenAPI `default` response.
|
|
|
24
24
|
This differs from the compiler built-in `@error` decorator as this does not necessarily represent an error.
|
|
25
25
|
|
|
26
26
|
```typespec
|
|
27
|
-
@OpenAPI.defaultResponse
|
|
27
|
+
@TypeSpec.OpenAPI.defaultResponse
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
##### Target
|
|
@@ -49,7 +49,7 @@ op listPets(): Pet[] | PetStoreResponse;
|
|
|
49
49
|
Attach some custom data to the OpenAPI element generated from this type.
|
|
50
50
|
|
|
51
51
|
```typespec
|
|
52
|
-
@OpenAPI.extension(key: valueof string, value: unknown)
|
|
52
|
+
@TypeSpec.OpenAPI.extension(key: valueof string, value: unknown)
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
##### Target
|
|
@@ -81,7 +81,7 @@ op read(): string;
|
|
|
81
81
|
Specify the OpenAPI `externalDocs` property for this type.
|
|
82
82
|
|
|
83
83
|
```typespec
|
|
84
|
-
@OpenAPI.externalDocs(url: valueof string, description?: valueof string)
|
|
84
|
+
@TypeSpec.OpenAPI.externalDocs(url: valueof string, description?: valueof string)
|
|
85
85
|
```
|
|
86
86
|
|
|
87
87
|
##### Target
|
|
@@ -111,7 +111,7 @@ Specify OpenAPI additional information.
|
|
|
111
111
|
The service `title` and `version` are already specified using `@service`.
|
|
112
112
|
|
|
113
113
|
```typespec
|
|
114
|
-
@OpenAPI.info(additionalInfo: OpenAPI.AdditionalInfo)
|
|
114
|
+
@TypeSpec.OpenAPI.info(additionalInfo: TypeSpec.OpenAPI.AdditionalInfo)
|
|
115
115
|
```
|
|
116
116
|
|
|
117
117
|
##### Target
|
|
@@ -120,16 +120,16 @@ The service `title` and `version` are already specified using `@service`.
|
|
|
120
120
|
|
|
121
121
|
##### Parameters
|
|
122
122
|
|
|
123
|
-
| Name | Type
|
|
124
|
-
| -------------- |
|
|
125
|
-
| additionalInfo | `model OpenAPI.AdditionalInfo` | Additional information |
|
|
123
|
+
| Name | Type | Description |
|
|
124
|
+
| -------------- | --------------------------------------- | ---------------------- |
|
|
125
|
+
| additionalInfo | `model TypeSpec.OpenAPI.AdditionalInfo` | Additional information |
|
|
126
126
|
|
|
127
127
|
#### `@operationId`
|
|
128
128
|
|
|
129
129
|
Specify the OpenAPI `operationId` property for this operation.
|
|
130
130
|
|
|
131
131
|
```typespec
|
|
132
|
-
@OpenAPI.operationId(operationId: valueof string)
|
|
132
|
+
@TypeSpec.OpenAPI.operationId(operationId: valueof string)
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
##### Target
|
package/dist/src/decorators.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { DecoratorContext, Model, Namespace, Operation, Program, Type, TypeSpecValue } from "@typespec/compiler";
|
|
2
2
|
import { AdditionalInfo, ExtensionKey } from "./types.js";
|
|
3
|
-
export declare const namespace = "OpenAPI";
|
|
3
|
+
export declare const namespace = "TypeSpec.OpenAPI";
|
|
4
4
|
/**
|
|
5
5
|
* Set a specific operation ID.
|
|
6
6
|
* @param context Decorator Context
|
|
@@ -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,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,
|
|
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,qBAAqB,CAAC;AAG5C;;;;;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
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { typespecTypeToJson, } from "@typespec/compiler";
|
|
2
2
|
import { setStatusCode } from "@typespec/http";
|
|
3
3
|
import { createStateSymbol, reportDiagnostic } from "./lib.js";
|
|
4
|
-
export const namespace = "OpenAPI";
|
|
4
|
+
export const namespace = "TypeSpec.OpenAPI";
|
|
5
5
|
const operationIdsKey = createStateSymbol("operationIds");
|
|
6
6
|
/**
|
|
7
7
|
* Set a specific operation ID.
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,kBAAkB,CAAC;AAE5C,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/lib/decorators.tsp
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@typespec/openapi",
|
|
3
|
-
"version": "0.49.0-dev.
|
|
3
|
+
"version": "0.49.0-dev.3",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
5
|
"description": "TypeSpec library providing OpenAPI concepts",
|
|
6
6
|
"homepage": "https://microsoft.github.io/typespec",
|
|
@@ -42,13 +42,13 @@
|
|
|
42
42
|
"!dist/test/**"
|
|
43
43
|
],
|
|
44
44
|
"peerDependencies": {
|
|
45
|
-
"@typespec/compiler": "~0.48.
|
|
45
|
+
"@typespec/compiler": "~0.48.1 || >=0.49.0-dev <0.49.0",
|
|
46
46
|
"@typespec/http": "~0.48.0 || >=0.49.0-dev <0.49.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@types/mocha": "~10.0.1",
|
|
50
50
|
"@types/node": "~18.11.9",
|
|
51
|
-
"@typespec/compiler": "~0.48.
|
|
51
|
+
"@typespec/compiler": "~0.48.1 || >=0.49.0-dev <0.49.0",
|
|
52
52
|
"@typespec/http": "~0.48.0 || >=0.49.0-dev <0.49.0",
|
|
53
53
|
"@typespec/rest": "~0.48.0 || >=0.49.0-dev <0.49.0",
|
|
54
54
|
"@typespec/eslint-config-typespec": "~0.48.0 || >=0.49.0-dev <0.49.0",
|