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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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
/// A kind of a REST request endpoint.
///
/// Endpoints can describe either a production or sandbox URL.
enum RESTEndpointType: String, Codable {
/// A production endpoint.
case production
/// A sandbox endpoint used for testing.
case sandbox
}
/// A section that contains a REST API endpoint.
///
/// This section is similar to ``DeclarationRenderSection`` for symbols and
/// describes a tokenized endpoint for a REST API. The token list starts with
/// an HTTP method token followed by tokens for the complete endpoint URL. Any path
/// components that are dynamic instead of fixed are represented with a parameter name
/// enclosed in curly brackets.
///
/// A complete token representation for the endpoint `GET https://www.example.com/api/artists/{id}`
/// is (the token kind is in brackets):
/// - (method) `GET`
/// - (baseURL) `https://www.example.com`
/// - (path) `/api/artists/`
/// - (parameter) `{id}`
public struct RESTEndpointRenderSection: RenderSection, Equatable {
public var kind: RenderSectionKind = .restEndpoint
/// A single token in a REST endpoint.
public struct Token: Codable, Equatable {
/// The kind of REST endpoint token.
public enum Kind: String, Codable {
case method, baseURL, path, parameter, text
}
/// The endpoint specific token kind.
public let kind: Kind
/// The plain text of the token.
public let text: String
}
/// The title for the section.
public let title: String
/// The list of tokens.
public let tokens: [Token]
/// Creates a new REST endpoint section.
/// - Parameters:
/// - title: The title for the section.
/// - tokens: The list of tokens.
public init(title: String, tokens: [Token]) {
self.title = title
self.tokens = tokens
}
}
// Diffable conformance
extension RESTEndpointRenderSection: RenderJSONDiffable {
/// Returns the differences between this RESTEndpointRenderSection and the given one.
func difference(from other: RESTEndpointRenderSection, at path: CodablePath) -> JSONPatchDifferences {
var diffBuilder = DifferenceBuilder(current: self, other: other, basePath: path)
diffBuilder.addDifferences(atKeyPath: \.kind, forKey: CodingKeys.kind)
diffBuilder.addDifferences(atKeyPath: \.title, forKey: CodingKeys.title)
diffBuilder.addDifferences(atKeyPath: \.tokens, forKey: CodingKeys.tokens)
return diffBuilder.differences
}
/// Returns if this RESTEndpointRenderSection is similar enough to the given one.
func isSimilar(to other: RESTEndpointRenderSection) -> Bool {
return self.title == other.title
}
}
// Diffable conformance
extension RESTEndpointRenderSection.Token: RenderJSONDiffable {
/// Returns the differences between this Token and the given one.
func difference(from other: RESTEndpointRenderSection.Token, at path: CodablePath) -> JSONPatchDifferences {
var diffBuilder = DifferenceBuilder(current: self, other: other, basePath: path)
diffBuilder.addDifferences(atKeyPath: \.kind, forKey: CodingKeys.kind)
diffBuilder.addDifferences(atKeyPath: \.text, forKey: CodingKeys.text)
return diffBuilder.differences
}
/// Returns if this Token is similar enough to the given one.
func isSimilar(to other: RESTEndpointRenderSection.Token) -> Bool {
return self.text == other.text
}
}
|
