Plans for Docs' API

[RayBB]

The main README references API documentation here:

docs/README.md

Line 175 in cdafe6f

├── docs - documentation for the project, including user guides, API documentation, and other helpful resources.

However, the linked folder does not appear to contain any API documentation files. It seems I might be missing something, but I cannot locate the API docs.

Could someone please point me to the correct location for the API documentation? Additionally, it would be helpful if the docs repository could be updated to include a direct link to the API docs for easier access.

[virgile-dev]

Hey
When you run docs locally you can read the documentation on /api/v1.0/swagger

[fcecagno]

The right URL is /api/v1.0/swagger.json, but you need to set USE_SWAGGER = True on settings.py. I tried to place a local_settings.py in the same directory with the overwritten configs, however it didn't work, so I'm not sure if it's supported.

[kosssi]

@virgile-dev To facilitate membership around Docs with integration into software like n8n, I think it will make it easier for administrators to activate or not Swagger from an environment variable.

[virgile-dev]

@qbey or @lunika could you detail here our plans for the the Docs' API ?
This way I'll just be able to send people to your answer when they ask.
Thanks !