Skip to content

backend/docs: OpenAPI descriptions for ingest and health routes #44

Closed

Description

@CodewithJha

Problem

GOOD_FIRST_ISSUES #38: public routes lack rich OpenAPI docstrings. Ingest (/api/ingest/v1/*) and health are the surfaces external integrators hit first. FastAPI will expose schemas, but summaries/descriptions are thin.

Repository evidence

Proposed direction

Add concise summary/description on 2–4 critical routes (health, ingest open, ingest events, ingest artifact) stating observe-only / redaction required / auth when configured.

Acceptance criteria

  • OpenAPI JSON (/openapi.json) shows improved descriptions for chosen routes
  • Text states Hosted does not execute customer adapters
  • No behavior change

Difficulty

S · good first issue

Activity

  1. added
    documentationImprovements or additions to documentation
    docsDocumentation improvements
    backendAPI / Core server-side
    priority:P3Nice-to-have with real value
    on Sep 9, 2026
  2. self-assigned this
    on Sep 9, 2026
  3. BasilZafar11 commented on Oct 26, 2026

    @BasilZafar11
    Contributor

    Opened PR #138 with clearer OpenAPI descriptions for health and observe-only ingest routes. No behavior changes. All CI checks pass.

    #138

  4. added a commit that references this issue on Oct 29, 2026
    c6dbc51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

backendAPI / Core server-sidedocsDocumentation improvementsdocumentationImprovements or additions to documentationgood first issueGood for newcomerspriority:P3Nice-to-have with real value

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions