Security News
OpenJS: “XZ Utils Cyberattack Likely Not an Isolated Incident”
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
@octokit/plugin-enterprise-rest
Advanced tools
Weekly downloads
Readme
Octokit plugin for GitHub Enterprise REST APIs
@octokit/rest
does not include methods for Enterprise Administration as they are not usable against https://api.github.com. This plugin adds these endpoints based on the GitHub Enterprise version you need.
const Octokit = require("@octokit/rest").plugin(
require("@octokit/plugin-enterprise-rest/ghe-2.18")
);
const octokit = new Octokit({
baseUrl: "https://github.acme-inc.com/api/v3"
});
octokit.enterpriseAdmin.promoteOrdinaryUserToSiteAdministrator({
username: "octocat"
});
There can be differences in REST API between api.github.com
and the different GitHub Enterprise versions. Some of the endpoint methods from @octokit/rest
might not work. For these cases you can load the endpoint methods for all scopes for a certain GitHub Enterprise version, not only the .enterprise
scope. This will override existing endpoint methods.
const Octokit = require("@octokit/rest").plugin(
require("@octokit/plugin-enterprise-rest/ghe-2.18/all")
);
const octokit = new Octokit({
baseUrl: "https://github.acme-inc.com/api/v3"
});
octokit.issues.addLabels({
owner,
repo,
number,
labels: ["foo", "bar"]
});
// now sends `["foo", "bar"]` in the request body, instead of `{"labels": ["foo", "bar"]}`
See the README.md
files in the ghe-*
folders for a list of available endpoint methods for the respective GitHub Enterprise version.
The route definitions for the currently supported GitHub Enterprise versions are build automatically from @octokit/routes
. Each time there is a new @octokit/routes
release, Greenkeeper will send a pull request which updates the dependency in package.json
and package-lock.json
. That kicks of a build on Travis CI where the greenkeeper-routes-update
script is run. If there is a change, the script updates the *.json
definition files in the pull request.
FAQs
Octokit plugin for GitHub Enterprise REST APIs
The npm package @octokit/plugin-enterprise-rest receives a total of 896,893 weekly downloads. As such, @octokit/plugin-enterprise-rest popularity was classified as popular.
We found that @octokit/plugin-enterprise-rest demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
Company News
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.
Security News
OSI is starting a conversation aimed at removing the excuse of the SaaS loophole for companies navigating licensing and the complexities of doing business with open source.