Skip to content

Allow None along with UNDEFINED for optional fields #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thenav56 merged 5 commits into from
Aug 3, 2025
Merged

Allow None along with UNDEFINED for optional fields #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f6728c9
refactor: use typesync-cli from tc fork
tnagorra Aug 1, 2025
4e3f6ea
chore: re-generate pydantic models
tnagorra Aug 1, 2025
e73466f
chore: add typescript dependency
tnagorra Aug 2, 2025
0151b38
feat: define deprecated fields in schema
tnagorra Aug 2, 2025
7ce6e67
chore: update yaml schema for definitions
tnagorra Aug 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions functions/definition/announcement.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbAnnouncement:
model: alias
# path: v2/announcement
Expand Down
6 changes: 3 additions & 3 deletions functions/definition/models.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# yaml-language-server: $schema=https://schema.typesync.org/v0.13.json
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

# ENUM

Expand Down Expand Up @@ -150,8 +150,8 @@ FbObjRasterTileServer:
apiKey:
optional: true
type: string
# NOTE: @deprecated
wmtsLayerName:
deprecated: true
optional: true
type: string
credits:
Expand Down Expand Up @@ -271,9 +271,9 @@ FbProjectUpdateInput:
type: string
projectTopic:
type: string
# TODO: We can remove this @deprecated
projectTopicKey:
type: string
deprecated: true
# NOTE: Name of the organisation
requestingOrganisation:
type: string
Expand Down
5 changes: 4 additions & 1 deletion functions/definition/organisation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbOrganisation:
model: alias
# path: organisations/{organisation_id}
Expand All @@ -10,8 +12,9 @@ FbOrganisation:
description:
optional: true
type: string
nameKey: # NOTE: this is deprecated
nameKey:
type: string
deprecated: true
abbreviation:
optional: true
type: string
Expand Down
2 changes: 2 additions & 0 deletions functions/definition/team.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbTeam:
model: alias
# path: teams/{teamId}
Expand Down
11 changes: 8 additions & 3 deletions functions/definition/tutorial/common.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbEnumInformationPageBlockType:
model: alias
type:
Expand Down Expand Up @@ -68,13 +70,14 @@ FbBaseTutorial:
type:
type: object
fields:
# deprecated
exampleImage1:
type: string
optional: true
deprecated: true
exampleImage2:
type: string
optional: true
deprecated: true
contributorCount: # NOTE: intially zero
type: int
informationPages:
Expand All @@ -91,14 +94,16 @@ FbBaseTutorial:
type: string
projectId:
type: string
projectTopicKey: # NOTE: deprecated
projectTopicKey:
type: string
deprecated: true
status:
type:
type: literal
value: tutorial
tutorialDraftId: # NOTE: deprecated
tutorialDraftId:
type: string
deprecated: true

FbBaseTutorialGroup:
model: alias
Expand Down
2 changes: 2 additions & 0 deletions functions/definition/tutorial/compare.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbCompareTutorial:
model: alias
type:
Expand Down
2 changes: 2 additions & 0 deletions functions/definition/tutorial/completeness.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbCompletenessTutorial:
model: alias
type:
Expand Down
2 changes: 2 additions & 0 deletions functions/definition/tutorial/find.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbFindTutorial:
model: alias
type:
Expand Down
2 changes: 2 additions & 0 deletions functions/definition/tutorial/validate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbValidateTutorial:
model: alias
type:
Expand Down
6 changes: 4 additions & 2 deletions functions/definition/user.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbUserReadonlyType:
model: alias
docs: Represents user fields that cannot be updated from backend
Expand All @@ -8,14 +10,14 @@ FbUserReadonlyType:
type: timestamp
userName:
type: string
# NOTE: We can remove this @deprecated
userNameKey:
type: string
deprecated: true
username:
type: string
# NOTE: We can remove this @deprecated
usernameKey:
type: string
deprecated: true
accessibility:
optional: true
type: boolean
Expand Down
2 changes: 2 additions & 0 deletions functions/definition/userContribution.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbUserContribution:
model: alias
# path: userContributions/{userId}/{projectId}/{groupId}
Expand Down
5 changes: 3 additions & 2 deletions functions/definition/userGroup.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

FbUserGroup:
model: alias
# path: userGroups/{userGroupId}
docs: Represents a usergroup
type:
type: object
fields:
# TODO: this is an enum
createdAt:
type: int
createdBy:
Expand All @@ -14,9 +15,9 @@ FbUserGroup:
type: string
name:
type: string
# NOTE: We can remove this @deprecated
nameKey:
type: string
deprecated: true
users:
type:
type: map
Expand Down
2 changes: 2 additions & 0 deletions functions/definition/wait.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# yaml-language-server: $schema=https://raw.githubusercontent.com/toggle-corp/typesync/refs/tags/v1.0.0/schema.local.json

# NOTE: We need at least one model with type document
FbBackendWait:
model: document
Expand Down
Loading