/rest-api-description

OpenAPI descriptions for the REST API used in the conjoon-project

MIT LicenseMIT

conjoon's REST API OpenAPI Description

This repository contains OpenAPI descriptions for the REST API used in the conjoon-project.

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.

Project Status

This project is currently in BETA, the description is in active development. If you've identified a mismatch between conjoon API's behavior and these descriptions, please open an issue.

Description Formats

Each OpenAPI document is available in the bundled format.

License

conjoon/rest-api-description is licensed under the MIT license