ITADN

Missing Schema $refs for paginated object arrays in API specs

#973Openchaitanyamedidar 创建于 2026-06-27
kind/bug
### Current Behavior <!-- A brief description of the issue. --> Several endpoints in the REST API documentation (defined in `meshery/schemas`) that return arrays of objects are missing their `$ref` pointers. Instead of referencing the concrete schema model, the `items` property is left as a generic `type: object`. This causes the generated OpenAPI documentation and client SDKs to lack visibility into the actual returned data structures. Specifically, the following high-priority locations are missing `$ref`s: 1. `EnvironmentConnectionsPage.properties.connections` 2. `MeshModelModelsPage.properties.models` 3. `User.properties.teams.properties.teams_with_roles` 4. `User.properties.organizations.properties.organizations_with_roles` 5. `ResourceAccessActorsResponse.properties.users` 6. `ChildNode.properties.children` in Academy ### Expected Behavior The `items` array for these properties should explicitly use a `$ref` to point to the canonical OpenAPI component so the documentation accurately reflects the return types. ### Screenshots/Logs <!-- Add screenshots, if applicable, to help explain your problem. --> ### Environment - **Host OS:** Mac Linux Windows - **Platform:** Docker or Kubernetes - **Meshery Server Version:** stable-v - **Meshery Client Version:** stable-v <!-- Optional ### To Reproduce 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error --> --- ### Contributor [Guides](https://docs.meshery.io/project/contributing) and [Handbook](https://meshery.io/community/handbook) - 🛠 [Meshery Build & Release Strategy](https://docs.meshery.io/project/contributing/build-and-release) - 📚 [Instructions for contributing to documentation](https://github.com/meshery/meshery/blob/master/CONTRIBUTING.md#documentation-contribution-flow) - Meshery documentation [site](https://docs.meshery.io/) and [source](https://github.com/meshery/meshery/tree/master/docs) - 🎨 Wireframes and [designs for Meshery UI](https://www.figma.com/file/SMP3zxOjZztdOLtgN4dS2W/Meshery-UI) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/GvB8SudhEOoq3JOvoLaoMs) - 🙋🏾🙋🏼 Questions: [Discussion Forum](http://discuss.meshery.io) and [Community Slack](https://slack.meshery.io)
1 条评论