From d2c00026e6e408f794107261444aabb142d14b5b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mart=C3=ADn=20Varela?= <martin.varela@metosin.fi>
Date: Fri, 9 Feb 2024 10:45:20 +0200
Subject: [PATCH] doc: Update docs for fetching content types from Muuntaja
 instance

---
 CHANGELOG.md                            |  1 +
 doc/ring/openapi.md                     | 18 +++++++++++++-----
 examples/openapi/src/example/server.clj |  2 --
 3 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2af3d67e..a46fb8f4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,7 @@ We use [Break Versioning][breakver]. The version numbers follow a `<major>.<mino
 
 ## UNRELEASED
 
+* Fetch OpenAPI content types from Muuntaja [#636](https://github.com/metosin/reitit/issues/636)
 * Updated dependencies:
 
 ```clojure
diff --git a/doc/ring/openapi.md b/doc/ring/openapi.md
index 18fb981e..4a788841 100644
--- a/doc/ring/openapi.md
+++ b/doc/ring/openapi.md
@@ -19,12 +19,12 @@ The following route data keys contribute to the generated swagger specification:
 | key            | description |
 | ---------------|-------------|
 | :openapi       | map of any openapi data. Can contain keys like `:deprecated`.
-| :openapi/request-content-types | vector of supported request content types. Defaults to `["application/json"]`. Only needed if you use the [:request :content :default] coercion.
-| :openapi/response-content-types | vector of supported response content types. Defaults to `["application/json"]`. Only needed if you use the [:response nnn :content :default] coercion.
 | :no-doc        | optional boolean to exclude endpoint from api docs
 | :tags          | optional set of string or keyword tags for an endpoint api docs
 | :summary       | optional short string summary of an endpoint
 | :description   | optional long description of an endpoint. Supports http://spec.commonmark.org/
+| :openapi/request-content-types | See the Per-content-type-coercions section below.
+| :openapi/response-content-types |See the Per-content-type-coercions section below. vector of supported response content types. Defaults to `["application/json"]`. Only needed if you use the [:response nnn :content :default] coercion.
 
 Coercion keys also contribute to the docs:
 
@@ -109,7 +109,11 @@ openapi example](../../examples/openapi).
                                                                        :value (pr-str {:color :red :pineapple true})}}}}}}
 ```
 
-
+The default content types map to the content types supported by the Muuntaja
+instance. You can override these by using the `:openapi/request-content-types`
+and `:openapi/response-content-types` keys, which must contain vector of
+supported content types. If there is no Muuntaja instance, and these keys are
+not defined, the content types will default to `["application/json"]`.
 
 ## Custom OpenAPI data
 
@@ -123,9 +127,13 @@ example of `"securitySchemes"`.
 
 ## OpenAPI spec
 
-Serving the OpenAPI specification is handled by `reitit.openapi/create-openapi-handler`. It takes no arguments and returns a ring handler which collects at request-time data from all routes and returns an OpenAPI specification as Clojure data, to be encoded by a response formatter.
+Serving the OpenAPI specification is handled by
+`reitit.openapi/create-openapi-handler`. It takes no arguments and returns a
+ring handler which collects at request-time data from all routes and returns an
+OpenAPI specification as Clojure data, to be encoded by a response formatter.
 
-You can use the `:openapi` route data key of the `create-openapi-handler` route to populate the top level of the OpenAPI spec.
+You can use the `:openapi` route data key of the `create-openapi-handler` route
+to populate the top level of the OpenAPI spec.
 
 Example:
 
diff --git a/examples/openapi/src/example/server.clj b/examples/openapi/src/example/server.clj
index 933e352f..9070a529 100644
--- a/examples/openapi/src/example/server.clj
+++ b/examples/openapi/src/example/server.clj
@@ -63,8 +63,6 @@
                                                                 [:pineapple :boolean]]
                                                        :examples {:purple {:value (pr-str {:color :purple
                                                                                            :pineapple false})}}}}}
-                ;; Need to list content types explicitly because we use :default in :responses
-                :openapi/response-content-types ["application/json" "application/edn"]
                 :responses {200 {:content {:default {:description "Success"
                                                      :schema [:map [:success :boolean]]
                                                      :example {:success true}}}}}