Skip to content

Provide OpenAPI specs #550

Description

@debuglevel

It would be nice if the API provides an endpoint to an OpenAPI specification. This would facilitate code generation for client libraries.

Unfortunately - if Spark did not change much since I used it - it does not support this out of the box. Therefore it would require manual work. There is also https://github.com/manusant/spark-swagger, but I never tried it back then.

Activity

  1. KiwiKilian commented on Feb 1, 2024

    @KiwiKilian

    Here is the OpenAPI Spec we use https://gist.github.com/KiwiKilian/1f9d35544a7e9312bb74bd75a889df9c.

    I don't know anything about spark, therefore I could only contribute the manually created spec. But at least some Swagger UI would be necessary for proper display in the Docs?

  2. danielgit0 commented on Jun 10, 2024

    @danielgit0

    Hi, in the meantime, here is a small update with the status endpoint

    openapi.json

  3. lonvia commented on Aug 25, 2025

    @lonvia
    Collaborator

    There is https://github.com/javalin/javalin-openapi, is somebody want to try their hands on this.

  4. lonvia commented on Apr 22, 2026

    @lonvia
    Collaborator

    Given how the AI armies of bots and vibe coders have laid waste on free Internet services over the last year, I'm no longer in favour of having an endpoint that facilitates their work.

    I very much like the approach from #1038 where we add a static OpenAPI spec in this repository from which to also generate the human readable documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions