diff --git a/fern/apis/public-api/definition/health.yml b/fern/apis/public-api/definition/health.yml new file mode 100644 index 000000000..95bdbb749 --- /dev/null +++ b/fern/apis/public-api/definition/health.yml @@ -0,0 +1,15 @@ +service: + base-path: / + auth: false + audiences: + - external + endpoints: + health: + method: GET + display-name: Health + path: health + docs: Check the health of the SDK generation service. The response will be "OK" if the service is healthy. + response: string + examples: + - response: + body: "OK" diff --git a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx index 86416ca7b..d102f5398 100644 --- a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx +++ b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx @@ -7,8 +7,11 @@ The `` component enables users to make real HTTP requests to y +This endpoint returns the health of `api.buildwithfern.com`. + -![Runnable Endpoint component example](runnable-endpoint.png) +This endpoint returns the document for a given domain. It requires authentication, and a `domain` path parameter. +