git.iko.soy/typeable/openapi3
on master help sign in
Fix typos, add more fields
4fd02b4Maxim Koltsov
src/Data/Swagger/Internal.hs+17−2
@@ -194,7 +194,7 @@ data Components = Components
194 , _componentsParameters :: Definitions Param
194 , _componentsParameters :: Definitions Param
195 , _componentsExamples :: Definitions Example
195 , _componentsExamples :: Definitions Example
196 , _componentsRequestBodies :: Definitions RequestBody
196 , _componentsRequestBodies :: Definitions RequestBody
197− , _componentsHeader :: Definitions Header
197+ , _componentsHeaders :: Definitions Header
198 , _componentsSecuritySchemes :: Definitions SecurityScheme
198 , _componentsSecuritySchemes :: Definitions SecurityScheme
199 , _componentsLinks :: Definitions Link
199 , _componentsLinks :: Definitions Link
200 , _componentsCallbacks :: Definitions Callback
200 , _componentsCallbacks :: Definitions Callback
@@ -339,6 +339,8 @@ data RequestBody = RequestBody
339 -- e.g. @text/plain@ overrides @text/*@
339 -- e.g. @text/plain@ overrides @text/*@
340 , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
340 , _requestBodyContent :: InsOrdHashMap MediaType MediaTypeObject
341
341
342+ -- | Determines if the request body is required in the request.
343+ -- Defaults to 'False'.
342 , _requestBodyRequired :: Maybe Bool
344 , _requestBodyRequired :: Maybe Bool
343 } deriving (Eq, Show, Generic, Data, Typeable)
345 } deriving (Eq, Show, Generic, Data, Typeable)
344
346
@@ -499,6 +501,10 @@ data Param = Param
499 -- Furthermore, if referencing a schema that contains an example,
501 -- Furthermore, if referencing a schema that contains an example,
500 -- the examples value SHALL override the example provided by the schema.
502 -- the examples value SHALL override the example provided by the schema.
501 , _paramExamples :: InsOrdHashMap Text (Referenced Example)
503 , _paramExamples :: InsOrdHashMap Text (Referenced Example)
504+
505+ -- TODO
506+ -- _paramContent :: InsOrdHashMap MediaType MediaTypeObject
507+ -- should be singleton. mutually exclusive with _paramSchema.
502 } deriving (Eq, Show, Generic, Data, Typeable)
508 } deriving (Eq, Show, Generic, Data, Typeable)
503
509
504data Example = Example
510data Example = Example
@@ -749,11 +755,20 @@ newtype Callback = Callback (InsOrdHashMap Text PathItem)
749
755
750type HeaderName = Text
756type HeaderName = Text
751
757
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.
753data Header = Header
761data Header = Header
754 { -- | A short description of the header.
762 { -- | A short description of the header.
755 _headerDescription :: Maybe HeaderName
763 _headerDescription :: Maybe HeaderName
756
764
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+
757 , _headerSchema :: Maybe (Referenced Schema)
772 , _headerSchema :: Maybe (Referenced Schema)
758 } deriving (Eq, Show, Generic, Data, Typeable)
773 } deriving (Eq, Show, Generic, Data, Typeable)
759
774