Skip to content

OpenAPI descriptions for Pinterest's REST API

License

Notifications You must be signed in to change notification settings

pinterest/api-description

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pinterest's REST API OpenAPI Description

This repository contains OpenAPI (version 3.0.3) descriptions for Pinterest's REST API.

What is OpenAPI?

From the 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 used will be documented in extensions.

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.