From 9bd80ccdf8613b0a03a27431d978e21b728423d6 Mon Sep 17 00:00:00 2001 From: Lenard Gaida Date: Thu, 23 Jan 2020 12:52:39 +0100 Subject: [PATCH 1/2] Add note about non-json content-types to README.md, see #122 #123 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 961fdc51..c4880953 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ It currently supports: We plan to add support for: - [RAML](https://raml.org) +Note that this extension was developed for json-based apis. Don't expect this extension to build usable api specification for non-json response or requests bodies. + ## Motivation [Spring REST Docs](https://projects.spring.io/spring-restdocs/) is a great tool to produce documentation for your RESTful services that is accurate and readable. From 8a79ef68902e51cc33d977be3535fe6522ce3edb Mon Sep 17 00:00:00 2001 From: lgaida <9195031+lgaida@users.noreply.github.com> Date: Thu, 23 Jan 2020 13:57:55 +0100 Subject: [PATCH 2/2] Adopt suggestions to README.md Co-Authored-By: Oliver --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c4880953..0809eb0d 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ It currently supports: We plan to add support for: - [RAML](https://raml.org) -Note that this extension was developed for json-based apis. Don't expect this extension to build usable api specification for non-json response or requests bodies. +Please note that this extension was developed for JSON-based APIs. +We do not expect this extension to build usable API specification for non-JSON request or response bodies. ## Motivation @@ -562,4 +563,3 @@ See [openapi2raml.gradle](samples/restdocs-api-spec-sample/openapi2raml.gradle). ./gradlew restdocs-api-spec-sample:openapi ./gradlew -b samples/restdocs-api-spec-sample/openapi2raml.gradle openapi2raml ``` -