defguard icon indicating copy to clipboard operation
defguard copied to clipboard

Docs for REST API

Open eblet opened this issue 1 year ago • 5 comments

where docs for defg api? :D

eblet avatar Dec 17 '23 18:12 eblet

hi! I'm raising a question about API documentation I have a question

  • how to create/block a user in Defguard via API? we are making a service for internal use within the company, and we want to manage DG users through our service

eblet avatar Feb 13 '24 14:02 eblet

@teon

eblet avatar Feb 13 '24 14:02 eblet

@eblet For now we don't have any user "disabling" - I have added it to backlog - you can follow the issue: https://github.com/DefGuard/defguard/issues/556 for now if you want to disable a user the simplest "hack" is to change it's password API docs are on backlog as well - but too much to be done..

teon avatar Feb 19 '24 10:02 teon

Summing up - we need API documentation - best would be to:

  • [ ] automatically generate them using Rust Doc mechanisms
  • [ ] would be great to prepare a GitHub Actions pipeline that will produce artefacts and publish them (we could use github pages to publish then on: https://docs.defguard.net for example).

teon avatar Jul 01 '24 12:07 teon

@cpprian we need info about API docs in gitbook as well. How can be accessed (url)...

teon avatar Jul 18 '24 11:07 teon

Done in upcomming 1.0.0

teon avatar Aug 15 '24 16:08 teon