Structure

RESTResponse

A REST response that includes the HTTP status, reason, and the MIME type encoding of the response body.

struct RESTResponse

Discussion

If the response is a decodable object, a declaration-style type property describes the expected type and can provide an optional link to the expected documentation symbol.

Topics

Initializers

init(from: any Decoder) throws
init(status: UInt, reason: String?, mimeType: String?, type: [DeclarationRenderSection.Token], content: [RenderBlockContent]?)
Creates a new REST response section.

Instance Properties

var content: [RenderBlockContent]?
Response details, if any.
let mimeType: String?
An optional response MIME content-type.
let reason: String?
An optional plain-text reason for the response.
let status: UInt
The HTTP status code for the response.
let type: [DeclarationRenderSection.Token]
A type declaration of the response’s content.