Skip to content

Commit 00d1fcf

Browse files
christophdbclaude
andcommitted
Fix all quality validation issues and enable strict mode
- Add missing parameter descriptions (days, org_ids, has_handled, external_link_token, view_external_link_token, invite_link_token, q) - Add missing endpoint descriptions (4 custom folder endpoints) - Add missing response content (unarchive, admin export, org-basic-info) - Enable --strict mode in workflow quality check Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 54480f4 commit 00d1fcf

6 files changed

Lines changed: 32 additions & 1 deletion

.github/workflows/rdme-openapi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ jobs:
7373
- name: Check documentation quality
7474
run: |
7575
pip install pyyaml -q
76-
python3 tests/validate_specs.py
76+
python3 tests/validate_specs.py --strict
7777
7878
- name: Update SeaTable API docs
7979
uses: readmeio/rdme@v9

base_operations.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@ components:
176176
example: 0
177177
days:
178178
name: days
179+
description: Number of days to look back for comments.
179180
in: query
180181
schema:
181182
type: integer
@@ -3953,6 +3954,13 @@ paths:
39533954
responses:
39543955
"200":
39553956
description: OK
3957+
content:
3958+
application/json:
3959+
schema:
3960+
type: object
3961+
example:
3962+
success: true
3963+
task_id: cdb7fcc6-d2fa-4bf7-ae08-0d767c38690c
39563964
/api-gateway/api/v2/dtables/{base_uuid}/db-operations/:
39573965
get:
39583966
tags: [Big Data]

file_operations.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,7 @@ paths:
301301
tags: [Files & Images (Custom Folder)]
302302
summary: Get Files from Folder
303303
operationId: getCustomFiles
304+
description: List files and subdirectories in a custom folder of a base.
304305
security:
305306
- ApiTokenAuth: []
306307
parameters:
@@ -324,6 +325,7 @@ paths:
324325
tags: [Files & Images (Custom Folder)]
325326
summary: Get File Metadata
326327
operationId: getCustomFileMetadata
328+
description: Get metadata (name, size, last update) of a file in a custom folder.
327329
security:
328330
- ApiTokenAuth: []
329331
parameters:
@@ -368,6 +370,7 @@ paths:
368370
tags: [Files & Images (Custom Folder)]
369371
summary: Get Upload Link
370372
operationId: getCustomUploadLink
373+
description: Get a temporary upload link for uploading files to a custom folder.
371374
security:
372375
- ApiTokenAuth: []
373376
parameters:
@@ -390,6 +393,7 @@ paths:
390393
tags: [Files & Images (Custom Folder)]
391394
summary: Get Download Link
392395
operationId: getCustomDownloadLink
396+
description: Get a temporary download link for a file in a custom folder.
393397
security:
394398
- ApiTokenAuth: []
395399
parameters:

system_admin_account_operations.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1996,6 +1996,7 @@ paths:
19961996
parameters:
19971997
- name: org_ids
19981998
in: query
1999+
description: Comma-separated list of organization IDs to look up.
19992000
schema:
20002001
type: array
20012002
items:
@@ -2004,6 +2005,14 @@ paths:
20042005
responses:
20052006
"200":
20062007
description: OK
2008+
content:
2009+
application/json:
2010+
schema:
2011+
type: object
2012+
example:
2013+
organization_list:
2014+
- org_id: 1
2015+
org_name: "My Team"
20072016
/api/v2.1/admin/organizations/{org_id}/:
20082017
put:
20092018
tags:
@@ -2367,6 +2376,9 @@ paths:
23672376
responses:
23682377
"200":
23692378
description: OK
2379+
content:
2380+
# Actually application/x-zip-compressed, but dtable-web does not accept this in Accept header
2381+
application/json: {}
23702382

23712383
# Common Dataset
23722384
/api/v2.1/admin/common-datasets/:
@@ -3568,6 +3580,7 @@ paths:
35683580
- $ref: "#/components/parameters/per_page"
35693581
- in: query
35703582
name: has_handled
3583+
description: Filter by handling status. Use `true` for handled, `false` for unhandled, or `null` for all.
35713584
schema:
35723585
type: string
35733586
enum: [true, false, null]

team_admin_account_operations.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,20 +170,23 @@ components:
170170
example: 5c264e76-0e5a-448a-9f34-580b551364ca
171171
external_link_token:
172172
name: external_link_token
173+
description: The token of the external link.
173174
in: path
174175
schema:
175176
type: string
176177
required: true
177178
example: "d6d006b319ca4d2aa060"
178179
view_external_link_token:
179180
name: view_external_link_token
181+
description: The token of the view external link.
180182
in: path
181183
schema:
182184
type: string
183185
required: true
184186
example: "d6d006b319ca4d2aa060"
185187
invite_link_token:
186188
name: invite_link_token
189+
description: The token of the invite link.
187190
in: path
188191
schema:
189192
type: string

user_account_operations.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2485,6 +2485,7 @@ paths:
24852485
parameters:
24862486
- name: q
24872487
in: query
2488+
description: Search query string. Matches against email, name, or contact email.
24882489
schema:
24892490
type: string
24902491
example: Micha
@@ -3415,6 +3416,7 @@ paths:
34153416
parameters:
34163417
- name: q
34173418
in: query
3419+
description: Search query string. Matches against group name.
34183420
schema:
34193421
type: string
34203422
example: Micha
@@ -3558,6 +3560,7 @@ paths:
35583560
parameters:
35593561
- name: q
35603562
in: query
3563+
description: Search query string. Matches against member name or email.
35613564
schema:
35623565
type: string
35633566
example: Micha

0 commit comments

Comments
 (0)