File: HTTPBodySectionTranslator.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (59 lines) | stat: -rw-r--r-- 2,737 bytes parent folder | download
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2023-2024 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 Foundation

/// Translates a symbol's request body into a render node's body section.
struct HTTPBodySectionTranslator: RenderSectionTranslator {
    func translateSection(
        for symbol: Symbol,
        renderNode: inout RenderNode,
        renderNodeTranslator: inout RenderNodeTranslator
    ) -> VariantCollection<CodableContentSection?>? {
        translateSectionToVariantCollection(
            documentationDataVariants: symbol.httpBodySectionVariants
        ) { _, httpBodySection -> RenderSection? in
            guard let symbol = httpBodySection.body.symbol, let mediaType = httpBodySection.body.mediaType else { return nil }
            
            // Filter out parameters that aren't backed by a symbol or don't have a "body" source.
            let filteredParameters = httpBodySection.body.parameters.filter { $0.symbol != nil && $0.source == "body" }
            
            let bodyContent = renderNodeTranslator.visitMarkupContainer(
                MarkupContainer(httpBodySection.body.contents)
            ) as! [RenderBlockContent]
            
            let renderedTokens = symbol.declarationFragments?.map { token -> DeclarationRenderSection.Token in
                // Create a reference if one found
                let reference: ResolvedTopicReference?
                if let preciseIdentifier = token.preciseIdentifier,
                    let resolved = renderNodeTranslator.context.localOrExternalReference(symbolID: preciseIdentifier)
                {
                    reference = resolved
                    
                    // Add relationship to render references
                    renderNodeTranslator.collectedTopicReferences.append(resolved)
                } else {
                    reference = nil
                }
                
                // Add the declaration token
                return DeclarationRenderSection.Token(fragment: token, identifier: reference?.absoluteString)
            }
            
            return RESTBodyRenderSection(
                title: "HTTP Body",
                mimeType: mediaType,
                bodyContentType: renderedTokens ?? [],
                content: bodyContent,
                parameters: filteredParameters.map { renderNodeTranslator.createRenderProperty(name: $0.name, contents: $0.contents, required: $0.required, symbol: $0.symbol)  }
            )
        }
    }
}