@typespec/http 0.49.0-dev.2 → 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.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,
|
|
1
|
+
{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EAWV,SAAS,EACT,OAAO,EAGR,MAAM,oBAAoB,CAAC;AAY5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAEnD;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,SAAS,GACnB,CAAC,qBAAqB,EAAE,EAAE,SAAS,UAAU,EAAE,CAAC,CAiBlD"}
|
package/dist/src/responses.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createDiagnosticCollector, getDoc, isArrayModelType, isErrorModel, isNullType, isVoidType, walkPropertiesInherited, } from "@typespec/compiler";
|
|
1
|
+
import { createDiagnosticCollector, getDoc, getErrorsDoc, getReturnsDoc, isArrayModelType, isErrorModel, isNullType, isVoidType, walkPropertiesInherited, } from "@typespec/compiler";
|
|
2
2
|
import { getContentTypes, isContentTypeHeader } from "./content-types.js";
|
|
3
3
|
import { getHeaderFieldName, getStatusCodeDescription, getStatusCodes, isBody, isHeader, isStatusCode, } from "./decorators.js";
|
|
4
4
|
import { createDiagnostic } from "./lib.js";
|
|
@@ -16,15 +16,15 @@ export function getResponsesForOperation(program, operation) {
|
|
|
16
16
|
// TODO how should we treat this? https://github.com/microsoft/typespec/issues/356
|
|
17
17
|
continue;
|
|
18
18
|
}
|
|
19
|
-
processResponseType(program, diagnostics, responses, option.type);
|
|
19
|
+
processResponseType(program, diagnostics, operation, responses, option.type);
|
|
20
20
|
}
|
|
21
21
|
}
|
|
22
22
|
else {
|
|
23
|
-
processResponseType(program, diagnostics, responses, responseType);
|
|
23
|
+
processResponseType(program, diagnostics, operation, responses, responseType);
|
|
24
24
|
}
|
|
25
25
|
return diagnostics.wrap(Object.values(responses));
|
|
26
26
|
}
|
|
27
|
-
function processResponseType(program, diagnostics, responses, responseType) {
|
|
27
|
+
function processResponseType(program, diagnostics, operation, responses, responseType) {
|
|
28
28
|
var _a;
|
|
29
29
|
const metadata = gatherMetadata(program, diagnostics, responseType, Visibility.Read);
|
|
30
30
|
// Get explicity defined status codes
|
|
@@ -59,7 +59,7 @@ function processResponseType(program, diagnostics, responses, responseType) {
|
|
|
59
59
|
const response = (_a = responses[statusCode]) !== null && _a !== void 0 ? _a : {
|
|
60
60
|
statusCode,
|
|
61
61
|
type: responseType,
|
|
62
|
-
description: getResponseDescription(program, responseType, statusCode, bodyType),
|
|
62
|
+
description: getResponseDescription(program, operation, responseType, statusCode, bodyType),
|
|
63
63
|
responses: [],
|
|
64
64
|
};
|
|
65
65
|
if (bodyType !== undefined) {
|
|
@@ -157,7 +157,7 @@ function getResponseBody(program, diagnostics, responseType, metadata) {
|
|
|
157
157
|
// Otherwise, there is no body
|
|
158
158
|
return undefined;
|
|
159
159
|
}
|
|
160
|
-
function getResponseDescription(program, responseType, statusCode, bodyType) {
|
|
160
|
+
function getResponseDescription(program, operation, responseType, statusCode, bodyType) {
|
|
161
161
|
// NOTE: If the response type is an envelope and not the same as the body
|
|
162
162
|
// type, then use its @doc as the response description. However, if the
|
|
163
163
|
// response type is the same as the body type, then use the default status
|
|
@@ -171,6 +171,12 @@ function getResponseDescription(program, responseType, statusCode, bodyType) {
|
|
|
171
171
|
return desc;
|
|
172
172
|
}
|
|
173
173
|
}
|
|
174
|
+
const desc = isErrorModel(program, responseType)
|
|
175
|
+
? getErrorsDoc(program, operation)
|
|
176
|
+
: getReturnsDoc(program, operation);
|
|
177
|
+
if (desc) {
|
|
178
|
+
return desc;
|
|
179
|
+
}
|
|
174
180
|
return getStatusCodeDescription(statusCode);
|
|
175
181
|
}
|
|
176
182
|
//# sourceMappingURL=responses.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EAGzB,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,UAAU,EACV,UAAU,EAMV,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,cAAc,EACd,MAAM,EACN,QAAQ,EACR,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAGjF;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAgB,EAChB,SAAoB;IAEpB,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAChD,MAAM,YAAY,GAAG,SAAS,CAAC,UAAU,CAAC;IAC1C,MAAM,SAAS,GAAmD,EAAE,CAAC;IACrE,IAAI,YAAY,CAAC,IAAI,KAAK,OAAO,EAAE;QACjC,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YACnD,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBAC3B,kFAAkF;gBAClF,SAAS;aACV;YACD,mBAAmB,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EAGzB,MAAM,EACN,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,UAAU,EACV,UAAU,EAMV,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,cAAc,EACd,MAAM,EACN,QAAQ,EACR,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAGjF;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAgB,EAChB,SAAoB;IAEpB,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAChD,MAAM,YAAY,GAAG,SAAS,CAAC,UAAU,CAAC;IAC1C,MAAM,SAAS,GAAmD,EAAE,CAAC;IACrE,IAAI,YAAY,CAAC,IAAI,KAAK,OAAO,EAAE;QACjC,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YACnD,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBAC3B,kFAAkF;gBAClF,SAAS;aACV;YACD,mBAAmB,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;SAC9E;KACF;SAAM;QACL,mBAAmB,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;KAC/E;IAED,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,mBAAmB,CAC1B,OAAgB,EAChB,WAAgC,EAChC,SAAoB,EACpB,SAAgD,EAChD,YAAkB;;IAElB,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAErF,qCAAqC;IACrC,MAAM,WAAW,GAAkB,sBAAsB,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;IAE3F,uCAAuC;IACvC,MAAM,YAAY,GAAG,uBAAuB,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAE7E,uBAAuB;IACvB,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEtD,WAAW;IACX,IAAI,QAAQ,GAAG,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;IAE7E,iEAAiE;IACjE,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5B,IAAI,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE;YAClD,QAAQ,GAAG,SAAS,CAAC;YACrB,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzB;aAAM,IAAI,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE;YAC9C,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACvB;aAAM;YACL,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzB;KACF;IAED,yEAAyE;IACzE,IAAI,QAAQ,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;QACzC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;KACvC;IAED,0CAA0C;IAC1C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,oEAAoE;QACpE,iEAAiE;QACjE,MAAM,QAAQ,GAA0B,MAAA,SAAS,CAAC,UAAU,CAAC,mCAAI;YAC/D,UAAU;YACV,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,sBAAsB,CAAC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC;YAC3F,SAAS,EAAE,EAAE;SACd,CAAC;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;SAC5F;aAAM,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YAClC,WAAW,CAAC,GAAG,CACb,gBAAgB,CAAC;gBACf,IAAI,EAAE,sBAAsB;gBAC5B,MAAM,EAAE,YAAY;aACrB,CAAC,CACH,CAAC;SACH;aAAM;YACL,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;SACtC;QACD,SAAS,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;KAClC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,sBAAsB,CAC7B,OAAgB,EAChB,YAAkB,EAClB,QAA4B;IAE5B,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;QAC3B,IAAI,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;YAC/B,KAAK,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;SAC9C;KACF;IAED,IAAI,YAAY,CAAC,IAAI,KAAK,OAAO,EAAE;QACjC,KAAK,IAAI,CAAC,GAAsB,YAAY,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE;YAChE,KAAK,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;SAC3C;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAC9B,OAAgB,EAChB,WAAgC,EAChC,QAA4B;IAE5B,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;QAC3B,IAAI,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;YACjE,YAAY,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAC/D;KACF;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CACzB,OAAgB,EAChB,QAA4B;IAE5B,MAAM,eAAe,GAAkC,EAAE,CAAC;IAC1D,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;QAC3B,MAAM,UAAU,GAAG,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,UAAU,KAAK,cAAc,EAAE;YAC5D,eAAe,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;SACpC;KACF;IACD,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,SAAS,eAAe,CACtB,OAAgB,EAChB,WAAgC,EAChC,YAAkB,EAClB,QAA4B;IAE5B,uEAAuE;IACvE,IAAI,YAAY,CAAC,IAAI,KAAK,OAAO,IAAI,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE;QAC5E,OAAO,YAAY,CAAC;KACrB;IAED,yBAAyB;IACzB,IAAI,YAAuC,CAAC;IAC5C,KAAK,MAAM,QAAQ,IAAI,QAAQ,EAAE;QAC/B,IAAI,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE;YAC7B,IAAI,YAAY,EAAE;gBAChB,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;aACjF;iBAAM;gBACL,YAAY,GAAG,QAAQ,CAAC;aACzB;SACF;KACF;IACD,IAAI,YAAY,EAAE;QAChB,OAAO,YAAY,CAAC,IAAI,CAAC;KAC1B;IAED,sEAAsE;IACtE,iGAAiG;IACjG,SAAS;IACT,IAAI,YAAY,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;QAC/E,OAAO,YAAY,CAAC;KACrB;IACD,KAAK,MAAM,QAAQ,IAAI,uBAAuB,CAAC,YAAY,CAAC,EAAE;QAC5D,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE;YAC7D,OAAO,YAAY,CAAC;SACrB;KACF;IAED,8BAA8B;IAC9B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,sBAAsB,CAC7B,OAAgB,EAChB,SAAoB,EACpB,YAAkB,EAClB,UAAkB,EAClB,QAA0B;IAE1B,yEAAyE;IACzE,uEAAuE;IACvE,0EAA0E;IAC1E,0EAA0E;IAC1E,sEAAsE;IACtE,wEAAwE;IACxE,sCAAsC;IACtC,IAAI,YAAY,KAAK,QAAQ,EAAE;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC3C,IAAI,IAAI,EAAE;YACR,OAAO,IAAI,CAAC;SACb;KACF;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC;QAC9C,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC;QAClC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACtC,IAAI,IAAI,EAAE;QACR,OAAO,IAAI,CAAC;KACb;IAED,OAAO,wBAAwB,CAAC,UAAU,CAAC,CAAC;AAC9C,CAAC"}
|