docs(openapi): clarify internal files response items#13988
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates the OpenAPI schema for the 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Update the OpenAPI schema for
GET /internal/files/{directory_type}so each array item documents the suffix that the route already returns, for exampleexample.png [output].api_server/routes/internal/internal_routes.pyformats every visible file as:f"{entry.name} [{directory_type}]"The previous schema only said
array<string>, which made generated clients miss the directory-type suffix contract.Validation
python3 - <<'PY' ... yaml.safe_load(open('openapi.yaml')) ... PYgit diff --check