1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2023 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Markdown
import SymbolKit
/// Documentation about the response for an HTTP request symbol.
public struct HTTPResponse {
/// The HTTP status code of the response.
public var statusCode: UInt
/// The HTTP code description string.
public var reason: String?
/// The media type of the response.
///
/// Value might be undefined initially when first extracted from markdown.
public var mediaType: String?
/// The content that describe the response.
public var contents: [Markup]
/// The symbol graph symbol representing this response.
public var symbol: SymbolGraph.Symbol?
/// Initialize a value to describe documentation about a dictionary key for a symbol.
/// - Parameters:
/// - statusCode: The status code of the response.
/// - reason: The status reason message of the response.
/// - mediaType: The media type of the response.
/// - contents: The content that describe this response.
/// - symbol: The symbol data extracted from the symbol graph.
public init(statusCode: UInt, reason: String?, mediaType: String?, contents: [Markup], symbol: SymbolGraph.Symbol? = nil) {
self.statusCode = statusCode
self.reason = reason
self.mediaType = mediaType
self.contents = contents
self.symbol = symbol
}
}
|
