Skip to content

Commit

Permalink
Add OpenAPI spec, changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-jones-dev committed Jun 2, 2022
1 parent 88ecd7d commit 37fb522
Show file tree
Hide file tree
Showing 5 changed files with 3,320 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea/
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

The major and minor version numbers reflect changes to the DeepL API
(backward-incompatible and backward-compatible, respectively). The patch version
number is used only for corrections to the OpenAPI specification, for example:
typos, schema fixes, or adding examples.


## [2.0.0]
Initial release of the OpenAPI specification.


[2.0.0]: https://github.com/DeepLcom/openapi/releases/tag/v2.0.0
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# openapi
# DeepL OpenAPI Specification

This project contains an [OpenAPI specification][openapi-specification] of the
[DeepL API][deepl-api], in [YAML](openapi.yaml) and [JSON](openapi.json)
formats.

You can use this specification to explore the API in tools like
[Postman][postman], or to auto-generate documentation, SDKs, and code libraries
using tools such as [Swagger Editor][swagger-editor] or
[OpenAPI Generator][openapi-generator].

[Changelog](CHANGELOG.md)

If you encounter issues while using this OpenAPI specification or have feature
requests, please [create an issue][issues].

[deepl-api]: https://www.deepl.com/pro-api

[issues]: https://github.com/DeepLcom/openapi/issues

[openapi-specification]: https://openapis.org/

[openapi-generator]: https://openapi-generator.tech/

[postman]: https://www.postman.com/

[swagger-editor]: https://editor.swagger.io/?url=https://raw.githubusercontent.com/DeepLcom/openapi/main/openapi.yaml
Loading

0 comments on commit 37fb522

Please sign in to comment.