-
Notifications
You must be signed in to change notification settings - Fork 0
Connector function index
ronan edited this page Aug 10, 2021
·
1 revision
The below operations have been implemented as individual functions in the Linx sample.
The index is organized according to the GitHub REST API reference which matches that of the Linx Solution. For more information about the specific organizing of functions and the general Solution Explorer structure, take a look at the wiki page.
The table contains the name of the request/function in readable format with a link to the GitHub REST API reference page for each request.
If there are specific GitHub API operations that you would like to see implemented in the sample, contact [email protected].
The GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of the app.
| Operation | Description |
|---|---|
| OAuth Apps | You can use this API to manage the OAuth tokens an OAuth application uses to access people's GitHub accounts. |
| Check a token | Retrieve details of the current access token. |
| Delete an app authorization | OAuth application owners can revoke a grant for their OAuth application and a specific user. |
| Reset a token | OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. |
You can use the Codes of Conduct API to retrieve information about a repository's code of conduct.
| Operation | Description |
|---|---|
| Get all codes of conduct | Get all codes of conducts. |
| Get a code of conduct | Retrieves the details of a CoC for a key i.e. "citizen_code_of_conduct". |
| Get the code of conduct for a repository | Returns the contents of the repository's code of conduct file, if one is detected. |
| Operation | Description |
|---|---|
| Get emojis | Lists all the emojis available to use on GitHub. |
The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file.
| Operation | Description |
|---|---|
| Get all commonly used licenses | Get commonly used licenses across GitHub. |
| Get a license | Gets the details of a license for a key i.e. "mit". |
| Get the license for a repository | This method returns the contents of the repository's license file, if one is detected. |
The Markdown API enables you to render a markdown document as an HTML page or as raw text.
| Operation | Description |
|---|---|
| Render a Markdown document | Render mardown text as HTML. |
| Render a Markdown document in raw mode | Render raw text as HTML. |
The Meta API returns meta information about GitHub including the IP addresses of GitHub services.
| Operation | Description |
|---|---|
| GitHub API Root | Get Hypermedia links to resources accessible in GitHub's REST API. |
| Get GitHub meta information | Returns meta information about GitHub, including a list of GitHub's IP addresses. |
| Get Octocat | Get the octocat as ASCII art. |
| Get the Zen of GitHub | Get a random sentence from the Zen of GitHub. |
The Organizations API gives you access to control and manage all your GitHub organizations.
| Operation | Description |
|---|---|
| Orgs | |
| List organizations | Lists all organizations, in the order that they were created on GitHub. |
| Get an organization | Get the details of a specified GitHub org. |
| List app installations for an organization | Lists all GitHub Apps in an organization. |
| List organizations for the authenticated user | List organizations for the authenticated user. |
| List organizations for a user | List public organization memberships for the specified user. |
| Members | |
| Create an organization invitation | Invite people to an organization by using their GitHub user ID or their email address. |
| List organization members | List all users who are members of an organization. |
The Projects API lets you to create, list, update, delete and customize projects in a repository.
| Operation | Description |
|---|---|
| Projects | |
| List organization projects | Lists the projects in an organization. |
| Get a project | Gets a project by its id. |
| Update a project | Updates a project board's information. |
| Delete a project | Deletes a project board. |
| List repository projects | Lists the projects in a repository. |
| Create a repository project | Creates a repository project board. |
| Create a user project | Create a project board for a user. |
| List user projects | List a user's project boards. |
| Cards | |
| Get a project card | Gets the details of card in a project column. |
| Update an existing project card | Updates the details of card in a project column. |
| Delete a project card | Removes a card from a project. |
| Move a project card | Moves a card to a differnt column in the project. |
| List project cards | Lists all the cards in a project column. |
| Create a project card | Creates a new card in a project. |
| Collaborators | |
| List project collaborators | Lists the collaborators for an organization project. |
| Add project collaborator | Adds a collaborator to an organization project and sets their permission level. |
| Remove user as a collaborator | Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator. |
| Get project permission for a user | Returns the collaborator's permission level for an organization project. |
| Columns | |
| Get a project column | Returns the details of a project column. |
| Update an existing project column | Updates an existing project column. |
| Delete a project column | Removes the specified column from the project. |
| Move a project column | Moves a column into a new position in the project. |
| List project columns | Lists all the columns in a project. |
| Create a project column | Creates a new column in a project. |
With the Rate Limit API, you can check the current rate limit status of various REST APIs.
| Operation | Description |
|---|---|
| Get rate limit status for the authenticated user | Get the current API request limit for the authenticated user. |
The Repos API allows you to create, manage and control the workflow of public and private GitHub respositories.
| Operation | Description |
|---|---|
| Repos | |
| List organization repositories | Lists repositories for the specified organization. |
| Create an organization repository | Creates a new repository in the specified organization. The authenticated user must be a member of the organization. |
| Get a repository | Get the details of repository. |
| Update a repository | Update the details of repository. |
| Delete a repository | Deletes a repository. |
| List repository contributors | Lists contributors to the specified repository. |
| Create a repository using a template | Creates a new repository using a repository template. |
| List public repositories | Lists all public repositories in the order that they were created since a given ID. |
| List repositories for the authenticated user | Lists repositories that the authenticated user has explicit permission to access. |
| Create a repository for the authenticated user | Creates a new repository for the authenticated user. |
| List repositories for a user | Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. |
| Commits | The Repo Commits API supports listing, viewing, and comparing commits in a repository. |
| List commits | List the 'commit' activity for a repository. |
| Get a commit | Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint. |
| Community | |
| Get community profile metrics | Return all community profile metrics for a repo. |
| Contents | These API endpoints let you create, modify, and delete Base64 encoded content in a repository. To request the raw format or rendered HTML (when supported), use custom media types for repository contents. |
| Get repository content | Gets the contents of a file or directory in a repository. |
| Get a repository README | Gets the preferred README file details for a repository. |
| Download a repository archive (zip) | Download repository contents and write them to a local archive (.zip). |
| Statistics | The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity. |
| Get the weekly commit activity | Returns a weekly aggregate of the number of additions and deletions pushed to a repository. |
| Traffic | The Traffic API provides access to the information provided in your repository graph. |
| Get repository clones | Get the total number of clones and breakdown per day or week for the last 14 days. |
| Get top referral paths | Get the top 10 popular contents over the last 14 days. |
| Get top referral sources | Get the top 10 referrers over the last 14 days. |
| Get page views | Get the total number of views and breakdown per day or week for the last 14 days. |
The Users API allows you to get public and private information about the authenticated user.
| Operation | Description |
|---|---|
| Users | |
| Get the authenticated user | Returns the public and private profile information of the authenticated user. |