Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub Public API Limitiation Registry #890

Open
setchy opened this issue Mar 17, 2024 · 0 comments
Open

GitHub Public API Limitiation Registry #890

setchy opened this issue Mar 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation github-api-limitation Limitation in data available from GitHub APIs

Comments

@setchy
Copy link
Member

setchy commented Mar 17, 2024

GitHub Public API Limitations

This issue collates all of the feature gaps within the public GitHub REST API and GitHub GraphQL API

Note

See GitHub API Changelog for new feature announcements

Important

Filter issues by github-api-limitation to see full backlog

GitHub REST API - Documentation

  • List Notifications endpoint /notifications
    • Filtering capabilities
      • No query parameter to filter notifications by inbox
      • No query parameter to filter notifications by saved
      • No query parameter to filter notifications by done
    • Response schema
      • No attribute in response indicating if a notification is done, saved or in the inbox.
      • Notifications of subject.type Discussion, CheckSuite, RepositoryInvitation or WorkflowRun always have null
        for subject.url and subject.latest_comment_url
    • Private repositories Notifications show in UI but not via this API
  • Notification
    • No endpoint to mark notification as unread (can only mark a notification as read)
    • No endpoint to find CheckSuite of WorkflowRun information by notification_id
    • No endpoint to save/unsave a notification
  • Authentication

GitHub GraphQL API - Documentation

  • No query to fetch user notifications
  • No query to find CheckSuite of WorkflowRun information by notification_id
@setchy setchy added the github-api-limitation Limitation in data available from GitHub APIs label Mar 17, 2024
@setchy setchy pinned this issue Mar 17, 2024
@setchy setchy changed the title GitHub API Limitiation Registry GitHub Public API Limitiation Registry Apr 3, 2024
@setchy setchy added the documentation Improvements or additions to documentation label Jun 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation github-api-limitation Limitation in data available from GitHub APIs
Projects
None yet
Development

No branches or pull requests

1 participant