@@ -5,7 +5,7 @@ description: "Returns a JSON health check response indicating the ready status o
55sidebar_label : " Health Check"
66hide_title : true
77hide_table_of_contents : true
8- api: eJytVUuP2zYQ/isED0ULrB9NgQL1qYsmyLoI2kV2c1osjBE1shhRHJWknPUa/u+doaSsnEdP9cEjkvPi8JtvTjrBPurNg76+3erHK11iNMF2yZLXG/0eUx98VKD+vPv7L1UjuFQrU6NpVMDYkY+orC+tgWT9XqUaeR/Ko4oJUh8VVer2+v5GX2nqMIC43Zbs+NXg6g/xxIcRTR9sOnIinMPkmfM66VfrtYjLvG7micTeGIyx6h17MuQT+iQm0HUuJ0Z+9TGK3UlHNmlBvtKxQ/ZExUc0iQ27IBkmO0Qd0p/pxRT4gqyHT9B2Lps2+nylWw4Ne/xvVamBslH1nQJfqtB7LypsfsAQ7ZDb981/Xq6Xa9HOtb3j3DB+6w5QllauC+724jajXkHkELw4+uz7pNGXHVmfFvWx5BeioDcp9MgVoSYtYg3eS36ydz7nAld23wcs7zAcrMHt63kMCAGOnIpN2H6jfvPQDxpTLZUnJxZwgCf9eB5+UtdUk0Blj/l5gHU3ejXg5jljJkjx2M9J98HxYZ1SFzer1SmOmZXnZejMch/ogEsj+PoS4FynsjeyyDhVH96/U58sQ2t0sYgdGltZwygrSmrBevZxgGChcCNUpmADTCvoHcNvvNtltHtuj1FdbV9zt0BSJSYMrfUYc/fMw6DvWykThGJHHqVG/BWx2/H7p6lkg1iUlTRSARFHsRiVCu47ETYZym4LB8MBFfkgGukbdCQhc9b8v6vJTWFkOYuKh5Yiywp8olY+AjwlkO6r+hx+7ylaUakhtOQzHrykZymhZNyAhSwOIhzfXmTLDp3Y89tn85bIFwjt+BksPzh/s7YIgniMmVny3zxF6gpfZGiZZoDPgDERO2jpOCnmjeeGr8SLAKWV7PjJyLkMMSv/5K2UKPaySmAbmuSuxmZylQJJdZ9C53bsb1fiYb4ULZ9zeW74ws3OU778cxOP3uzkkQT8V3MwM5YdGXA1xbT5Zf3rb18h6p0cD9C1nknLG9TnRyl3Rbn7bHohoIW65S5SzPTqB3XPZNDYpG4gMPbi150hFj9+3+An4TPwinnGq0h9YEwzEFr8RKFRFQWFnntEpgJkflaJeI6UaJieAzj7jCWjnTn6qLguYrVU26SYhw+WU1HSZNSLGbmYadPZIvAmZldMKIwMgU7uGyYw3A8DJuvKOsDQ2bmhLwNzlESGHS/1jINHoh2mCBtLBT1fiU/eCoeoN37PAXEiaO5TeSp82f19xjXCYh2/HMN65mgcXdPkuyj66WV8/Z+jd6Rgbr206pxwC2eWUXYaefVBT7zK2BG0ydbpJDTyIbjzWbb/6TGMA3riP1mxK7YtuTGFiBtkFX3ND96lTJSuz1Phy1EsGP3M8G/f3HOx/gW1a/Bz
8+ api: eJytVU1v3DYQ/SvEHIoWkHbdFChQnWo0QewiaI3YORk+jKjZFSOKo5KjjdcL/fdiKG0iJ05P3cMORXE++PTmzQkE9wmqe7i8uYaHAhpKNrpBHAeo4D3JGEMyaP68/fsv0xJ6aY1tyXYmUho4JDIuNM6iuLA30pKJhM3RJEEZk+Gdubm8u4ICeKCIGva6gQpezaH+0EhQQCI7RidHqO4fCjhHTlCd4NXFhZrndV2tC0mjtZTSbvRQgOUgFERdcBh8LozD9mNSvxMk21KPupLjQFAB1x/JChQwRK1Q3Jx1Ln91Lkl0YQ8F0CP2g8+uHUwF9JQS7um/jyoGxiUzDgZDY+IYgh6ZCjhQTG6u7fvuP28uNhd6OmN7KyiUXroDNo3T66K/eXab5VzN7AmDBvoc+wQUmoFdkLI9NhGFI1QSRypg4E7K1GIIWp/uTVMGeOf2Y6TmluLBWbp+vc6BMeIRCnBC/Qv4rVPfA0mryLNXDzzgIzxM809xlZaVKnvKnwelhQq2M2+eMmeiggfV/QnG6KGCVmRI1XZ7SktlzbSJg93sIx9oY5VfXxP8JnIzWn3IPDUf3r8zn5y0ZglRpoGs2zlr0lg33KMLUMABo8PaL1Q5J5tpusPRC1TL3Z5nu2vpHNhcvzbSopiGhGLvAqXcPes0FMZeYcJYlxxIMYp1mWhg77AUShIyNhm52ZTNTvupxkSLeeF8TRHVOLGcE9UeU37BdX6RrHYSedYi8j1I2rJlT6k7rgLp7rfhdxiEe11EfBTUrtyNuZ594OQSFNBi7DlkngSt17GQXqFDh9kc1HgXSG2PQbz69yTZvWcONWG/LKM7UIQCAqEaxnRMWXHy3wsV8lCHOjPPdjO7ZgqqKbHn9R3z3lNHB80WsXFaZ7KRvc8kdPrPwSlkadQnQdfx2ZYtdX6dWyIr5I9x8HPMZbU68tR5F7oycEbhqUvHYEv9ZtodxZrt1Xbr2aJvOUn1y8Wvv31DuXf6eua2C0kwWILpQXHfcW5PJ18UqjQ3KK25vLk2P5g7Zt85MVcYA6X0beuox4/fd/hJBQ+D4YGCSTxGS2YXsadPHDuz42goYO11bGAWcCNs0DRkKUhE756oMWkcBn80gUS9NuZazBD54BpKRruQR3Vjn7KueldHjI5yqCSRsFcO5cZyQWg/T6B8Vp8jzq2fO/554iGysGWfNrAS6UWJ5zGDNo+ZgL0C+FZFxrwJexeIzgreo9NPRV92f1+JkcrcwEl6DKtAy2w7j8ZnoJ++zLf/czYvGi30KNvBq/hMxcyy0yK893AW3ocClG26dTqpwHyIfpp0+5+R4jLBzwKpT1Ohvg3FrNQdHaGCS2tpkKykfsxj4+tZrRz9PALevrmDafoXijH7rg==
99sidebar_class_name : " get api-method"
1010info_path : learn/api/path-path-api-toolkit-harness
1111custom_edit_url : null
@@ -24,44 +24,41 @@ import Heading from "@theme/Heading";
2424 as = { " h1" }
2525 className = { " openapi__heading" }
2626 children = { " Health Check" }
27- ></Heading >
27+ >
28+ </Heading >
29+
30+ <MethodEndpoint
31+ method = { " get" }
32+ path = { " /healthz" }
33+ context = { " endpoint" }
34+ >
35+
36+ </MethodEndpoint >
37+
2838
29- <MethodEndpoint method = { " get" } path = { " /healthz" } context = { " endpoint" } />
3039
3140Returns a JSON health check response indicating the ready status of PATH
3241
33- <ParamsDetails parameters = { undefined } />
42+ <ParamsDetails
43+ parameters = { undefined }
44+ >
45+
46+ </ParamsDetails >
3447
35- <RequestSchema title = { " Body" } body = { undefined } />
48+ <RequestSchema
49+ title = { " Body" }
50+ body = { undefined }
51+ >
52+
53+ </RequestSchema >
3654
3755<StatusCodes
3856 id = { undefined }
3957 label = { undefined }
40- responses = { {
41- " 200" : {
42- description: " Health check successful" ,
43- content: {
44- " application/json" : {
45- schema: {
46- type: " object" ,
47- properties: {
48- status: { type: " string" , example: " ok" },
49- message: { type: " string" , example: " PATH is up and running" },
50- version: { type: " string" , example: " 1.0.0" },
51- readyStates: {
52- type: " object" ,
53- additionalProperties: { type: " boolean" },
54- example: { " endpoint-hydrator" : true , " pokt-shannon" : true },
55- },
56- configuredServiceIDs: {
57- type: " array" ,
58- items: { type: " string" },
59- example: [" eth" , " poly" , " avax" ],
60- },
61- },
62- },
63- },
64- },
65- },
66- }}
67- />
58+ responses = { {" 200" :{" description" :" Health check successful" ," content" :{" application/json" :{" schema" :{" type" :" object" ," properties" :{" status" :{" type" :" string" ," example" :" ok" }," message" :{" type" :" string" ," example" :" PATH is up and running" }," version" :{" type" :" string" ," example" :" 1.0.0" }," readyStates" :{" type" :" object" ," additionalProperties" :{" type" :" boolean" }," example" :{" endpoint-hydrator" :true ," pokt-shannon" :true }}," configuredServiceIDs" :{" type" :" array" ," items" :{" type" :" string" }," example" :[" eth" ," poly" ," avax" ]}}}}}}}}
59+ >
60+
61+ </StatusCodes >
62+
63+
64+
0 commit comments