https://github.com/conjoon/rest-api-description
OpenAPI descriptions for the REST API used in the conjoon-project
https://github.com/conjoon/rest-api-description
Last synced: 4 months ago
JSON representation
OpenAPI descriptions for the REST API used in the conjoon-project
- Host: GitHub
- URL: https://github.com/conjoon/rest-api-description
- Owner: conjoon
- License: mit
- Created: 2021-10-01T21:39:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T10:47:10.000Z (over 2 years ago)
- Last Synced: 2025-05-21T18:16:45.243Z (about 1 year ago)
- Homepage: https://conjoon.stoplight.io/docs/rest-api-description
- Size: 151 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# conjoon's REST API OpenAPI Description
This repository contains [OpenAPI](https://www.openapis.org/) descriptions for the REST API used in the **conjoon**-project.
## 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.
## 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.](https://github.com/conjoon/rest-api-description/issues/new)
## Description Formats
Each OpenAPI document is available in the **bundled** format.
## License
conjoon/rest-api-description is licensed under the [MIT license](LICENSE.md)