Skip to content

Commit

Permalink
fix: update swift lint documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gulivero1773 committed Apr 30, 2024
1 parent 05cdf0d commit 0856107
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
1 change: 0 additions & 1 deletion Sources/HealthChecks/HealthChecks.swift
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import Vapor

/// Service that provides app health check functionality
public struct HealthChecks {

/// Initializer for HealthChecks
public init() {}

Expand Down
19 changes: 10 additions & 9 deletions Sources/HealthChecks/Models/HealthCheck.swift
Original file line number Diff line number Diff line change
Expand Up @@ -33,34 +33,34 @@ public struct HealthCheck: Content {
/// Public version of the service
/// Example: `1`
public var version: String?

/// Release id of the service
/// Example: `1.0.0`
public var releaseId: String?

/// Array of notes relevant to current state of health
/// Example: `["All ok"]`
public var notes: [String]?

/// Raw error output, in case of `fail` or `warn` states
/// Example: `"Redis database not exist"`
public var output: String?

/// Dictionary of array that provides all health check item
public var checks: [String: [HealthCheckItem]]?

/// Dictionary of links for show more information
/// Example: `["about": "https://example.com/about/service"]`
public var links: [String: String]?

/// Is a unique identifier of the service, in the application scope
/// Example: `43119325-63f5-4e14-9175-84e0e296c527`
public var serviceId: UUID?

/// Is a human-friendly description of the service
/// Example: `"This service use for get application health"`
public var description: String?

/// Initializer for HealthCheck
/// - Parameters:
/// - status: optional `HealthCheckStatus`
Expand All @@ -78,8 +78,8 @@ public struct HealthCheck: Content {
releaseId: String? = nil,
notes: [String]? = nil,
output: String? = nil,
checks: [String : [HealthCheckItem]]? = nil,
links: [String : String]? = nil,
checks: [String: [HealthCheckItem]]? = nil,
links: [String: String]? = nil,
serviceId: UUID? = nil,
description: String? = nil
) {
Expand All @@ -97,6 +97,7 @@ public struct HealthCheck: Content {

/// Example of `HealthCheck`
extension HealthCheck {
/// Structure instance of `HealthCheck`
public static var example: HealthCheck {
HealthCheck(
status: .pass,
Expand Down

0 comments on commit 0856107

Please sign in to comment.