supported-platforms.md

icon
support

Supported Platforms

GitHub

Guide: Set up GitHub OAuth App

GitHub REST API V3

• Vssue API package: @vssue/api-github-v3
• Features or drawbacks:
  • clientSecret is required
  • Comments not sortable
  • Comments editable
  • Comments deletable
  • Can view comments without login, but has API rate limitation
• Developer Reference: Official Docs

GitHub GraphQL API V4

• Vssue API package: @vssue/api-github-v4
• Features or drawbacks:
  • clientSecret is required
  • Comments sortable
  • Comments editable
  • Comments deletable
  • Requires login to view comments
• Developer Reference: Official Docs

GitLab

Guide: Set up GitLab Application

Gitlab API V4 (Gitlab v11.0+)

• Vssue API package: @vssue/api-gitlab-v4
• Features or drawbacks:
  • Comments sortable
  • Comments editable
  • Comments deletable
  • Requires login to view comments
• Developer Reference: Official Docs

Bitbucket

Guide: Set up Bitbucket OAuth Consumer

Bitbucket API V2

• Vssue API package: @vssue/api-bitbucket-v2
• Features or drawbacks:
  • Comments sortable
  • Comments editable
  • Comments deletable
  • Can view comments without login
  • Cannot post emoji reactions to comments (heart, like, unlike, etc.)
• Developer Reference: Official Docs

Gitee

Guide: Set up Gitee OAuth Application

Gitee API V5

• Vssue API package: @vssue/api-gitee-v5
• Features or drawbacks:
  • clientSecret is required
  • Comments not sortable
  • Comments editable
  • Comments deletable
  • Can view comments without login
  • Cannot post emoji reactions to comments (heart, like, unlike, etc.)
• Developer Reference: Official Docs