{"id":13724264,"url":"https://github.com/netlify/open-api","last_synced_at":"2025-05-14T12:08:04.549Z","repository":{"id":37549417,"uuid":"57000527","full_name":"netlify/open-api","owner":"netlify","description":"Open API specification of Netlify's API","archived":false,"fork":false,"pushed_at":"2025-01-22T21:34:55.000Z","size":12278,"stargazers_count":278,"open_issues_count":54,"forks_count":93,"subscribers_count":54,"default_branch":"master","last_synced_at":"2025-04-04T08:42:01.360Z","etag":null,"topics":["production"],"latest_commit_sha":null,"homepage":"https://open-api.netlify.com/#/default","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netlify.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-25T00:16:55.000Z","updated_at":"2025-04-04T02:24:46.000Z","dependencies_parsed_at":"2023-09-23T14:19:16.039Z","dependency_job_id":"b786e3c7-83bc-44dc-a689-c1fefb1055e6","html_url":"https://github.com/netlify/open-api","commit_stats":{"total_commits":723,"total_committers":73,"mean_commits":9.904109589041095,"dds":0.8478561549100968,"last_synced_commit":"166c074a16e7b753980a25579b6c77e432ea8af5"},"previous_names":[],"tags_count":108,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fopen-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fopen-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fopen-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fopen-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netlify","download_url":"https://codeload.github.com/netlify/open-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248420040,"owners_count":21100298,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["production"],"created_at":"2024-08-03T01:01:53.076Z","updated_at":"2025-04-11T14:38:52.321Z","avatar_url":"https://github.com/netlify.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"[![open-api](api.png)](https://open-api.netlify.com/#/default)\n\n[![Build Status][travis-img]][travis]\n\nThis repository contains Netlify's API definition in the [Open API format][open-api-2], formerly known as Swagger.\n\nIt's still a work in progress and we welcome feedback and contributions.\n\n## Usage\n\nThe [`swagger.yml`](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](https://www.netlify.com/docs/api/).\n\nThe spec is published and versioned for various ecosystems:\n\n### SwaggerUI (Web UI)\n\nYou can view the definition using [Swagger UI](https://swagger.io/tools/swagger-ui/) by visiting [open-api.netlify.com](http://open-api.netlify.com) which provides limited interaction with the API from the browser.\n\n### Go Client\n\n[![GoDoc][godoc-img]][godoc]\n[![Go Report Card][goreport-img]][goreport]\n[![Github release][git-img]][git]\n\n```console\n$ go get github.com/netlify/open-api/...\n```\n\n- [Porcelain](https://godoc.org/github.com/netlify/open-api/v2/go/porcelain): High level interactions and operations\n- [Plumbing](https://godoc.org/github.com/netlify/open-api/v2/go/plumbing): Low level client operations generated by [go-swagger][go-swagger]\n- [Models](https://godoc.org/github.com/netlify/open-api/v2/go/models): Models generated by [go-swagger][go-swagger]\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for details on how this client is developed and generated.\n\n### JS Client\n\n[![npm version][npm-js-img]][npm-js] [![downloads][dl-js-img]][dl-js]\n\nWe 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.\n\nSee [github.com/netlify/build/tree/main/packages/js-client](https://github.com/netlify/build/tree/main/packages/js-client) for more details.\n\n#### npm module\n\n[![npm version][npm-img]][npm]\n\nYou can also consume the swagger spec as an npm module:\n\n```console\n$ npm install @netlify/open-api\n# or\n$ yarn add @netlify/open-api\n```\n\n```js\nimport spec from '@netlify/open-api' // import the spec object into your project\n```\n\nThe 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:\n\n##### swagger-js\n\nSwagger's JS client can dynamically create a client from a spec either from a URL or spec object.\n\nSee the [swagger-js](https://github.com/swagger-api/swagger-js) client:\n\n##### Usage\n\n```js\n\u003cscript src='browser/swagger-client.js' type='text/javascript'\u003e\u003c/script\u003e\n\u003cscript\u003e\nvar swaggerClient = new SwaggerClient('https://open-api.netlify.com/swagger.json');\n\u003c/script\u003e\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for more info on how to make contributions to this project.\n\n## License\n\nMIT. See [LICENSE](LICENSE) for more details.\n\n[travis-img]: https://travis-ci.org/netlify/open-api.svg?branch=master\n[travis]: https://travis-ci.org/netlify/open-api\n[npm-img]: https://img.shields.io/npm/v/@netlify/open-api.svg\n[npm]: https://npmjs.org/package/@netlify/open-api\n[npm-js-img]: https://img.shields.io/npm/v/netlify.svg\n[npm-js]: https://npmjs.org/package/netlify\n[dl-js-img]: https://img.shields.io/npm/dm/netlify.svg\n[dl-js]: https://npmjs.org/package/netlify\n[godoc-img]: https://godoc.org/github.com/netlify/open-api/v2/go?status.svg\n[godoc]: https://godoc.org/github.com/netlify/open-api/v2/go\n[goreport-img]: https://goreportcard.com/badge/github.com/netlify/open-api/v2\n[goreport]: https://goreportcard.com/report/github.com/netlify/open-api/v2\n[git-img]: https://img.shields.io/github/release/netlify/open-api.svg\n[git]: https://github.com/netlify/open-api/releases/latest\n[open-api-2]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md\n[go-swagger]: https://github.com/go-swagger/go-swagger\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetlify%2Fopen-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetlify%2Fopen-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetlify%2Fopen-api/lists"}