Planka Pro API Spec? #903

New Issue

OVERLORD · 2026-02-04T21:35:19+03:00

OVERLORD commented

2026-02-04 21:35:19 +03:00

Originally created by @hwelch-fle on GitHub (Jan 22, 2026).

Which part of the project does this feature apply to?

Backend

What would you like?

I've been messing around with plankapy and the pro demo instance today and while all the non-pro endpoints work fine, I was wondering if there are plans to publish the Pro api endpoints/schemas as well? I've setup some submodules in plankapy that subclass the open interface, but will also expose additional functionality if you're connected to a pro instance, but I'm currently shooting in the dark.

https://github.com/hwelch-fle/plankapy/blob/v2.0.0_refactor/src/plankapy/v2/api/pro_schemas.py

Why is this needed?

To allow pro users to use plankapy

Other information

No response

Originally created by @hwelch-fle on GitHub (Jan 22, 2026). ### Which part of the project does this feature apply to? Backend ### What would you like? I've been messing around with plankapy and the pro demo instance today and while all the non-pro endpoints work fine, I was wondering if there are plans to publish the Pro api endpoints/schemas as well? I've setup some submodules in plankapy that subclass the open interface, but will also expose additional functionality if you're connected to a pro instance, but I'm currently shooting in the dark. https://github.com/hwelch-fle/plankapy/blob/v2.0.0_refactor/src/plankapy/v2/api/pro_schemas.py ### Why is this needed? To allow pro users to use plankapy ### Other information _No response_

OVERLORD commented

2026-02-04 21:35:35 +03:00

@meltyshev commented on GitHub (Jan 23, 2026):

Thanks for the question - it would be great to be able to use the Pro API as well!

We do have a Swagger spec, but haven't decided yet where to publish it - trying to keep things separated so we don't mix everything together. Once the release is fully done with all the docs, I'll post a link here :)

@meltyshev commented on GitHub (Jan 23, 2026): Thanks for the question - it would be great to be able to use the Pro API as well! We do have a Swagger spec, but haven't decided yet where to publish it - trying to keep things separated so we don't mix everything together. Once the release is fully done with all the docs, I'll post a link here :)

OVERLORD commented

2026-02-04 21:35:41 +03:00

@hwelch-fle commented on GitHub (Jan 24, 2026):

We do have a Swagger spec, but haven't decided yet where to publish it - trying to keep things separated so we don't mix everything together. Once the release is fully done with all the docs, I'll post a link here :)

Could you just include the spec with the release? I should be able to ping https://.../api/swagger.json to pull the file for an instance. I'm debating the idea of allowing plankapy to rewrite itself depending on the contents of that file if it's available since the module re-write script runs in ~100ms.

Adding a https://.../api/swagger-ui page would be great too.

For reference, I've used Directus and they include the swagger.json as a queryable endpoint

@hwelch-fle commented on GitHub (Jan 24, 2026): > We do have a Swagger spec, but haven't decided yet where to publish it - trying to keep things separated so we don't mix everything together. Once the release is fully done with all the docs, I'll post a link here :) Could you just include the spec with the release? I should be able to ping `https://.../api/swagger.json` to pull the file for an instance. I'm debating the idea of allowing plankapy to rewrite itself depending on the contents of that file if it's available since the module re-write script runs in ~100ms. Adding a `https://.../api/swagger-ui` page would be great too. For reference, I've used Directus and they include the swagger.json as a queryable endpoint

OVERLORD commented

2026-02-04 21:35:47 +03:00

@meltyshev commented on GitHub (Jan 25, 2026):

I also thought about embedding Swagger UI, but probably with a way to enable it via environment variables. The idea of making swagger.json fetchable is nice!

@meltyshev commented on GitHub (Jan 25, 2026): I also thought about embedding Swagger UI, but probably with a way to enable it via environment variables. The idea of making `swagger.json` fetchable is nice!

OVERLORD referenced this issue

2026-02-04 21:53:00 +03:00

[PR #903] [MERGED] feat(chart): Support Service Annotations #1141

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/planka#903