git.iko.soy/typeable/openapi3
on master help sign in
Fix typos, add more fields
commit4fd02b40618b109b86a30359d5e85ad4cb2fc7d4 authorMaxim Koltsov <kolmax94@gmail.com> dateMon 3 Aug 2020, 16:19 (6 years ago) parent6978807
1 file changed+17−2
src/Data/Swagger/Internal.hs+17−2
src/Data/Swagger/Internal.hs+17−2
@@ -194,7 +194,7 @@ data Components = Components
194194 , _componentsParameters :: Definitions Param
195195 , _componentsExamples :: Definitions Example
196196 , _componentsRequestBodies :: Definitions RequestBody
197− , _componentsHeader :: Definitions Header
197+ , _componentsHeaders :: Definitions Header
198198 , _componentsSecuritySchemes :: Definitions SecurityScheme
199199 , _componentsLinks :: Definitions Link
200200 , _componentsCallbacks :: Definitions Callback
@@ -339,6 +339,8 @@ data RequestBody = RequestBody
339339 -- e.g. @text/plain@ overrides @text/*@
340340 , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
341341
342+ -- | Determines if the request body is required in the request.
343+ -- Defaults to 'False'.
342344 , _requestBodyRequired :: Maybe Bool
343345 } deriving (Eq, Show, Generic, Data, Typeable)
344346
@@ -499,6 +501,10 @@ data Param = Param
499501 -- Furthermore, if referencing a schema that contains an example,
500502 -- the examples value SHALL override the example provided by the schema.
501503 , _paramExamples :: InsOrdHashMap Text (Referenced Example)
504+
505+ -- TODO
506+ -- _paramContent :: InsOrdHashMap MediaType MediaTypeObject
507+ -- should be singleton. mutually exclusive with _paramSchema.
502508 } deriving (Eq, Show, Generic, Data, Typeable)
503509
504510data Example = Example
@@ -749,11 +755,20 @@ newtype Callback = Callback (InsOrdHashMap Text PathItem)
749755
750756type HeaderName = Text
751757
752−-- TODO this is mostly a copy of 'Param'.
758+-- | Header fields have the same meaning as for 'Param'.
759+--
760+-- Style is always treated as 'StyleSimple', as it is the only value allowed for headers.
753761data Header = Header
754762 { -- | A short description of the header.
755763 _headerDescription :: Maybe HeaderName
756764
765+ , _headerRequired :: Maybe Bool
766+ , _headerDeprecated :: Maybe Bool
767+ , _headerAllowEmptyValue :: Maybe Bool
768+ , _headerExplode :: Maybe Bool
769+ , _headerExample :: Maybe Value
770+ , _headerExamples :: InsOrdHashMap Text (Referenced Example)
771+
757772 , _headerSchema :: Maybe (Referenced Schema)
758773 } deriving (Eq, Show, Generic, Data, Typeable)
759774