Skip to content

/status has no documented shape #273

Closed

Description

@Miracle656

Background

/status is the endpoint every integrator and every uptime monitor hits first, and it is excluded from the OpenAPI coverage allow-list, so nothing describes what it returns or what would count as unhealthy. A monitor cannot be configured against a shape nobody has written down.

What to build

  • Document the response, and state which fields mean healthy.
  • Distinguish process health from data health: the service can be up while every venue is stale, and those must not look the same.
  • Return a non-200 only for conditions a monitor should page on, and say which those are.

Acceptance criteria

  • /status is documented with its full shape
  • Process health and data health are separate fields
  • The paging condition is stated and tested
  • A monitor configuration example is in the docs

Drips Wave · Complexity: Easy · 100 points


Repo: Divinity-Labs/Lens. Node + Fastify + Prisma + Postgres. Tests are vitest (npm test), not jest — jest against this repo fails every file and tells you nothing.

The spec is enforced. tests/openapi.test.ts boots the server and fails if a registered route is missing from openapi.yaml. Operator-only and non-HTTP routes are excluded through the commented allow-list in src/openapi/coverage.ts. A new route or a changed response means the spec changes in the same PR.

?network= is validated on every request and an unrecognised value is a 400. Routes that answer per network declare the parameter in the spec; the ones that do not are listed in the README. If the two ever disagree, the spec is the thing to fix.

Never elide a contract id or an issuer. Take addresses from the protocol's own documentation and write them whole. A sibling repo's issue wrote CD2W5LUR…XZ4L and five contributors invented plausible contract ids to fill the gap.

Change one thing. These are scoped so they land independently. A PR that also reformats a file it did not need to touch is a PR nobody can review against its issue.


Required: Before submitting, join the contributor Telegram so your work can be tracked and counted toward the Stellar Wave: https://t.me/+fxHXq8f1SwlkZDBk

Activity

  1. olatechy0 commented on Oct 16, 2026

    @olatechy0

    @olatechy0 has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    Hi i would like to work on this issue please assign to me
    I can do it perfectly

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @olatechy0 to this issue.

  2. jamal-exe commented on Oct 16, 2026

    @jamal-exe

    @jamal-exe has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    Hi, I’ve gone through the issue in detail and feel confident that I can implement a clean, efficient, and reliable solution.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @jamal-exe to this issue.

  3. aliyuHabibu commented on Oct 16, 2026

    @aliyuHabibu
    Contributor

    @aliyuHabibu has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    Hi maintainer please assign this issue to me. Thank you

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @aliyuHabibu to this issue.

  4. Azintar commented on Oct 16, 2026

    @Azintar
    Contributor

    @Azintar has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    I'm interested in taking on this issue and contributing meaningfully to the project. I'm eager to learn, put in the work, and deliver a clean, reliable solution that meets the project's requirements. I'm committed to communicating throughout the process and ensuring the work is properly tested before submission.

    I'd appreciate the opportunity to contribute. Ready to get started!

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @Azintar to this issue.

  5. drips-wave commented on Oct 16, 2026

    @drips-wave

    Congratulations, @Azintar! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on October 22, 2026.

    🧑‍💻 @Azintar: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

    Warning

    When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

    🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

    🌊 Happy Wave 🌊

  6. drips-wave commented on Oct 23, 2026

    @drips-wave

    This issue has been completed by @Azintar as part of the Stellar Wave Program's 10th Wave 🥳

    😎 @Azintar: You earned 100 Points for completing this issue! Once the Wave's rewards are finalized, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

    🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.

  7. added a commit that references this issue on Oct 23, 2026
  8. added a commit that references this issue on Oct 23, 2026
    794eb07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions