feat: support healthcheck rfc draft 06

* Update MIME type of health checks to match latest draft * Fix a typo: heath -> health
apisyouwonthate · Jun 26, 2023 · de07125 · de07125
1 parent dea1776
commit de07125
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/__tests__/api-health-format.test.ts b/__tests__/api-health-format.test.ts
@@ -26,7 +26,7 @@ const template = (contentType: string) => {
 testRule("api-health-format", [
   {
     name: "valid case",
-    document: template("application/vnd.health+json"),
+    document: template("application/health+json"),
     errors: [],
   },
 
@@ -36,7 +36,7 @@ testRule("api-health-format", [
     errors: [
       {
         message:
-          "Health path (`/heath`) SHOULD support Health Check Response Format",
+          "Health path (`/health`) SHOULD support Health Check Response Format",
         path: [
           "paths",
           "/health",
@@ -57,7 +57,7 @@ testRule("api-health-format", [
     errors: [
       {
         message:
-          "Health path (`/heath`) SHOULD support Health Check Response Format",
+          "Health path (`/health`) SHOULD support Health Check Response Format",
         path: [
           "paths",
           "/health",

diff --git a/src/ruleset.ts b/src/ruleset.ts
@@ -57,15 +57,15 @@ export default {
     // Author: Phil Sturgeon (https://github.com/philsturgeon)
     "api-health-format": {
       message:
-        "Health path (`/heath`) SHOULD support Health Check Response Format",
+        "Health path (`/health`) SHOULD support Health Check Response Format",
       description:
         "Use existing standards (and draft standards) wherever possible, like the draft standard for health checks: https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check. To learn more about health check endpoints see https://apisyouwonthate.com/blog/health-checks-with-kubernetes.",
       formats: [oas3],
       given: "$.paths[/health]..responses[*].content.*~",
       then: {
         function: enumeration,
         functionOptions: {
-          values: ["application/vnd.health+json"],
+          values: ["application/health+json"],
         },
       },
       severity: DiagnosticSeverity.Warning,