Skip to content

Commit d95f681

Browse files
Rename openapi_simplified.yaml to openapi_gitbook.yaml and add short explanation
1 parent 2cb71e1 commit d95f681

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This project contains an [OpenAPI specification][openapi-specification] of the
44
[DeepL API][deepl-api], in [YAML](openapi.yaml) and [JSON](openapi.json)
55
formats.
6-
There is also a [simplified YAML](openapi_simplified.yaml) with reduced descriptions that is embedded in our [API documentation][deepl-api-docs].
6+
There is also a [simplified YAML](openapi_gitbook.yaml) with reduced descriptions that is embedded in our [API documentation][deepl-api-docs].
77

88
You can use this specification to explore the API in tools like
99
[Postman][postman], or to auto-generate documentation, SDKs, and code libraries
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
openapi: 3.0.3
22
info:
33
title: DeepL API Documentation
4-
description: The DeepL API provides programmatic access to DeepL’s machine translation
5-
technology.
4+
description: |-
5+
The DeepL API provides programmatic access to DeepL’s machine translation technology.
6+
7+
Note: this OpenAPI spec is embedded into our API documentation and has shortened descriptions.
68
termsOfService: https://www.deepl.com/pro-license/
79
contact:
810
name: DeepL - Contact us

0 commit comments

Comments
 (0)