GitHub

• Integration to the GitHub Rest API using OAuthApp Authorization.
• Node samples are obtained by parsing the GitHub Rest API OpenAPI documentation.

Revision History

1.0.0.0 Initial Release

Properties

Connection

Type: Connection Input

ApplicationName
Type: String
The name you give the OAuthApp when you create it in GitHub's Developer Settings.

ClientId
Type: String
Generated when you create the OAuthApp in GitHub's Developer Settings.

ClientSecret
Type: Password
Generated when you create the OAuthApp in GitHub's Developer Settings.

Token
Type: Password
The OAuth token created and captured when you click Connect your account.

OperationId

Type: String
A unique internal identifier for the chosen GitHub operation, which is automatically assigned when selecting a sample.

Description

Type: String
A brief overview of the selected sample. Hovering over it reveals additional details about the operation.

Request

Type: JSON Input
The JSON payload for the request body, applicable to create or update operations. Specify the data to be submitted to GitHub in this section.

Response

Type: JSON Output
The JSON payload received in the response from GitHub, including the data produced by the executed operation.

Custom Properties

Type: Custom Properties Input
Samples can include predefined Custom Properties that are injected automatically. Provide only the required values for these properties.

Setup

Step 1: Create an OAuth App in your GitHub Profile (If you don't already have one)

• Once you are logged in, click on your profile picture in the top right and then click Settings
• On the left pane, right at the bottom, click on Developer settings
• On the left pane again, click on OAuth Apps, then choose New OAuth App
  • On this new screen, you will have to put in some information
  • Application name: Save this name as we will need it later for the Flowgear Node Connection properties. This is generally the name of your App that will use the connector.
  • Homepage URL: This is required by GitHub, if you don't have one yet, you can use https://www.google.com. This can be changed afterwards.
  • Application description: Optional
  • Authorization callback URL: This is required to complete the OAuth Authorization. You must enter https://app.flowgear.net for the Authorization to work.
  • Enable Device Flow: Selectable checkbox, leave this off.
  • Now click Register application
• Here is a GitHub guide if you encounter any issues.

Step 2: Generate Credentials for the OAuth App

• If you have just created an App, you will already be on the General tab.

• If you already have an OAuth App, navigate to the app in your Developer settings and click on the General tab in the left pane.

• Look for the Client ID section, save this Client ID as we will need it later for the Flowgear Node Connection properties.

• Click on Generate a new client secret

  • After your profile authorization a Client secret will be displayed. Save this as we will need it later for the Flowgear Node Connection properties.
  • NOTE: This is the only time this Client secret will be displayed. If you do not save it or it is lost, you will have to generate a new one.

• We are now finished in GitHub and have the following details:

  • Application name
  • Client ID
  • Client secret

• These credentials will be used in the Flowgear Connection profile. Remember to Connect your account in the Connections details page.

See Also

• GitHub