https://github.com/talkjs/talkjs-openapi
OpenAPI specification for TalkJS REST API
https://github.com/talkjs/talkjs-openapi
Last synced: 5 months ago
JSON representation
OpenAPI specification for TalkJS REST API
- Host: GitHub
- URL: https://github.com/talkjs/talkjs-openapi
- Owner: talkjs
- License: mit
- Created: 2024-06-24T07:41:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T07:32:21.000Z (almost 2 years ago)
- Last Synced: 2024-07-09T09:52:34.261Z (almost 2 years ago)
- Size: 81.1 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TalkJS's OpenAPI Specification
This repository contains an OpenAPI specification for [TalkJS’s REST API](https://talkjs.com/docs/Reference/REST_API/Getting_Started/Introduction/).
Specification files can be found in the `json` and `yaml` directories. Currently the spec is only available for the most recent API version (2024-01-01).
## What is OpenAPI?
From the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification):
> The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface document 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 documentation [has] done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
## Contributing
Have you identified a mismatch between TalkJS’s API behavior and this specification? [Open an issue.](https://github.com/talkjs/talkjs-openapi/issues)
## License
MIT License