Skip to content
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

Improve API spec #631

Merged
merged 6 commits into from
Nov 2, 2023
Merged

Improve API spec #631

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1e148ca
(API Spec): Specify nullability View component based on View.php & Vi…
Oct 22, 2023
cd63937
(API Spec): Improve Row component based on Row.php & RowService.php
Oct 22, 2023
e49b845
(API Spec): Improve Column component based on Column.php & ColumnServ…
Oct 22, 2023
565752a
(API Spec): Misc improvements
Oct 22, 2023
f87e132
(API Spec): Add missing properties to Table component
Oct 22, 2023
787e274
(API Spec): Use number range instead of decimal character class becau…
Oct 22, 2023
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
82 changes: 79 additions & 3 deletions APIv1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -993,8 +993,10 @@ components:
format: int64
title:
type: string
nullable: false
emoji:
type: string
nullable: true
ownership:
type: string
ownerDisplayName:
Expand All @@ -1003,12 +1005,22 @@ components:
type: string
createdAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
lastEditBy:
type: string
lastEditAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
isShared:
type: boolean
nullable: false
description: "Whether the table is shared with the requesting user"
hasShares:
type: boolean
nullable: false
description: "Whether the table is shared with ANY user"
onSharePermissions:
type: object
properties:
Expand All @@ -1024,6 +1036,12 @@ components:
type: boolean
rowsCount:
type: integer
nullable: false
columnsCount:
type: integer
nullable: false
views:
type: array
Shares:
type: array
maxItems: 1000
Expand All @@ -1038,35 +1056,47 @@ components:
properties:
id:
type: integer
nullable: false
nodeId:
type: integer
nullable: false
nodeType:
type: string
nullable: false
permissionRead:
type: boolean
nullable: false
permissionCreate:
type: boolean
nullable: false
permissionUpdate:
type: boolean
nullable: false
permissionDelete:
type: boolean
nullable: false
permissionManage:
type: boolean
nullable: false
sender:
type: string
receiver:
type: string
nullable: false
receiverDisplayName:
type: string
receiverType:
type: string
items:
- user
- group
nullable: false
pattern: "^(user)|(group)$"
createdAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
lastEditAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
Columns:
type: array
maxItems: 1000
Expand All @@ -1083,26 +1113,40 @@ components:
properties:
id:
type: integer
nullable: false
title:
type: string
nullable: false
tableId:
type: integer
nullable: false
createdBy:
type: string
createdAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
lastEditBy:
type: string
lastEditAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
type:
type: string
nullable: false
subtype:
type: string
nullable: false
description: "subtype or an empty string"
mandatory:
type: boolean
nullable: false
description:
type: string
orderWeight:
type: integer
description: "Deprecated"
numberDefault:
type: number
numberMin:
Expand All @@ -1113,8 +1157,12 @@ components:
type: integer
numberPrefix:
type: string
nullable: false
description: "prefix or an empty string"
numberSuffix:
type: string
nullable: false
description: "suffix or an empty string"
textDefault:
type: string
textAllowedPattern:
Expand All @@ -1123,6 +1171,7 @@ components:
type: integer
selectionOptions:
type: string
nullable: false
selectionDefault:
type: integer
datetimeDefault:
Expand All @@ -1142,20 +1191,33 @@ components:
properties:
id:
type: integer
nullable: false
title:
type: string
nullable: false
tableId:
type: integer
nullable: false
createdBy:
type: string
nullable: true
createdAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
lastEditBy:
type: string
nullable: true
lastEditAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
description:
type: string
nullable: false
emoji:
type: string
nullable: true
columns:
type: array
items:
Expand All @@ -1179,8 +1241,10 @@ components:
type: boolean
hasShares:
type: boolean
nullable: false
rowsCount:
type: integer
nullable: false
ownerDisplayName:
type: string
filter:
Expand Down Expand Up @@ -1237,21 +1301,33 @@ components:
Row:
type: object
description: Object with row metadata. The values are inside of the property 'data'.
required:
- id
- tableId
properties:
id:
type: integer
nullable: false
tableId:
type: integer
nullable: false
createdBy:
type: string
nullable: false
createdAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
lastEditBy:
type: string
nullable: false
lastEditAt:
type: string
nullable: false
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
data:
type: array
nullable: false
items:
type: object
properties:
Expand Down