Skip to content

Server: model */* response body as UndocumentedPayload #861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brandonbloom wants to merge 4 commits into
base: main
Choose a base branch
from
+476 −44
Open

Server: model */* response body as UndocumentedPayload #861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e808ba9
Server: don’t validate/emit */* responses
brandonbloom Jan 18, 2026
60d84cb
Server: map */* responses to application/octet-stream
brandonbloom Feb 28, 2026
ac353e3
Server: model */* body as UndocumentedPayload
brandonbloom Jan 18, 2026
9941001
Server: gate concrete wildcard response bodies behind a flag
brandonbloom Feb 28, 2026
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
6 changes: 6 additions & 0 deletions Sources/_OpenAPIGeneratorCore/FeatureFlags.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@
public enum FeatureFlag: String, Hashable, Codable, CaseIterable, Sendable {
// needs to be here for the enum to compile
case empty

/// Represent wildcard response bodies as content-typed payloads.
///
/// Generates response bodies for `*/*` as `OpenAPIContentTypedBody`
/// instead of plain `HTTPBody`.
case concreteWildcardResponseBodies
}

/// A set of enabled feature flags.
Expand Down
5 changes: 4 additions & 1 deletion Sources/_OpenAPIGeneratorCore/Translator/FileTranslator+FeatureFlags.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,8 @@
import OpenAPIKit

extension FileTranslator {
// Add helpers for reading feature flags below.
/// Whether wildcard response bodies should use content-typed payloads.
var hasConcreteWildcardResponseBodies: Bool {
config.featureFlags.contains(.concreteWildcardResponseBodies)
}
}
7 changes: 6 additions & 1 deletion Sources/_OpenAPIGeneratorCore/Translator/Responses/translateResponse.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,12 @@ extension TypesFileTranslator {
var bodyCases: [Declaration] = []
let contentType = typedContent.content.contentType
let identifier = context.safeNameGenerator.swiftContentTypeName(for: contentType)
let associatedType = typedContent.resolvedTypeUsage
let associatedType: TypeUsage
if contentType.lowercasedTypeAndSubtype == "*/*" && hasConcreteWildcardResponseBodies {
associatedType = TypeName.contentTypedBody.asUsage
} else {
associatedType = typedContent.resolvedTypeUsage
}
let content = typedContent.content
let schema = content.schema
if typeMatcher.isInlinable(schema) || typeMatcher.isReferenceableMultipart(content) {
Expand Down
235 changes: 194 additions & 41 deletions Sources/_OpenAPIGeneratorCore/Translator/Responses/translateResponseOutcome.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,19 +237,130 @@ extension ClientFileTranslator {
codeBlocks.append(.declaration(chosenContentTypeDecl))

func makeCase(typedContent: TypedSchemaContent) throws -> SwitchCaseDescription {
let contentType = typedContent.content.contentType
let contentTypeUsage = typedContent.resolvedTypeUsage
let transformExpr: Expression = .closureInvocation(
argumentNames: ["value"],
body: [
.expression(
.dot(context.safeNameGenerator.swiftContentTypeName(for: typedContent.content.contentType))
.call([.init(label: nil, expression: .identifierPattern("value"))])
)
]
)
let codingStrategy = typedContent.content.contentType.codingStrategy
let codingStrategy = contentType.codingStrategy

let caseName = context.safeNameGenerator.swiftContentTypeName(for: contentType)
let usesConcreteWildcardResponseBodies = contentType.lowercasedTypeAndSubtype == "*/*"
&& hasConcreteWildcardResponseBodies

var caseCodeBlocks: [CodeBlock] = []
let transformExpr: Expression

if usesConcreteWildcardResponseBodies {
let concreteContentTypeDecl: Declaration = .variable(
kind: .let,
left: "concreteContentType",
type: .init(TypeName.concreteMIMEType)
)
caseCodeBlocks.append(.declaration(concreteContentTypeDecl))

let defaultContentTypeExpr: Expression = .try(
.dot("init")
.call([
.init(label: "type", expression: .literal("application")),
.init(label: "subtype", expression: .literal("octet-stream")),
])
)
let parsedContentTypeSwitchExpr: Expression = .switch(
switchedExpression: .identifierPattern("contentType"),
cases: [
.init(
kind: .case(.dot("some"), ["contentTypeValue"]),
body: [
.expression(
.switch(
switchedExpression: .identifierPattern("contentTypeValue").dot("kind"),
cases: [
.init(
kind: .case(.dot("concrete"), ["type", "subtype"]),
body: [
.expression(
.assignment(
left: .identifierPattern("concreteContentType"),
right: .try(
.dot("init")
.call([
.init(
label: "type",
expression: .identifierPattern("type")
),
.init(
label: "subtype",
expression: .identifierPattern("subtype")
),
])
)
)
)
]
),
.init(
kind: .default,
body: [
.expression(
.assignment(
left: .identifierPattern("concreteContentType"),
right: defaultContentTypeExpr
)
)
]
),
]
)
)
]
),
.init(
kind: .default,
body: [
.expression(
.assignment(
left: .identifierPattern("concreteContentType"),
right: defaultContentTypeExpr
)
)
]
),
]
)
caseCodeBlocks.append(.expression(parsedContentTypeSwitchExpr))

transformExpr = .closureInvocation(
argumentNames: ["value"],
body: [
.expression(
.dot(caseName)
.call([
.init(
label: nil,
expression: .dot("init")
.call([
.init(
label: "contentType",
expression: .identifierPattern("concreteContentType")
),
.init(label: "body", expression: .identifierPattern("value")),
])
)
])
)
]
)
} else {
transformExpr = .closureInvocation(
argumentNames: ["value"],
body: [
.expression(
.dot(caseName)
.call([.init(label: nil, expression: .identifierPattern("value"))])
)
]
)
}
let extraBodyAssignArgs: [FunctionArgumentDescription]
if typedContent.content.contentType.isMultipart {
if contentType.isMultipart {
extraBodyAssignArgs = try translateMultipartDeserializerExtraArgumentsInClient(typedContent)
} else {
extraBodyAssignArgs = []
Expand All @@ -274,9 +385,10 @@ extension ClientFileTranslator {
bodyExpr = .try(converterExpr)
}
let bodyAssignExpr: Expression = .assignment(left: .identifierPattern("body"), right: bodyExpr)
caseCodeBlocks.append(.expression(bodyAssignExpr))
return .init(
kind: .case(.literal(typedContent.content.contentType.headerValueForValidation)),
body: [.expression(bodyAssignExpr)]
body: caseCodeBlocks
)
}
let cases = try typedContents.map(makeCase)
Expand Down Expand Up @@ -401,44 +513,85 @@ extension ServerFileTranslator {

var caseCodeBlocks: [CodeBlock] = []

let contentTypeHeaderValue = typedContent.content.contentType.headerValueForValidation
let validateAcceptHeader: Expression = .try(
.identifierPattern("converter").dot("validateAcceptIfPresent")
.call([
.init(label: nil, expression: .literal(contentTypeHeaderValue)),
.init(label: "in", expression: .identifierPattern("request").dot("headerFields")),
])
)
caseCodeBlocks.append(.expression(validateAcceptHeader))

let contentType = typedContent.content.contentType
let extraBodyAssignArgs: [FunctionArgumentDescription]
if contentType.isMultipart {
extraBodyAssignArgs = try translateMultipartSerializerExtraArgumentsInServer(typedContent)
} else {
extraBodyAssignArgs = []
}
let assignBodyExpr: Expression = .assignment(
left: .identifierPattern("body"),
right: .try(
.identifierPattern("converter")
.dot("setResponseBodyAs\(contentType.codingStrategy.runtimeName)")
.call(
[
.init(label: nil, expression: .identifierPattern("value")),
let isWildcardAnyContentType = contentType.lowercasedTypeAndSubtype == "*/*"
let usesConcreteWildcardResponseBodies = isWildcardAnyContentType
&& hasConcreteWildcardResponseBodies

if usesConcreteWildcardResponseBodies {
let validateAcceptHeader: Expression = .try(
.identifierPattern("converter").dot("validateAcceptIfPresent")
.call([
.init(
label: nil,
expression: .identifierPattern("value").dot("contentType").dot("headerValue")
),
.init(label: "in", expression: .identifierPattern("request").dot("headerFields")),
])
)
caseCodeBlocks.append(.expression(validateAcceptHeader))

let assignBodyExpr: Expression = .assignment(
left: .identifierPattern("body"),
right: .try(
.identifierPattern("converter").dot("setResponseBodyAsBinary")
.call([
.init(label: nil, expression: .identifierPattern("value").dot("body")),
.init(
label: "headerFields",
expression: .inOut(.identifierPattern("response").dot("headerFields"))
),
.init(
label: "contentType",
expression: .literal(contentType.headerValueForSending)
expression: .identifierPattern("value").dot("contentType").dot("headerValue")
),
] + extraBodyAssignArgs
)
])
)
)
)
caseCodeBlocks.append(.expression(assignBodyExpr))
caseCodeBlocks.append(.expression(assignBodyExpr))
} else {
let contentTypeForServer = isWildcardAnyContentType
? ContentType.applicationOctetStream
: contentType

let contentTypeHeaderValue = contentTypeForServer.headerValueForValidation
let validateAcceptHeader: Expression = .try(
.identifierPattern("converter").dot("validateAcceptIfPresent")
.call([
.init(label: nil, expression: .literal(contentTypeHeaderValue)),
.init(label: "in", expression: .identifierPattern("request").dot("headerFields")),
])
)
caseCodeBlocks.append(.expression(validateAcceptHeader))

let extraBodyAssignArgs: [FunctionArgumentDescription]
if contentTypeForServer.isMultipart {
extraBodyAssignArgs = try translateMultipartSerializerExtraArgumentsInServer(typedContent)
} else {
extraBodyAssignArgs = []
}
let assignBodyExpr: Expression = .assignment(
left: .identifierPattern("body"),
right: .try(
.identifierPattern("converter")
.dot("setResponseBodyAs\(contentTypeForServer.codingStrategy.runtimeName)")
.call(
[
.init(label: nil, expression: .identifierPattern("value")),
.init(
label: "headerFields",
expression: .inOut(.identifierPattern("response").dot("headerFields"))
),
.init(
label: "contentType",
expression: .literal(contentTypeForServer.headerValueForSending)
),
] + extraBodyAssignArgs
)
)
)
caseCodeBlocks.append(.expression(assignBodyExpr))
}

return .init(
kind: .case(.dot(context.safeNameGenerator.swiftContentTypeName(for: contentType)), ["value"]),
Expand Down
6 changes: 6 additions & 0 deletions Sources/_OpenAPIGeneratorCore/Translator/TypeAssignment/Builtins.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ extension TypeName {
.runtime(Constants.Operation.Output.undocumentedCaseAssociatedValueTypeName)
}

/// Returns the type name for the concrete MIME type.
static var concreteMIMEType: Self { .runtime("OpenAPIConcreteMIMEType") }

/// Returns the type name for the content-typed body payload.
static var contentTypedBody: Self { .runtime("OpenAPIContentTypedBody") }

/// Returns the type name of generic JSON payload.
static var valueContainer: TypeName { .runtime("OpenAPIValueContainer") }

Expand Down
Loading