git.iko.soy/typeable/swagger2
on master help sign in
Add data model for XML object
commit192932db9f7299daeeb7e226bfab6645c1a529c2 authorNickolay Kudasov <nickolay.kudasov@gmail.com> dateFri 6 Nov 2015, 19:45 (11 years ago) parent88ba5c9
1 file changed+28−3
src/Data/Swagger/Internal.hs+28−3
src/Data/Swagger/Internal.hs+28−3
@@ -387,7 +387,7 @@ data SwaggerSchema = SwaggerSchema
387387
388388 , swaggerSchemaDiscriminator :: Maybe Text
389389 , swaggerSchemaReadOnly :: Maybe Bool
390− , swaggerSchemaXML :: Maybe SwaggerXML
390+ , swaggerSchemaXml :: Maybe SwaggerXml
391391 , swaggerSchemaExternalDocs :: Maybe SwaggerExternalDocs
392392 , swaggerSchemaExample :: Maybe JSON.Value
393393
@@ -418,8 +418,33 @@ data SwaggerSchema = SwaggerSchema
418418data SwaggerSchemaItems = SwaggerSchemaItems
419419 deriving (Show)
420420
421−data SwaggerXML = SwaggerXML
422− deriving (Show)
421+data SwaggerXml = SwaggerXml
422+ { -- | Replaces the name of the element/attribute used for the described schema property.
423+ -- When defined within the @'SwaggerItems'@ (items), it will affect the name of the individual XML elements within the list.
424+ -- When defined alongside type being array (outside the items),
425+ -- it will affect the wrapping element and only if wrapped is true.
426+ -- If wrapped is false, it will be ignored.
427+ swaggerXmlName :: Maybe Text
428+
429+ -- | The URL of the namespace definition.
430+ -- Value SHOULD be in the form of a URL.
431+ , swaggerXmlNamespace :: Maybe Text
432+
433+ -- | The prefix to be used for the name.
434+ , swaggerXmlPrefix :: Maybe Text
435+
436+ -- | Declares whether the property definition translates to an attribute instead of an element.
437+ -- Default value is @False@.
438+ , swaggerXmlAttribute :: Bool
439+
440+ -- | MAY be used only for an array definition.
441+ -- Signifies whether the array is wrapped
442+ -- (for example, @\<books\>\<book/\>\<book/\>\</books\>@)
443+ -- or unwrapped (@\<book/\>\<book/\>@).
444+ -- Default value is @False@.
445+ -- The definition takes effect only when defined alongside type being array (outside the items).
446+ , swaggerXmlWrapped :: Bool
447+ } deriving (Show)
423448
424449data SwaggerItems = SwaggerItems
425450 { -- | The internal type of the array.