Projet

Général

Profil

Documentation #58407

[Documentation][Authentic][API] Préciser les paramètres du endpoint roles sur authentic

Ajouté par Mikaël Ates il y a plus de 2 ans. Mis à jour il y a plus de 2 ans.

Statut:
Fermé
Priorité:
Normal
Assigné à:
Catégorie:
-
Version cible:
-
Début:
05 novembre 2021
Echéance:
% réalisé:

0%

Temps estimé:
Patch proposed:
Non
Planning:
Non
Club:
Non

Description

Par exemple limit et offset pour la pagination.

Le filtrage sur uuid, name et slug.

Page de la doc concernée : https://doc-publik.entrouvert.com/dev/api-authentic/gestion-des-roles/lister-les-roles/


Demandes liées

Lié à Publik - Support #41201: Disposer d'une api permettant de lister les rôles dans un WFNouveau31 mars 2020

Actions
Lié à Authentic 2 - Development #58417: supporter le paramètre offset sur l'api usersRejeté05 novembre 2021

Actions

Historique

#3

Mis à jour par Mikaël Ates il y a plus de 2 ans

  • Lié à Support #41201: Disposer d'une api permettant de lister les rôles dans un WF ajouté
#4

Mis à jour par Mikaël Ates il y a plus de 2 ans

  • Description mis à jour (diff)
#6

Mis à jour par Nicolas Roche il y a plus de 2 ans

  • Statut changé de Nouveau à Solution déployée
  • Assigné à mis à Nicolas Roche

limit et offset viennent de Django REST framework : https://www.django-rest-framework.org/api-guide/pagination/#limitoffsetpagination
cf src/authentic2/settings.py :

REST_FRAMEWORK = {
...
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
    'PAGE_SIZE': 100,
}

C'est vaguement indiqué par le retour donné dans l'exemple sur la doc :

"next": "https://foo.com/api/roles/?limit=10&offset=10",

J'ai complété le tableau des paramètres dans la doc.

#7

Mis à jour par Mikaël Ates il y a plus de 2 ans

  • Statut changé de Solution déployée à Information nécessaire

On pourrait préciser ['exact', 'iexact', 'icontains', 'startswith'] pour name et slug non ? C'est le cas sur les users pour l'email dans sur https://doc-publik.entrouvert.com/dev/api-authentic/gestion-des-utilisateurs/lister-et-rechercher-des-utilisateurs/

On pourrait au passage préciser les paramètres de pagination sur les users https://doc-publik.entrouvert.com/dev/api-authentic/gestion-des-utilisateurs/lister-et-rechercher-des-utilisateurs/ aussi ?

#8

Mis à jour par Nicolas Roche il y a plus de 2 ans

#9

Mis à jour par Nicolas Roche il y a plus de 2 ans

  • Statut changé de Information nécessaire à En cours

On pourrait au passage préciser les paramètres de pagination sur les users

bof, pour moi le paramètre offset ne fonctionne pas sur l'api user : #58417

On pourrait préciser [' exact ', 'iexact', 'icontains', 'startswith'] pour name et slug non ?

Je fais ça.
Pour 'exact' c'est juste 'name=...' à mon avis.

Formats disponibles : Atom PDF