GitHub Public API Limitations

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

Authentication Methods

• /notifications does not support fine-grained personal access tokens tokens Add support for fine-grained personal access token auth #1492
• /notifications does not support GitHub App authorization permissions https://github.com/apps/gitify-experimental

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.
    • When fetching ?all=true, both read and done notifications are returned with the same response shape. There is no indicator to differentiate if the notification thread is read and not done or read and done, which causes challenges with notification hover interaction button logic.
    • Notifications of subject.type CheckSuite, RepositoryInvitation or WorkflowRun always have null
      for subject.url and subject.latest_comment_url
    • Notifications of subject.type Discussion return
      for subject.url / subject.latest_comment_url which doesn't point to the latest comment. We have had to implement a fix to find these ourselves. See refactor: remove discussions html url workaround #1583
  • 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
  • No support for fine-grained tokens Add support for fine-grained personal access token auth #1492

GitHub GraphQL API - Documentation

• No query to fetch user notifications
• No query to find CheckSuite of WorkflowRun information by notification_id
• No query to find Release information by release_id (only by tag)