npmpackage.info

@netlify/open-api

Open API specification of Netlify's API

2.34.0

263

MIT

14.08 kB

27,061,039 4.9

Installations

npm install @netlify/open-api

Score

99.7

Supply Chain

100

Quality

88.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

7

Total

420

Closed

47

Merged

366

Issues

Open

45

Total

119

Closed

74

Releases

v2.34.0

Published on 09 Aug 2024

v2.33.1

Published on 20 Jun 2024

v2.33.0

Published on 17 Jun 2024

v2.32.0

Published on 10 Jun 2024

v2.31.0

Published on 29 May 2024

v2.30.0

Published on 04 Apr 2024

View all 83 releases

Developer

netlify

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=14

Typescript Support

Yes

Node Version

22.6.0

NPM Version

10.8.2 Statistics

263 Stars

973 Commits

84 Forks

55 Watching

20 Branches

75 Contributors

Updated on 27 Nov 2024

Bundle Size

193.02 kB

Minified

14.08 kB

Minified + Gzipped

Bundlephobia

Languages

Go (88.29%)

JavaScript (5.98%)

HTML (4%)

CSS (0.97%)

Makefile (0.76%)

Total Downloads

Cumulative downloads

Total Downloads

27,061,039

Last day

-21.6%

21,267

Compared to previous day

Last week

-3%

150,900

Compared to previous week

Last month

-4.2%

671,190

Compared to previous month

Last year

32.3%

7,244,932

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

ava execa eslint cp-file prettier analytics npm-run-all @redocly/cli is-plain-obj swagger-parser eslint-plugin-n swagger2openapi openapi-typescript analytics-plugin-ga eslint-plugin-import eslint-config-prettier eslint-plugin-prettier

Versions

This repository contains Netlify's API definition in the Open API format, formerly known as Swagger.

It's still a work in progress and we welcome feedback and contributions.

Usage

The swagger.yml file is the master copy of the Open API 2.0 definition. Additional context on using the API can be found on our docs site.

The spec is published and versioned for various ecosystems:

SwaggerUI (Web UI)

You can view the definition using Swagger UI by visiting open-api.netlify.com which provides limited interaction with the API from the browser.

Go Client

1$ go get github.com/netlify/open-api/...

Porcelain: High level interactions and operations
Plumbing: Low level client operations generated by go-swagger
Models: Models generated by go-swagger

See CONTRIBUTING.md for details on how this client is developed and generated.

JS Client

We have a fully featured JS/Node.js client that implements some of the same 'porcelain' methods that the go client does in addition to the open-api methods.

See github.com/netlify/build/tree/main/packages/js-client for more details.

npm module

You can also consume the swagger spec as an npm module:

1$ npm install @netlify/open-api
2# or
3$ yarn add @netlify/open-api

1import spec from '@netlify/open-api' // import the spec object into your project

The module also ships a copy of the original yml spec file at @netlify/open-api/js/dist/swagger.yml. You can use these with generic swagger/open-api clients:

swagger-js

Swagger's JS client can dynamically create a client from a spec either from a URL or spec object.

See the swagger-js client:

Usage

1<script src='browser/swagger-client.js' type='text/javascript'></script>
2<script>
3var swaggerClient = new SwaggerClient('https://open-api.netlify.com/swagger.json');
4</script>

Contributing

See CONTRIBUTING.md for more info on how to make contributions to this project.

License

MIT. See LICENSE for more details.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

Security-Policy

Determines if the project has published a security policy.

8

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fossa.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/fossa.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/release-please.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/release-please.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/release-please.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/swagger-bump.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/swagger-bump.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/swagger-bump.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/swagger-bump.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/swagger-bump.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/swagger-bump.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/verify-go-src.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/verify-go-src.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/verify-go-src.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/netlify/open-api/verify-go-src.yml/master?enable=pin
Warn: downloadThenRun not pinned by hash: .github/workflows/fossa.yml:22
Info: 0 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 1 out of 3 third-party GitHubAction dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned
Info: 2 out of 2 npmCommand dependencies pinned

1

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @netlify/open-api

netlify-cli

17.37.2

Netlify command line tool

@netlify/serverless-functions-api

1.31.0

The runtime API for Netlify Functions

human-signals

8.0.0

Human-friendly process signals

netlify

13.1.21

Netlify Node.js API client