Additional endpoints available for GitHub Apps

  • April 17, 2018
  • Avatar for jch jch

As part of the ongoing audit of the availability of REST API endpoints for GitHub Apps, we've enabled another batch of endpoints. For a complete list of endpoints enabled for GitHub Apps, see "Available endpoints".

Recently enabled endpoints

The newly enabled endpoints available now include:

Organization Members

Teams

Pull Request Review Events

Pull Request Review Requests

Pull Requests

New user-to-server endpoints are available in these APIs:

How can I try it?

To access this functionality, you’ll need to provide the following custom media type in the Accept header:

application/vnd.github.machine-man-preview+json

What about other endpoints?

We're actively working on enabling more endpoints. Check back on the developer blog for updates when new batches become available. If you have specific requests or feedback, come chat with us in the Platform forum.

Self-serve Onboarding for the GitHub Marketplace

After looking through our queue of amazing tools waiting to join the GitHub Marketplace we've decided to simplify the process--and to this end we're giving developers the ability to quickly get an app on the marketplace and onboard themselves.

New and improved guide

We now have a micro-guide that explains everything you need to get setup on the GitHub Marketplace:

What if you've already started

If you're already building a Marketplace app then you may have noticed the changes we've shipped this week. There is a completely new interface that enables you to move at your own pace and walks you through all the steps to go live on the Marketplace.

Feel free to continue building and make sure you have 4 green checkmarks in the left panel before you re-submit. We cannot wait to see what you've been building!

Screenshot

For any other questions, feel free to contact us here.

Preview the Organization Project Permissions API

We're releasing new API endpoints to support the new organization project permissions system. These new endpoints will give you the same granular control over organization projects that you're used to having with organization repositories.

Organization project collaborators

Using the new organization project collaborator API endpoints, you can add, remove, review, and list organization project collaborators. You'll need admin access on a project to use these API endpoints, and they are only available to organization projects.

Organization projects on teams

Just like with repositories, you can add organization projects to teams, remove organization projects from teams, review a team's permission on an organization project, and list all the organization projects for a team. Adding and removing a team project requires admin access to that project, and these new endpoints are only available to organization projects.

New "Update project" parameters

The Update project endpoint has two new parameters: organization_permission and private. You'll need admin access on a project to make changes to these parameters, and they only apply to organization projects.

Preview period

To access these new and updated endpoints during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

During the preview period, we may change aspects of these API methods based on developer feedback. If we do, we will announce the changes here on the developer blog, but we will not provide any advance notice.

If you have any questions or feedback, please let us know!

Preview the new Hovercard API

We're releasing a Hovercard API that enables you to retrieve information contained in someone's hovercard using either GraphQL or REST. Use the subject_type and subject_id parameters to find out more about someone in relation to their pull requests, issues, repositories, and organizations.

REST API

To access the new Get contextual information about a user endpoint during the preview period, you must provide a custom media type in the Accept header:

   application/vnd.github.hagar-preview+json

GraphQL API

We're introducing a new connection on User called hovercard which enables you to retrieve data contained in someone's hovercard.

To access this new API during the preview period, you must provide an Accept header as well:

   application/vnd.github.hagar-preview

During the preview period, we may change aspects of these APIs based on developer feedback. If we do, we will announce the changes here on the developer blog, but we will not provide any advance notice.

If you have any questions or feedback, please let us know!

Introducing new ways to build on your workflow

Whether you’re a team of 2 or 20,000, there's an app to simplify your work on GitHub Marketplace. Last week, we launched 2 new apps in the Marketplace that will make it easier to automate dependency updates and review code.

Code review

CodeFactor is a simple to use, automated Code Review service built by developers for developers. Setup with GitHub in seconds, to save time on code reviews and easily create issues directly from CodeFactor. Streamline your code review process and create actionable reports.

Dependency Management

Renovate brings automatic Javascript dependency updates to your workflow and supports npm, Yarn, Meteor, Docker or Bazel. It comes ready to go with a smart default configuration but provides a flexible configuration framework including scheduling and rules-based auto-merging to guide the updates you want to see in your repositories.

Ready to try out these new additions? See how they can help your team work better or discover even more tools in GitHub Marketplace.

GitHub Apps and Reactions for Team Discussions

Today we added new endpoints to the Reactions API preview that allow you to interact with reactions to team discussions and their comments. You can access these endpoints during the preview period by providing custom media types in the Accept header:

application/vnd.github.squirrel-girl-preview+json, application/vnd.github.echo-preview+json

Over the course of the preview period we may change aspects of the API based on developer feedback. If we do, we will not provide any advance notice of the changes, but we will announce them here on the developer blog.

New REST API endpoints

We've also enabled GitHub Apps for all endpoints related to team discussions. The endpoints listed below are available for both server-to-server and user-to-server requests.

Recently enabled REST API endpoints for GitHub Apps

We hope these changes help you build better integrations! If you have any questions or feedback, please let us know.

Require Multiple Approving Reviews for Protected Branches

The Protected Branches API now has a setting for requiring up to 6 approving pull request reviews. You can manage and view this setting from four endpoints:

How can I try it?

To access this functionality during the preview period, you’ll need to provide the following custom media type in the Accept header:

application/vnd.github.luke-cage-preview+json

Take a look at the docs here. If you have any questions, please get in touch.

Preview the new Team Discussions GraphQL API

We added new objects and mutations to our GraphQL API that allow you to read and manage team discussions. Team discussions is the first GraphQL feature to use a preview period. GraphQL previews work the same way as they do with our REST API. As always, if you want to find out about upcoming GraphQL schema changes, follow the GraphQL Changelog which now includes preview periods as well.

You can access the new objects and mutations during the preview period by providing a custom media type in the Accept header:

application/vnd.github.echo-preview+json

New GraphQL objects

New GraphQL fields

New GraphQL mutations

During the preview period, we may change aspects of the API based on developer feedback. If we do, we will not provide any advance notice of the changes, but we will announce them here on the developer blog.

We are really excited to see what integrations you develop around this API! If you have any questions or feedback, please let us know.

Label API improvements: emoji, descriptions, and search

We're happy to announce a new preview period for the Labels API. You can now use emoji in label names, add label descriptions, and search labels in a repository.

To access these features during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.symmetra-preview+json

During the preview period, we may change aspects of these API methods based on your feedback. If we do, we'll announce the changes here on the developer blog, but we won't provide advance notice.

If you have any questions or feedback, please contact us.

New endpoints

Updated endpoints

Preview required commit signatures for Protected Branches API

Protected Branches API now has a setting for requiring signed commits. We're adding three new endpoints for managing this setting. You can learn more about commit signing here.

New endpoints

How can I try it?

To access this functionality during the preview period, you’ll need to provide the following custom media type in the Accept header:

application/vnd.github.zzzax-preview+json

Take a look at the docs here. If you have any questions, please get in touch.