get people finder API, endpoint and schema with wiring into core and …

…profile services

core/api/people_finder.py

@@ -19,7 +19,7 @@
     },
 )
 def get_by_slug(request, slug: str):
-    """Just a demo, do not build against this"""
+    """Optimised, low-flexibility endpoint to return a minimal peoplefinder profile record"""
     try:
         return core_services.get_peoplefinder_profile_by_slug(slug=slug)
     except PeopleFinderProfile.DoesNotExist:

core/services.py

@@ -3,6 +3,7 @@
 from typing import Optional
 
 from profiles import services as profile_services
+from profiles.models import PeopleFinderProfile
 from profiles.models.combined import Profile
 from profiles.types import UNSET, Unset  # noqa
 from user import services as user_services
@@ -183,5 +184,8 @@ def delete_identity(profile: Profile) -> None:
         user_services.delete_from_database(user=user)
 
 
-def get_peoplefinder_profile_by_slug(slug: str):
+def get_peoplefinder_profile_by_slug(slug: str) -> PeopleFinderProfile:
+    """
+    Retrieve peoplefinder profile by its slug.
+    """
     return profile_services.get_peoplefinder_profile_by_slug(slug=slug)

profiles/services/__init__.py

@@ -379,5 +379,9 @@ def delete(profile_id: str) -> dict[str, models.Model]:
     return all_profiles
 
 
-def get_peoplefinder_profile_by_slug(slug):
+def get_peoplefinder_profile_by_slug(slug: str) -> PeopleFinderProfile:
+    """
+    Gets peoplefinder profile from peoplefinder service
+    :param slug: Peoplefinder profile slug
+    """
     return peoplefinder.get_by_slug(slug=slug)