Following the migration of our GitHub services from the gh CLI to a direct GraphQL implementation, the data models returned by our services have become significantly richer. For example, the SyncService now provides detailed issue relationship data (parent, sub-issues) that is not reflected in the current openapi.yaml specification.
An outdated API specification is misleading for both human developers and AI agents attempting to use the tools. This ticket is to perform a thorough review of the current service responses and update the OpenAPI schemas to match the new, richer data structures.
Acceptance Criteria
- Analyze the response schema of the
sync_issues operation (SyncIssuesResponse) and update it to include the new parent/sub-issue fields and any other new data points returned by the SyncService.
- Analyze the response schema of the
get_conversation operation (PullRequestConversation) and ensure it accurately reflects the data returned by the PullRequestService.
- Review all other relevant schemas in
openapi.yaml (e.g., PullRequest, Label) to ensure they are aligned with the data now being returned by the GraphQL-backed services.
- Ensure all examples in the OpenAPI specification are updated to reflect the new data structures.
Following the migration of our GitHub services from the
ghCLI to a direct GraphQL implementation, the data models returned by our services have become significantly richer. For example, theSyncServicenow provides detailed issue relationship data (parent, sub-issues) that is not reflected in the currentopenapi.yamlspecification.An outdated API specification is misleading for both human developers and AI agents attempting to use the tools. This ticket is to perform a thorough review of the current service responses and update the OpenAPI schemas to match the new, richer data structures.
Acceptance Criteria
sync_issuesoperation (SyncIssuesResponse) and update it to include the new parent/sub-issue fields and any other new data points returned by theSyncService.get_conversationoperation (PullRequestConversation) and ensure it accurately reflects the data returned by thePullRequestService.openapi.yaml(e.g.,PullRequest,Label) to ensure they are aligned with the data now being returned by the GraphQL-backed services.