Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creme API #380

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions creme/creme_api/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@

###################################
## application
applications servers / application user
filtre / IP
utilisateurs autorisés
configuration de la durée max des tokens
restriction par scopes (resources)
##tokens
restriction par scopes (resources)


# Documentation
- Une page custom pour la documentation ? (Charte graphique Creme)

# Restapi
- Erreurs 400 format custom {errors: [{code, field_name, message}, ...]}
- pagination headers au lieu de la réponse ?
- versionning



# TODO: ordering, filtering
https://www.django-rest-framework.org/api-guide/filtering/

# TODO: applications scopes (for per resource restrictions)
# {tokens scopes} € {token.application scopes}

# TODO: SetCredentials.efilter; require entityfilters endpoints

# TODO: Swagger documentation
# - authentication scheme
# https://swagger.io/docs/specification/authentication/
# Swagger.persistAuthorization ?
# - embed swagger lib dist
# - documentation markdown description
1 change: 1 addition & 0 deletions creme/creme_api/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
VERSION = "1.0.0"
Empty file added creme/creme_api/api/__init__.py
Empty file.
Empty file.
Loading