Browse Source

fix: align onboarding OpenAPI examples and defaults

backup/master-local-20261012
pwklppg 1 month ago
parent
commit
310d931207
  1. 7
      docs/openapi-rc.json
  2. 12
      docs/verify_openapi.py

7
docs/openapi-rc.json

@ -7435,7 +7435,8 @@
"culture": "以用户价值为中心,保持透明和长期主义。", "culture": "以用户价值为中心,保持透明和长期主义。",
"workPolicies": "弹性上班;每周一、三线下办公。", "workPolicies": "弹性上班;每周一、三线下办公。",
"onboardingGuide": "报到当天携带身份证件,联系行政同事完成入职登记。", "onboardingGuide": "报到当天携带身份证件,联系行政同事完成入职登记。",
"updatedAt": "2026-09-17T01:33:00Z" "updatedAt": "2026-09-17T01:33:00Z",
"version": 2
}, },
"requestId": "req-company-knowledge", "requestId": "req-company-knowledge",
"timestamp": "2026-09-17T01:33:00Z" "timestamp": "2026-09-17T01:33:00Z"
@ -11714,11 +11715,13 @@
"sortOrder": { "sortOrder": {
"type": "integer", "type": "integer",
"format": "int32", "format": "int32",
"default": 1000,
"maximum": 9999, "maximum": 9999,
"minimum": 0 "minimum": 0
}, },
"required": { "required": {
"type": "boolean" "type": "boolean",
"default": false
}, },
"idempotencyKey": { "idempotencyKey": {
"type": "string", "type": "string",

12
docs/verify_openapi.py

@ -297,6 +297,18 @@ for schema_name, expected_fields in onboarding_schema_fields.items():
f'Onboarding schema fields missing: {schema_name}' f'Onboarding schema fields missing: {schema_name}'
) )
create_request = schemas['CompanyChecklistItemCreateRequest']['properties']
assert create_request['sortOrder'].get('default') == 1000, (
'CompanyChecklistItemCreateRequest.sortOrder default must be 1000'
)
assert create_request['required'].get('default') is False, (
'CompanyChecklistItemCreateRequest.required default must be false'
)
knowledge_success_example = paths['/onboarding/company/knowledge']['put']['responses']['200']['content']['*/*']['example']
assert knowledge_success_example['data'].get('version') == 2, (
'PUT /onboarding/company/knowledge 200 example data.version must be 2'
)
onboarding_error_paths = { onboarding_error_paths = {
9701: ('/onboarding/company/checklist-items/{itemId}', 'put', '404'), 9701: ('/onboarding/company/checklist-items/{itemId}', 'put', '404'),
9702: ('/onboarding/company/checklist-items/{itemId}', 'put', '409'), 9702: ('/onboarding/company/checklist-items/{itemId}', 'put', '409'),

Loading…
Cancel
Save