docs: document api endpoints #124

Activity

1. wojciechkrzos

   moved this to Backlog in ToPWRon Mar 10, 2025
2. wojciechkrzos

   added this to ToPWRon Mar 10, 2025
3. czaja307

   moved this from Backlog to Todo in ToPWRon Mar 10, 2025
4. czaja307

   changed the title [-]doc: document api endpoints[/-] [+]docs: document api endpoints[/+] on Mar 10, 2025
5. wojciechkrzos

   assigned

   Lennox2536

   on Mar 10, 2025
6. czaja307 commented on Mar 10, 2025

   

   czaja307

   on Mar 10, 2025

   Member

   More actions

   https://github.com/ad-on-is/adonis-autoswagger

   👍React with 👍1Reacted by Wojciech Krzos
7. nuklearbanana

   unassigned

   Lennox2536

   on Apr 28, 2025
8. mini-bomba

   self-assigned this

   on Jun 9, 2025
9. s4n000

   moved this from Todo to In Progress in ToPWRon Jul 7, 2025
10. nuklearbanana

    unassigned

    mini-bomba

    on Oct 6, 2025
11. nuklearbanana

    moved this from In Progress to Todo in ToPWRon Oct 6, 2025
12. czaja307

    moved this from Todo to Backlog in ToPWRon Mar 16, 2026
13. Infor-Tech

    moved this from Backlog to Todo in ToPWRon Aug 17, 2026
14. mini-bomba commented on Aug 17, 2026

    

    mini-bomba

    on Aug 17, 2026

    Member

    More actions

    suggested solution:

    • create our own autoswagger impelmentation
      • generate validators with #utils/model_autogen.AutogenCacheEntry
      • convert validators to JSON schema with .toJSONSchema()
      • then use that JSON schema to create an OpenAPI schema
      • embed an OpenAPI frontend
    • possibly extend our model typing decorators with field descriptions, to be embedded into the schema