docs: org docstrings

issue: #13

src/organisation/router.py

@@ -2,15 +2,18 @@
 Router endpoints for organisation module
 
 Endpoints:
- - [get]/id/{org_id} - Retrieves an organisation by its ID
- - [post]/ - Creates a new organisation
- - [patch]/{org_id}/questionnaire - Updates the questionnaire data for an organisation (can be partial or final submission)
- - [patch]/{org_id}/status - Updates the status of an organisation
- - [patch]/{org_id}/contact - Assigns a contact to an organisation (as billing, security, or owner)
- - [get]/{org_id}/users - Retrieves all users associated with an organisation
- - [post]/{org_id}/users - Adds a new user to an organisation
- - [delete]/{org_id} - Deletes an organisation by ID
- - [get]/{org_id}/contact/{contact_type} - Retrieves the contact of a specific type (owner, billing, security) for an organisation
+ - [GET](/org/id): [root user]: Get details about an organisation(id)
+ - [POST](/org/): [oidc claim]: Creates an organisation, adds the current user as a user and sets them to be the root user
+ - [PATCH](/org/questionnaire): [root user]: Updates the org's intake questionnaire and optionally be submitted for review
+ - [PATCH](/org/status): [super admin]: Allows a super admin to update an org(id) status(Status enum)
+ - [GET](/org/users): [root user]: Gets a list of the org(id) users(email)
+ - [POST](/org/users): [root user]: Adds a new user(id) to the org(id)
+ - [DELETE](/org/): [super admin]: Deletes an organisation(id)
+ - [PATCH](/org/root_user): [super admin]: Updates an org(id) root user(id)
+ - [GET](/org/groups): [root user]: Gets a list of the org(id) groups(name)
+ - [DELETE](/org/user): [root user]: Removes a user(id) from an org(id)
+ - [GET](/org/contact): [root user]: Gets the (contact_type) contact for an org(id)
+ - [PATCH](/org/contact): [root user]: Updates the (contact_type) contact for an org(id). Any number of details can be changed.
 """
 from typing import Annotated, Optional