https://github.com/pinterest/api-description
OpenAPI descriptions for Pinterest's REST API
https://github.com/pinterest/api-description
api openapi pinterest
Last synced: 6 months ago
JSON representation
OpenAPI descriptions for Pinterest's REST API
- Host: GitHub
- URL: https://github.com/pinterest/api-description
- Owner: pinterest
- License: mit
- Created: 2021-04-16T17:40:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-11T22:27:29.000Z (8 months ago)
- Last Synced: 2025-07-07T12:43:17.446Z (7 months ago)
- Topics: api, openapi, pinterest
- Homepage: https://developers.pinterest.com
- Size: 650 KB
- Stars: 21
- Watchers: 7
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Pinterest's REST API OpenAPI Description
This repository contains [OpenAPI](https://www.openapis.org/) (version 3.0.3)
descriptions for Pinterest's REST API.
## What is OpenAPI?
From the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification):
> The OpenAPI Specification (OAS) defines a standard, programming
> language-agnostic interface description for HTTP APIs, which allows both
> humans and computers to discover and understand the capabilities of a service
> without requiring access to source code, additional documentation, or
> inspection of network traffic. When properly defined via OpenAPI, a consumer
> can understand and interact with the remote service with a minimal amount of
> implementation logic. Similar to what interface descriptions have done for
> lower-level programming, the OpenAPI Specification removes guesswork in
> calling a service.
## Format
The OpenAPI document is distributed as a single **bundle** that uses OpenAPI
components for reuse and portability using JSON Schema references (`$ref`).
It is available in both JSON (`openapi.json`) and YAML (`openapi.yaml`).
## Extensions
Any [OpenAPI extensions](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#specification-extensions) used will be documented in [extensions](extensions.md).
## Contributing
Because this schema is used internally by Pinterest's API infrastructure, we
don't currently accept pull requests that directly modify the description.
## License
This repository is licensed under the [MIT license](LICENSE).