Commit 138f9412 authored by okhin's avatar okhin 🚴

AAdding a bit of doc for the API

parent 84565d6b
Pipeline #2614 passed with stages
in 3 minutes and 5 seconds
......@@ -19,6 +19,16 @@ class ArticleViewSet(ArticleMixin, ArticleFilterMixin, viewsets.ModelViewSet):
The RequestBody is only needed for the create, update and partial_update
functions.
You can add query parameters to do some filtering, Those are :
q="search terms" # to do a plaintext search into the title and extract
# of articles
archive="true|[false]|both" # to filter on the archive flag or to
# disable filtering on this flag.
speak="true|false|[both]" # to filter on the speak flag, or to disable
# filtering on this flag.
quote="true|false|[both]" # to filter on the quote flag, or to disable
# filtering on this flag.
list:
List all known articles in database.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment