fix: correct bad usage of ellipsis that cancelled Optional flag

Author: the-forest-tree

hrflow/hrflow/schemas.py

@@ -28,15 +28,15 @@ class LocationFields(BaseModel):
 
 
 class Location(BaseModel):
-    text: t.Optional[str] = Field(..., description="Location text address.")
+    text: t.Optional[str] = Field(None, description="Location text address.")
     lat: t.Optional[float] = Field(
-        ..., description="Geocentric latitude of the Location."
+        None, description="Geocentric latitude of the Location."
     )
     lng: t.Optional[float] = Field(
-        ..., description="Geocentric longitude of the Location."
+        None, description="Geocentric longitude of the Location."
     )
     _fields: t.Optional[LocationFields] = Field(
-        ...,
+        None,
         alias="fields",
         description="other location attributes like country, country_code etc",
     )
@@ -45,56 +45,58 @@ class Location(BaseModel):
 class GeneralEntitySchema(BaseModel):
     name: str = Field(..., description="Identification name of the Object")
     value: t.Optional[str] = Field(
-        ..., description="Value associated to the Object's name"
+        None, description="Value associated to the Object's name"
     )
 
 
 class Skill(BaseModel):
     name: str = Field(..., description="Identification name of the skill")
-    type: t.Optional[str] = Field(..., description="Type of the skill. hard or soft")
-    value: t.Optional[str] = Field(..., description="Value associated to the skill")
+    type: t.Optional[str] = Field(None, description="Type of the skill. hard or soft")
+    value: t.Optional[str] = Field(None, description="Value associated to the skill")
 
 
 # Job
 class Section(BaseModel):
     name: t.Optional[str] = Field(
-        ...,
+        None,
         description="Identification name of a Section of the Job. Example: culture",
     )
     title: t.Optional[str] = Field(
-        ..., description="Display Title of a Section. Example: Corporate Culture"
+        None, description="Display Title of a Section. Example: Corporate Culture"
     )
     description: t.Optional[str] = Field(
-        ..., description="Text description of a Section: Example: Our values areNone"
+        None, description="Text description of a Section: Example: Our values areNone"
     )
 
 
 class RangesFloat(BaseModel):
     name: t.Optional[str] = Field(
-        ...,
+        None,
         description=(
             "Identification name of a Range of floats attached "
             "to the Job. Example: salary"
         ),
     )
-    value_min: t.Optional[float] = Field(..., description="Min value. Example: 500.")
-    value_max: t.Optional[float] = Field(..., description="Max value. Example: 100.")
-    unit: t.Optional[str] = Field(..., description="Unit of the value. Example: euros.")
+    value_min: t.Optional[float] = Field(None, description="Min value. Example: 500.")
+    value_max: t.Optional[float] = Field(None, description="Max value. Example: 100.")
+    unit: t.Optional[str] = Field(
+        None, description="Unit of the value. Example: euros."
+    )
 
 
 class RangesDate(BaseModel):
     name: t.Optional[str] = Field(
-        ...,
+        None,
         description=(
             "Identification name of a Range of dates attached"
             " to the Job. Example: availability."
         ),
     )
     value_min: t.Optional[str] = Field(
-        ..., description="Min value in datetime ISO 8601, Example: 500."
+        None, description="Min value in datetime ISO 8601, Example: 500."
     )
     value_max: t.Optional[str] = Field(
-        ..., description="Max value in datetime ISO 8601, Example: 1000"
+        None, description="Max value in datetime ISO 8601, Example: 1000"
     )
 
 
@@ -111,59 +113,74 @@ class Board(BaseModel):
 
 
 class HrFlowJob(BaseModel):
-    key: str = Field(..., description="Identification key of the Job.")
-    reference: t.Optional[str] = Field(..., description="Custom identifier of the Job.")
+    key: str = Field(None, description="Identification key of the Job.")
+    reference: t.Optional[str] = Field(
+        None, description="Custom identifier of the Job."
+    )
     name: str = Field(..., description="Job title.")
-    board_key: str
+    board_key: str = Field(
+        ..., description="Identification key of the Board attached to the Job."
+    )
     location: Location = Field(..., description="Job location object.")
-    sections: t.List[Section] = Field(..., description="Job custom sections.")
-    culture: t.Optional[str]
-    benefits: t.Optional[str]
-    responsibilities: t.Optional[str]
-    requirements: t.Optional[str]
-    interviews: t.Optional[str]
-    url: t.Optional[str] = Field(..., description="Job post original URL.")
-    summary: t.Optional[str] = Field(..., description="Brief summary of the Job.")
+    sections: t.List[Section] = Field(None, description="Job custom sections.")
+    culture: t.Optional[str] = Field(
+        None, description="Describes the company's values, work environment, and ethos."
+    )
+    benefits: t.Optional[str] = Field(
+        None, description="Lists the perks and advantages offered to employees."
+    )
+    responsibilities: t.Optional[str] = Field(
+        None, description="Outlines the duties and tasks expected from the role."
+    )
+    requirements: t.Optional[str] = Field(
+        None,
+        description="Specifies the qualifications and skills needed for the position.",
+    )
+    interviews: t.Optional[str] = Field(
+        None, description="Provides information about the interview process and stages."
+    )
+    url: t.Optional[str] = Field(None, description="Job post original URL.")
+    summary: t.Optional[str] = Field(None, description="Brief summary of the Job.")
     board: Board
     archived_at: t.Optional[str] = Field(
-        ...,
+        None,
         description=(
             "type: datetime ISO8601, Archive date of the Job. "
             "The value is null for unarchived Jobs."
         ),
     )
     updated_at: str = Field(
-        ..., description="type: datetime ISO8601, Last update date of the Job."
+        None, description="type: datetime ISO8601, Last update date of the Job."
     )
     created_at: t.Optional[str] = Field(
-        ..., description="type: datetime ISO8601, Creation date of the Job."
+        None, description="type: datetime ISO8601, Creation date of the Job."
     )
     skills: t.Optional[t.List[Skill]] = Field(
-        ..., description="List of skills of the Job."
+        None, description="List of skills of the Job."
     )
     languages: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of spoken languages of the Job"
+        None, description="List of spoken languages of the Job"
     )
     certifications: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of certifications of the Job."
+        None, description="List of certifications of the Job."
     )
     courses: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of courses of the Job"
+        None, description="List of courses of the Job"
     )
     tasks: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of tasks of the Job"
+        None, description="List of tasks of the Job"
     )
     tags: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of tags of the Job"
+        None, description="List of tags of the Job"
     )
     metadatas: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of metadatas of the Job"
+        None, description="List of metadatas of the Job"
     )
     ranges_float: t.Optional[t.List[RangesFloat]] = Field(
-        ..., description="List of ranges of floats"
+        None, description="List of ranges of floats"
     )
     ranges_date: t.Optional[t.List[RangesDate]] = Field(
-        ..., description="List of ranges of dates"
+        None, description="List of ranges of dates"
     )
 
 
@@ -181,79 +198,81 @@ class ProfileInfo(BaseModel):
     last_name: t.Optional[str]
     email: t.Optional[str]
     phone: t.Optional[str]
-    date_birth: t.Optional[str] = Field(..., description="Profile date of birth")
-    location: t.Optional[Location] = Field(..., description="Profile location object")
+    date_birth: t.Optional[str] = Field(None, description="Profile date of birth")
+    location: t.Optional[Location] = Field(None, description="Profile location object")
     urls: t.Optional[t.List[Url]] = Field(
-        ..., description="Profile social networks and URLs"
+        None, description="Profile social networks and URLs"
     )
-    picture: t.Optional[str] = Field(..., description="Profile picture url")
-    gender: t.Optional[str] = Field(..., description="Profile gender")
-    summary: t.Optional[str] = Field(..., description="Profile summary text")
+    picture: t.Optional[str] = Field(None, description="Profile picture url")
+    gender: t.Optional[str] = Field(None, description="Profile gender")
+    summary: t.Optional[str] = Field(None, description="Profile summary text")
 
 
 class Experience(BaseModel):
     key: t.Optional[str] = Field(
-        ..., description="Identification key of the Experience."
+        None, description="Identification key of the Experience."
+    )
+    company: t.Optional[str] = Field(
+        None, description="Company name of the Experience."
     )
-    company: t.Optional[str] = Field(..., description="Company name of the Experience.")
-    logo: t.Optional[str] = Field(..., description="Logo of the Company.")
-    title: t.Optional[str] = Field(..., description="Title of the Experience.")
+    logo: t.Optional[str] = Field(None, description="Logo of the Company.")
+    title: t.Optional[str] = Field(None, description="Title of the Experience.")
     description: t.Optional[str] = Field(
-        ..., description="Description of the Experience."
+        None, description="Description of the Experience."
     )
     location: t.Optional[Location] = Field(
-        ..., description="Location object of the Experience."
+        None, description="Location object of the Experience."
     )
     date_start: t.Optional[str] = Field(
-        ..., description="Start date of the experience. type: ('datetime ISO 8601')"
+        None, description="Start date of the experience. type: ('datetime ISO 8601')"
     )
     date_end: t.Optional[str] = Field(
-        ..., description="End date of the experience. type: ('datetime ISO 8601')"
+        None, description="End date of the experience. type: ('datetime ISO 8601')"
     )
     skills: t.Optional[t.List[Skill]] = Field(
-        ..., description="List of skills of the Experience."
+        None, description="List of skills of the Experience."
     )
     certifications: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of certifications of the Experience."
+        None, description="List of certifications of the Experience."
     )
     courses: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of courses of the Experience."
+        None, description="List of courses of the Experience."
     )
     tasks: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of tasks of the Experience."
+        None, description="List of tasks of the Experience."
     )
 
 
 class Education(BaseModel):
     key: t.Optional[str] = Field(
-        ..., description="Identification key of the Education."
+        None, description="Identification key of the Education."
     )
-    school: t.Optional[str] = Field(..., description="School name of the Education.")
-    logo: t.Optional[str] = Field(..., description="Logo of the School.")
-    title: t.Optional[str] = Field(..., description="Title of the Education.")
+    school: t.Optional[str] = Field(None, description="School name of the Education.")
+    logo: t.Optional[str] = Field(None, description="Logo of the School.")
+    title: t.Optional[str] = Field(None, description="Title of the Education.")
     description: t.Optional[str] = Field(
-        ..., description="Description of the Education."
+        None, description="Description of the Education."
     )
     location: t.Optional[Location] = Field(
-        ..., description="Location object of the Education."
+        None, description="Location object of the Education."
     )
     date_start: t.Optional[str] = Field(
-        ..., description="Start date of the Education. type: ('datetime ISO 8601')"
+        None, description="Start date of the Education. type: ('datetime ISO 8601')"
     )
     date_end: t.Optional[str] = Field(
-        ..., description="End date of the Education. type: ('datetime ISO 8601')"
+        None, description="End date of the Education. type: ('datetime ISO 8601')"
     )
     skills: t.Optional[t.List[Skill]] = Field(
-        ..., description="List of skills of the Education."
+        None, description="List of skills of the Education."
     )
     certifications: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of certifications of the Education."
+        None, description="List of certifications of the Education."
     )
     courses: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of courses of the Education."
+        None, description="List of courses of the Education."
     )
     tasks: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of tasks of the Education."
+        None, description="List of tasks of the Education."
     )
 
 
@@ -270,67 +289,67 @@ class Attachment(BaseModel):
 
 
 class HrFlowProfile(BaseModel):
-    key: str = Field(..., description="Identification key of the Profile.")
+    key: str = Field(None, description="Identification key of the Profile.")
     reference: t.Optional[str] = Field(
-        ..., description="Custom identifier of the Profile."
+        None, description="Custom identifier of the Profile."
     )
     info: ProfileInfo = Field(..., description="Object containing the Profile's info.")
     text_language: str = Field(
         ..., description="Code language of the Profile. type: string code ISO 639-1"
     )
     text: str = Field(..., description="Full text of the Profile..")
     archived_at: t.Optional[str] = Field(
-        ...,
+        None,
         description=(
             "type: datetime ISO8601, Archive date of the Profile."
             " The value is null for unarchived Profiles."
         ),
     )
     updated_at: str = Field(
-        ..., description="type: datetime ISO8601, Last update date of the Profile."
+        None, description="type: datetime ISO8601, Last update date of the Profile."
     )
     created_at: str = Field(
-        ..., description="type: datetime ISO8601, Creation date of the Profile."
+        None, description="type: datetime ISO8601, Creation date of the Profile."
     )
     experiences_duration: float = Field(
-        ..., description="Total number of years of experience."
+        None, description="Total number of years of experience."
     )
     educations_duration: float = Field(
-        ..., description="Total number of years of education."
+        None, description="Total number of years of education."
     )
     experiences: t.Optional[t.List[Experience]] = Field(
-        ..., description="List of experiences of the Profile."
+        None, description="List of experiences of the Profile."
     )
     educations: t.Optional[t.List[Education]] = Field(
-        ..., description="List of educations of the Profile."
+        None, description="List of educations of the Profile."
     )
     attachments: t.List[Attachment] = Field(
-        ..., description="List of documents attached to the Profile."
+        None, description="List of documents attached to the Profile."
     )
     skills: t.Optional[t.List[Skill]] = Field(
-        ..., description="List of skills of the Profile."
+        None, description="List of skills of the Profile."
     )
     languages: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of spoken languages of the profile"
+        None, description="List of spoken languages of the profile"
     )
     certifications: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of certifications of the Profile."
+        None, description="List of certifications of the Profile."
     )
     courses: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of courses of the Profile."
+        None, description="List of courses of the Profile."
     )
     tasks: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of tasks of the Profile."
+        None, description="List of tasks of the Profile."
     )
     interests: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of interests of the Profile."
+        None, description="List of interests of the Profile."
     )
     tags: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of tags of the Profile."
+        None, description="List of tags of the Profile."
     )
     metadatas: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of metadatas of the Profile."
+        None, description="List of metadatas of the Profile."
     )
     labels: t.Optional[t.List[GeneralEntitySchema]] = Field(
-        ..., description="List of labels of the Profile."
+        None, description="List of labels of the Profile."
     )