Skip to content

chore: add health endpoint, use real component #1309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: add health endpoint, use real component #1309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions fern/apis/public-api/definition/health.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
5 changes: 4 additions & 1 deletion .../products/docs/pages/component-library/default-components/runnable-endpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ The `<RunnableEndpoint>` component enables users to make real HTTP requests to y

<Tabs>
<Tab title="Example">
This endpoint returns the health of `api.buildwithfern.com`.
<RunnableEndpoint endpoint="GET /health" />

![Runnable Endpoint component example](runnable-endpoint.png)
This endpoint returns the document for a given domain. It requires authentication, and a `domain` path parameter.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I add my token?

<RunnableEndpoint endpoint="GET /document/{domain}" />

</Tab>
<Tab title="Markdown">
Expand Down