Programmatic way to get all API endpoints for my instance?

[RGJ (Richard - Communiteq)]

@mcwumbly

So what stability guarantees can we be making about our backend API?

I think that’s a responsibility those API docs should be addressing.

Stability guarantees should be addressed by straightforward API versioning.

@mcwumbly

First, as a kind of higher level mental model, I’d describe things like this:

• Our main entrypoint for documentation is here, as you pointed out: Documentation - Discourse Meta
  • For developer documentation, it’s here, or perhaps better yet, here: Introduction to Discourse Development
    • API docs are a subset of developer docs, and are located here: https://docs.discourse.org/

I would call the API docs docs rather than specs, but I agree they are still a subset of our developer docs. The URL for those docs is odd… it’d make more sense for our full documentation to live there or for that to be a redirect to Documentation - Discourse Meta, and for there to be a clear signpost from Introduction to Discourse Development to the API docs.

This topic isn’t about where the documentation lives — it’s about how the API is documented. What’s missing is a standardized, machine-readable format like OpenAPI.

That absence, along with the lack of versioning, makes integration work harder and more fragile than it should be. Even a basic OpenAPI schema for the documented endpoints would be really helpful.