Skip to content

Commit b05cc24

Browse files
committed
[github action] Update Docs
1 parent 42b4bfb commit b05cc24

File tree

5 files changed

+35
-0
lines changed

5 files changed

+35
-0
lines changed

Documentation/Reference/classes/AnalyticsHitParserMessage.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,32 @@ public class AnalyticsHitParserMessage: Codable, Equatable
1313
public let messageType: AnalyticsHitParserMessageType
1414
```
1515

16+
> Type of message.
17+
1618
### `description`
1719

1820
```swift
1921
public let description: String
2022
```
2123

24+
> Additional details or steps to fix the validation issue.
25+
2226
### `messageCode`
2327

2428
```swift
2529
public let messageCode: String?
2630
```
2731

32+
> The message code of the issue.
33+
2834
### `parameter`
2935

3036
```swift
3137
public let parameter: String?
3238
```
3339

40+
> The parameter (if applicable) causing the validation issue.
41+
3442
## Methods
3543
### `==(_:_:)`
3644

Documentation/Reference/enums/AnalyticsHitParserMessageType.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
public enum AnalyticsHitParserMessageType: String, Codable, CaseIterable
77
```
88

9+
> The message type of each `AnalyticsHitParserMessage`.
10+
911
## Cases
1012
### `info`
1113

Documentation/Reference/structs/AnalyticsHitParsingResult.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,33 @@
66
public struct AnalyticsHitParsingResult: Codable, Equatable
77
```
88

9+
> Result from a hit sent in the original request.
10+
911
## Properties
1012
### `valid`
1113

1214
```swift
1315
public let valid: Bool
1416
```
1517

18+
> True for valid hits, false for invalid hits.
19+
1620
### `hit`
1721

1822
```swift
1923
public let hit: String
2024
```
2125

26+
> A string containing the path of the request as well as its method and protocol.
27+
2228
### `parserMessage`
2329

2430
```swift
2531
public let parserMessage: [AnalyticsHitParserMessage]
2632
```
2733

34+
> A list of parser messages. If the hit is valid, this array will be empty.
35+
2836
## Methods
2937
### `init(valid:hit:parserMessage:)`
3038

Documentation/Reference/structs/AnalyticsResultDecoder.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
public struct AnalyticsResultDecoder: AnalyticsResultDecoderProtocol
77
```
88

9+
> Decodes the data from the `URLSession`data task into an `AnalyticsResult`.
10+
911
## Methods
1012
### `init()`
1113

@@ -18,3 +20,12 @@ public init()
1820
```swift
1921
public func decode(_ data: Data) -> AnalyticsResult
2022
```
23+
24+
> Decodes the data from `URLSession` into an `AnalyticsResult`.
25+
> - Parameter data: The `URLSession` data task.
26+
27+
#### Parameters
28+
29+
| Name | Description |
30+
| ---- | ----------- |
31+
| data | The `URLSession` data task. |

Documentation/Reference/structs/AnalyticsValidation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,22 @@
66
public struct AnalyticsValidation: Codable, Equatable
77
```
88

9+
> The response from validation call.
10+
911
## Properties
1012
### `hitParsingResult`
1113

1214
```swift
1315
public let hitParsingResult: [AnalyticsHitParsingResult]
1416
```
1517

18+
> An array which represents the hits sent in the original request.
19+
1620
## Methods
1721
### `init(hitParsingResult:)`
1822

1923
```swift
2024
public init(hitParsingResult: [AnalyticsHitParsingResult])
2125
```
26+
27+
> Create the response from validation call.

0 commit comments

Comments
 (0)