Skip to content

Commit 5d3ea0f

Browse files
Fix typo in symbol name for server variable validations
1 parent 35dd374 commit 5d3ea0f

File tree

2 files changed

+30
-10
lines changed

2 files changed

+30
-10
lines changed

Sources/OpenAPIKit/Validator/Validation+Builtins.swift

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ extension Validation {
1313
/// Validate the OpenAPI Document has at least one path in its
1414
/// `PathItem.Map`.
1515
///
16-
/// The OpenAPI Specifcation does not require that the document
16+
/// The OpenAPI Specification does not require that the document
1717
/// contain any paths for [security reasons](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#security-filtering)
1818
/// or even because it only contains webhooks, but authors may still
1919
/// want to protect against an empty `PathItem.Map` in some cases.
@@ -29,7 +29,7 @@ extension Validation {
2929
/// Validate the OpenAPI Document's `PathItems` all have at least
3030
/// one operation.
3131
///
32-
/// The OpenAPI Specifcation does not require that path items
32+
/// The OpenAPI Specification does not require that path items
3333
/// contain any operations for [security reasons](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#security-filtering)
3434
/// but documentation that is public in nature might only ever have
3535
/// a `PathItem` with no operations in error.
@@ -45,7 +45,7 @@ extension Validation {
4545
/// Validate the OpenAPI Document's `JSONSchemas` all have at least
4646
/// one defining characteristic.
4747
///
48-
/// The JSON Schema Specifcation does not require that components
48+
/// The JSON Schema Specification does not require that components
4949
/// have any defining characteristics. An "empty" schema component can
5050
/// be written as follows:
5151
///
@@ -160,7 +160,7 @@ extension Validation {
160160
/// Validate the OpenAPI Document's `Operations` all have at least
161161
/// one response.
162162
///
163-
/// The OpenAPI Specifcation does not require that Responses Objects
163+
/// The OpenAPI Specification does not require that Responses Objects
164164
/// contain at least one response but you may wish to validate that all
165165
/// operations contain at least one response in your own API.
166166
///
@@ -182,7 +182,7 @@ extension Validation {
182182

183183
/// Validate that the OpenAPI Document's `Tags` all have unique names.
184184
///
185-
/// The OpenAPI Specifcation requires that tag names on the Document
185+
/// The OpenAPI Specification requires that tag names on the Document
186186
/// [are unique](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#openapi-object).
187187
///
188188
/// - Important: This is included in validation by default.
@@ -435,7 +435,7 @@ extension Validation {
435435
///
436436
/// - Important: This is included in validation by default.
437437
///
438-
public static var serverVarialbeEnumIsValid: Validation<OpenAPI.Server.Variable> {
438+
public static var serverVariableEnumIsValid: Validation<OpenAPI.Server.Variable> {
439439
.init(
440440
description: "Server Variable's enum is either not defined or is non-empty (if defined).",
441441
check: { context in
@@ -445,12 +445,22 @@ extension Validation {
445445
)
446446
}
447447

448+
/// Validate that `enum` must not be empty in the document's
449+
/// Server Variable.
450+
///
451+
/// - Important: This is included in validation by default.
452+
///
453+
@available(*, deprecated, renamed: "serverVariableEnumIsValid")
454+
public static var serverVarialbeEnumIsValid: Validation<OpenAPI.Server.Variable> {
455+
return serverVariableEnumIsValid
456+
}
457+
448458
/// Validate that `default` must exist in the enum values in the document's
449459
/// Server Variable, if such values (enum) are defined.
450460
///
451461
/// - Important: This is included in validation by default.
452462
///
453-
public static var serverVarialbeDefaultExistsInEnum : Validation<OpenAPI.Server.Variable> {
463+
public static var serverVariableDefaultExistsInEnum : Validation<OpenAPI.Server.Variable> {
454464
.init(
455465
description: "Server Variable's default must exist in enum, if enum is defined.",
456466
check: { context in
@@ -459,6 +469,16 @@ extension Validation {
459469
}
460470
)
461471
}
472+
473+
/// Validate that `default` must exist in the enum values in the document's
474+
/// Server Variable, if such values (enum) are defined.
475+
///
476+
/// - Important: This is included in validation by default.
477+
///
478+
@available(*, deprecated, renamed: "serverVariableDefaultExistsInEnum")
479+
public static var serverVarialbeDefaultExistsInEnum : Validation<OpenAPI.Server.Variable> {
480+
return serverVariableDefaultExistsInEnum
481+
}
462482
}
463483

464484
/// Used by both the Path Item parameter check and the

Sources/OpenAPIKit/Validator/Validator.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ extension OpenAPI.Document {
123123
/// `where` clause both examine the same type (i.e. `OpenAPI.Document.Info`
124124
/// from the previous example and `OpenAPI.Document` from the next example).
125125
///
126-
/// The next example also uses `take()` in its `where` caluse. This allows you to
126+
/// The next example also uses `take()` in its `where` clause. This allows you to
127127
/// dig into a value based on its KeyPath just like the previous example but you can
128128
/// use it for more complicated criteria than equality/inequality.
129129
///
@@ -191,8 +191,8 @@ public final class Validator {
191191
.init(.headerReferencesAreValid),
192192
.init(.linkReferencesAreValid),
193193
.init(.pathItemReferencesAreValid),
194-
.init(.serverVarialbeEnumIsValid),
195-
.init(.serverVarialbeDefaultExistsInEnum)
194+
.init(.serverVariableEnumIsValid),
195+
.init(.serverVariableDefaultExistsInEnum)
196196
])
197197
}
198198

0 commit comments

Comments
 (0)