# gramps-mcp - AI-Powered Genealogy Research & Management
# Copyright (C) 2025 cabout.me
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
"""
Pydantic models for place-related operations.
API calls supported in this category:
- GET_PLACES: Get information about multiple places
- POST_PLACES: Add a new place to the database
- GET_PLACE: Get information about a specific place
- PUT_PLACE: Update the place
- DELETE_PLACE: Delete the place
"""
from typing import List, Optional
from pydantic import BaseModel, Field
from .base_params import BaseGetMultipleParams, BaseGetSingleParams
class PlaceSearchParams(BaseGetMultipleParams):
"""Parameters for searching places."""
pass
class PlaceDetailsParams(BaseGetSingleParams):
"""Parameters for getting specific place details."""
pass
class PlaceSaveParams(BaseModel):
"""Parameters for creating or updating a place."""
handle: Optional[str] = Field(
None, min_length=8, description="Place handle (for updates; omit for new place)"
)
gramps_id: Optional[str] = Field(
None, description="Alternate user managed identifier"
)
name: Optional[dict] = Field(
None, description="Place name object with 'value' field"
)
code: Optional[str] = Field(None, description="Place code")
alt_loc: Optional[List[dict]] = Field(None, description="Alternative locations")
place_type: str = Field(..., description="Place type")
placeref_list: Optional[List[dict]] = Field(
None, description="List of place references"
)
alt_names: Optional[List[str]] = Field(None, description="Alternative names")
lat: Optional[str] = Field(None, description="Latitude coordinate")
long: Optional[str] = Field(None, description="Longitude coordinate")
urls: Optional[List[dict]] = Field(None, description="Associated URLs")
media_list: Optional[List[str]] = Field(None, description="List of media handles")
citation_list: Optional[List[str]] = Field(
None, description="List of citation handles"
)
note_list: Optional[List[str]] = Field(None, description="List of note handles")
tag_list: Optional[List[str]] = Field(None, description="List of tag handles")
private: Optional[bool] = Field(None, description="Mark as private")
