https://github.com/zeplin/openapi

An OpenAPI description for the Zeplin API
https://github.com/zeplin/openapi

openapi openapi-spec openapi-specification zeplin zeplin-api

Last synced: 9 days ago
JSON representation

An OpenAPI description for the Zeplin API

• Host: GitHub
• URL: https://github.com/zeplin/openapi
• Owner: zeplin
• License: mit
• Created: 2021-05-11T10:28:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-04T14:41:22.000Z (2 months ago)
• Last Synced: 2024-10-31T07:51:37.685Z (16 days ago)
• Topics: openapi, openapi-spec, openapi-specification, zeplin, zeplin-api
• Homepage: https://docs.zeplin.dev
• Size: 142 KB
• Stars: 2
• Watchers: 25
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zeplin's OpenAPI Description

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![OpenAPI: v3.0](https://img.shields.io/badge/OpenAPI-v3.0-brightgreen.svg)](https://www.openapis.org)

This repository contains [OpenAPI descriptions](https://www.openapis.org) for the [Zeplin API](https://docs.zeplin.dev).

## What is OpenAPI

From the [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.0):

> The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST 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.

## Descriptions

You can find the descriptions in the `/descriptions` directory.

## License

This project is licensed under [MIT license](LICENSE).

## Contact

Ping us at [email protected] for any feedback or questions. You can also find us in the [Zeplin Developer Slack](https://zpl.io/zeplin-dev-slack) group!