DRF Docs

Document Web APIs made with Django REST Framework.

accounts

A view that allows users to login providing their username and password.

Fields:

  • username: CharField R
  • password: CharField R

Fields:

  • username: CharField R
  • email: EmailField R
  • full_name: CharField R
  • password: CharField R

No fields.

An endpoint for users to view and update their profile information.

Fields:

  • username: CharField R
  • email: EmailField R
  • full_name: CharField R
  • password: CharField R
  • is_active: BooleanField

organisations

Allows users create an organisation.

Fields:

  • name: CharField R
  • slug: SlugField R

List all the members for an organisation. User should be a member of that organisation.

Fields:

  • joined: DateTimeField
  • user: SerializerMethodField
  • is_owner: BooleanField

Users can leave an organisation if they are not the owner or the only admin.

No fields.