diff --git a/src/contact/config.py b/src/contact/config.py index 5e7f864..2253a68 100644 --- a/src/contact/config.py +++ b/src/contact/config.py @@ -1,7 +1,3 @@ """ -Configurations for contact module - -Configurations: - - List: Description - - Configs: Description +Configurations for the contact module """ \ No newline at end of file diff --git a/src/contact/constants.py b/src/contact/constants.py index 49898d6..41f6ded 100644 --- a/src/contact/constants.py +++ b/src/contact/constants.py @@ -1,7 +1,3 @@ """ -Constants and error codes for contact module - -Constants: - - List: Description - - Consts: Description +Constants for the contact module """ \ No newline at end of file diff --git a/src/contact/dependencies.py b/src/contact/dependencies.py index 2450730..de1d404 100644 --- a/src/contact/dependencies.py +++ b/src/contact/dependencies.py @@ -1,11 +1,3 @@ """ -Router dependencies for contact module - -Classes: - - List: Description - - Classes: Description - -Functions: - - List: Description - - Functions: Description +Dependencies for the contact module """ \ No newline at end of file diff --git a/src/contact/exceptions.py b/src/contact/exceptions.py index b3f8e11..6710bf3 100644 --- a/src/contact/exceptions.py +++ b/src/contact/exceptions.py @@ -1,9 +1,8 @@ """ -Module specific exceptions for contact module +Exceptions related to the contact module -Exceptions: - - List: Description - - Exceptions: Description +Exports: + - ContactNotFoundException: Takes an optional contact ID int """ from typing import Optional diff --git a/src/contact/models.py b/src/contact/models.py index e3d0d05..3369501 100644 --- a/src/contact/models.py +++ b/src/contact/models.py @@ -1,9 +1,9 @@ """ -Database models for contact module +Database models for the contact module Models: - Contact: id[pk], email, first_name, last_name, phonenumber, vat_number - street_address, post_office_box_number, address_locality, country_code, address_region, postal_code + street_address, street_address_line_2, post_office_box_number, address_locality, country_code, address_region, postal_code """ from sqlalchemy import Column, Integer, String, ForeignKey diff --git a/src/contact/router.py b/src/contact/router.py index 9528fd9..cdab37f 100644 --- a/src/contact/router.py +++ b/src/contact/router.py @@ -1,13 +1,5 @@ """ -Router endpoints for contact module - -Endpoints: - - [get]/{contact_id} - Returns non-address type details for contact - - [get]/{contact_id}/address - Returns address details for contact - - [get]/{contact_id}/orgs - Returns a list of orgs which the contact is assigned to, and what they are assigned as - - [post]/ - Creates a new contact - - [patch]/{contact_id} - Updates the details of an existing contact - - [delete]/{contact_id} - Deletes a contact by ID +Router endpoints for the contact module """ from fastapi import APIRouter diff --git a/src/contact/schemas.py b/src/contact/schemas.py index b5103f0..b008739 100644 --- a/src/contact/schemas.py +++ b/src/contact/schemas.py @@ -1,9 +1,9 @@ """ -Pydantic models for contact module +Pydantic models for the contact module Models: - - List: Description - - Models: Description + - ContactAddress + - ContactModel: Contains ContactAddress as a property """ from typing import Optional diff --git a/src/contact/service.py b/src/contact/service.py index ee4af6c..e04866a 100644 --- a/src/contact/service.py +++ b/src/contact/service.py @@ -1,11 +1,3 @@ """ -Module specific business logic for contact module - -Classes: - - List: Description - - Classes: Description - -Functions: - - List: Description - - Functions: Description +Module specific business logic for the contact module """ \ No newline at end of file diff --git a/src/contact/utils.py b/src/contact/utils.py index 74ec5c5..6a1d14a 100644 --- a/src/contact/utils.py +++ b/src/contact/utils.py @@ -1,11 +1,3 @@ """ -Non-business logic reusable functions and classes for contact module - -Classes: - - List: Description - - Classes: Description - -Functions: - - List: Description - - Functions: Description +Non-business logic reusable functions and classes for the contact module """ \ No newline at end of file