Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: fix
packages:
- "@typespec/http"
---

Respect docs on union variants used as HTTP responses
6 changes: 5 additions & 1 deletion packages/http/src/responses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,11 @@ function resolveResponseVariants(
continue;
}
// Recursively resolve nested unions
const resolved = resolveResponseVariants(program, option.type, unionDescription);
const resolved = resolveResponseVariants(
program,
option.type,
getDoc(program, option) ?? unionDescription,
);
for (const variant of resolved) {
if (isPlainResponseBody(program, variant.type)) {
plainVariants.push(variant.type);
Expand Down
16 changes: 16 additions & 0 deletions packages/openapi3/test/response-descriptions.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,22 @@ worksFor(supportedVersions, ({ openApiFor }) => {
strictEqual(res.paths["/"].get.responses["409"].description, "Foo");
});

it("uses union variant descriptions", async () => {
const res = await openApiFor(
`
model PetCreated { @statusCode code: 201 }
model PetAccepted { @statusCode code: 202 }
union CreatedResponses {
@doc("Pet Created") created: PetCreated,
@doc("Pet Accepted") accepted: PetAccepted,
}
op created(): CreatedResponses;
`,
);
strictEqual(res.paths["/"].get.responses["201"].description, "Pet Created");
strictEqual(res.paths["/"].get.responses["202"].description, "Pet Accepted");
});

it("recursively expands deeply nested unions", async () => {
const res = await openApiFor(
`
Expand Down
Loading