17.3.1 • Published 9 months ago

@octokit/plugin-enterprise-server v17.3.1

Weekly downloads
1,524
License
MIT
Repository
github
Last release
9 months ago

plugin-enterprise-server.js

Octokit plugin for GitHub Enterprise Server REST APIs

@latest Build Status

@octokit/rest and the @octokit/plugin-rest-endpoint-methods plugin it's using internally do not include methods for Enterprise Administration as they do not exist on https://api.github.com. This plugin adds endpoint methods for every GitHub Enterprise Server version that is currently supported.

Besides the admin-specific endpoints, there are differences between api.github.com and each GitHub Enterprise Server version. Instead of loading @octokit/plugin-rest-endpoint-methods you can optionally add all endpoint methods for each GitHub Enterprise Server version, including the admin endpoints.

Usage

Load @octokit/plugin-enterprise-server and @octokit/core (or core-compatible module) directly from esm.sh

<script type="module">
  import { Octokit } from "https://esm.sh/@octokit/core";
  import { enterpriseServer220Admin } from "https://esm.sh/@octokit/plugin-enterprise-server";
</script>

Install with npm install @octokit/core @octokit/plugin-enterprise-server. Optionally replace @octokit/core with a core-compatible module

const { Octokit } = require("@octokit/core");
const {
  enterpriseServer36Admin,
} = require("@octokit/plugin-enterprise-server");
const OctokitEnterprise36 = Octokit.plugin(enterpriseServer36Admin);
const octokit = new OctokitEnterprise36({
  auth: "secret123",
  baseUrl: "https://github.acme-inc.com/api/v3",
});

octokit.enterpriseAdmin.createUser({
  username: "octocat",
  email: "octocat@acme-inc.com",
});

The list of currently exported plugins are

How it works

The route definitions for the currently supported GitHub Enterprise versions are built automatically from @octokit/openapi. Each time there is a new @octokit/openapi release, the .github/workflows/update.yml workflow is triggered. If an update is found, a pull request is created.

LICENSE

MIT

17.3.1

9 months ago

17.3.0

1 year ago

17.2.0

1 year ago

17.1.0

1 year ago

17.0.1

1 year ago

17.0.0

1 year ago

16.1.0

1 year ago

16.0.1

1 year ago

16.0.0

1 year ago

15.2.1

2 years ago

15.1.1

2 years ago

15.1.2

2 years ago

15.1.0

2 years ago

15.1.5

2 years ago

15.1.3

2 years ago

15.1.4

2 years ago

15.2.0

2 years ago

15.0.0

2 years ago

14.0.0

2 years ago

13.1.0

2 years ago

12.2.1

2 years ago

12.2.2

2 years ago

12.2.3

2 years ago

12.2.0

2 years ago

13.2.0

2 years ago

13.0.0

2 years ago

12.0.0

2 years ago

12.1.0

2 years ago

11.3.0

3 years ago

11.2.2

3 years ago

11.2.3

3 years ago

11.2.1

3 years ago

11.2.0

3 years ago

11.0.2

3 years ago

11.0.3

3 years ago

11.0.0

3 years ago

11.0.1

3 years ago

11.1.0

3 years ago

10.6.4

4 years ago

10.6.3

4 years ago

10.6.2

4 years ago

10.6.1

4 years ago

10.6.0

4 years ago

10.5.2

4 years ago

10.4.8

4 years ago

10.5.0

4 years ago

10.5.1

4 years ago

10.4.7

4 years ago

10.4.5

4 years ago

10.4.6

4 years ago

10.4.4

4 years ago

10.4.1

4 years ago

10.4.2

4 years ago

10.4.3

4 years ago

10.3.2

4 years ago

10.3.3

4 years ago

10.4.0

4 years ago

10.3.1

4 years ago

10.3.0

4 years ago

10.2.0

4 years ago

10.1.7

4 years ago

10.1.6

4 years ago

10.1.5

4 years ago

10.1.4

4 years ago

10.1.3

4 years ago

10.1.2

4 years ago

10.1.1

4 years ago

10.1.0

4 years ago

10.0.5

4 years ago

10.0.6

4 years ago

10.0.7

4 years ago

10.0.3

4 years ago

10.0.4

4 years ago

10.0.2

4 years ago

10.0.1

4 years ago

9.0.3

5 years ago

10.0.0

5 years ago

9.0.2

5 years ago

9.0.1

5 years ago

9.0.0

5 years ago

8.0.0

5 years ago

7.4.5

5 years ago

7.4.4

5 years ago

7.4.3

5 years ago

7.4.2

5 years ago

7.4.1

5 years ago

7.4.0

5 years ago

7.3.0

5 years ago

7.2.0

5 years ago

7.1.1

5 years ago

7.1.0

5 years ago

7.0.0

5 years ago