Skip to content
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

Jump to bottom

docs: Health check endpoint #3959

Merged
merged 8 commits into from
Jun 12, 2023
Merged

docs: Health check endpoint #3959

merged 8 commits into from
Jun 12, 2023

Conversation

chriswk
Copy link
Contributor

@chriswk chriswk commented Jun 12, 2023

What

Adds documentation for the health check endpoint.

@vercel
Copy link

vercel bot commented Jun 12, 2023 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 12, 2023 0:47am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
unleash-docs ⬜️ Ignored (Inspect) Jun 12, 2023 0:47am

thomasheartman
thomasheartman approved these changes Jun 12, 2023
View reviewed changes
Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

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

This looks good to me! 😄 I have a few small suggestions, but nothing really very important. Some clarification would be nice some times, but I'll leave it up to you 🙌🏼

src/lib/openapi/spec/health-check-schema.ts Outdated Show resolved Hide resolved
src/lib/openapi/spec/health-check-schema.ts Outdated Show resolved Hide resolved
src/lib/routes/health-check.ts Outdated Show resolved Hide resolved
src/lib/routes/health-check.ts Outdated Show resolved Hide resolved
src/lib/openapi/spec/health-check-schema.ts Show resolved Hide resolved
Christopher Kolstad and others added 5 commits June 12, 2023 13:44
@thomasheartman
Update src/lib/openapi/spec/health-check-schema.ts
f19d0c6 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@thomasheartman
Update src/lib/openapi/spec/health-check-schema.ts
a3c85cd 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@thomasheartman
Update src/lib/routes/health-check.ts
5f335a3 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@thomasheartman
Update src/lib/routes/health-check.ts
773bb7e 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@thomasheartman
Update src/lib/openapi/spec/health-check-schema.ts
fa4995c 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@chriswk
Copy link
Contributor Author

chriswk commented Jun 12, 2023 •
edited

We're running into an overloaded concept with operator. This healthcheck endpoint is used in k8s, mesos, docker swarm, pm2. So any application orchestrator. Maybe that's a better word, including somehing like meant for usage by your deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et.al.)

@thomasheartman
Copy link
Contributor

Yeah, that sounds like a good call!

@chriswk chriswk enabled auto-merge (squash) June 12, 2023 12:47
@chriswk chriswk merged commit 7003351 into main Jun 12, 2023
16 checks passed
@chriswk chriswk deleted the docs/operationalTag branch June 12, 2023 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasheartman thomasheartman thomasheartman approved these changes

@gastonfournier gastonfournier Awaiting requested review from gastonfournier

Assignees

@chriswk chriswk

Labels
None yet
Projects
Issues and PRs
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@chriswk @thomasheartman