{"swagger":"2.0","info":{"title":"A Simple Swagger API","description":"This is a simple working example of a REST API specified and described using the Swagger 2.0 Open API Initiative language standard.  For further information, see the Open API Specification, https://github.com/OAI/OpenAPI-Specification.","contact":{"name":"Steven Dearborn","url":"http://www.demonstrableresults.com","email":"stevendearborn@msn.com"},"version":"0.0.0"},"schemes":["http"],"host":"localhost:3000","consumes":["application/json"],"produces":["application/json"],"paths":{"/persons":{"get":{"summary":"Your first API definition!","description":"Gets `Person` objects.\nOptional query param of **size** determines\nsize of returned array\n","operationId":"getPersons","produces":["application/xml","application/json"],"parameters":[{"name":"size","in":"query","description":"Size of array","required":false,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":100,"exclusiveMaximum":true}],"responses":{"200":{"description":"Successful response","schema":{"title":"persons","description":"All of the people we know about.","type":"array","items":{"$ref":"#/definitions/PartyName"}},"examples":{"application/xml":"<names:PartyName id=1234 xmlns:names=\"urn:oasis:names:tc:ciq:xnl:3\"> <NameElement ElementType=\"Firstname\">George</NameElement> <NameElement ElementType=\"FamilyName\">Harrison</NameElement> <PartyName>","application/json":{"PartyName":{"id":1234,"Name":[{"Component":{"type":"Firstname","name":"George"}},{"Component":{"type":"FamilyName","name":"Harrison"}}]}}}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/Errors"},"examples":{"application/json":{"apiVersion":"1","errors":[{"code":422,"message":"Unauthorized Access","developerMessage":"No Authorization header found in request.","moreInfo":"https://developers.api.com/help/trial-use-api-key.htm"}]}}},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}}},"security":[{"Trial_Key":[]}]}}},"definitions":{"Person":{"title":"person","description":"Definition for a person object.","type":"object","properties":{"name":{"description":"The person's full name","type":"string"},"single":{"description":"The person's marital status","type":"boolean"}},"additionalProperties":false,"required":["name"]},"Errors":{"title":"errors","type":"object","description":"Reresentation of an error response that provides verbose information about what caused the error.","properties":{"apiVersion":{"description":"The version of the API responding with an error.","type":"string"},"errors":{"description":"Collection of errors resulting from the request.","type":"array","items":{"$ref":"#/definitions/Error"}}},"additionalProperties":false},"Error":{"title":"error","type":"object","description":"A representation of the details of a specific error.","properties":{"code":{"description":"An error code associated with the error.","type":"string"},"property":{"description":"The property or field in the request that is the source of the error.","type":"string"},"message":{"description":"A human-readble error message capable of displaying to the end-user.","type":"string"},"developerMessage":{"description":"A message helpful to the client application developer useful to diagnose and possibly correct the error.","type":"string"},"moreInfo":{"description":"A link to a developer resource that provides relevant information about the error, what causes the error and how to correct it.","type":"string","format":"Url"}},"additionalProperties":false},"PartyName":{"description":"Using OASIS Customer Information Quality XML Standards, see http://docs.oasis-open.org/ciq/v3.0/prd03/specs/ciq-specs-v3-prd3.html#_Toc207716005","type":"object","xml":{"namespace":"urn:oasis:names:tc:ciq:xnl:3","prefix":"names"},"properties":{"id":{"description":"A unique identifier to the XML object as an attribute.","type":"integer","format":"int32","xml":{"attribute":true}},"Name":{"description":"The name of the person.","type":"array","items":{"$ref":"#/definitions/NameComponent"},"xml":{"wrapped":false}}},"example":{"application/xml":"<names:PartyName id=1234 xmlns:names=\"urn:oasis:names:tc:ciq:xnl:3\"> <names:NameElement ElementType=\"Firstname\">George</names:NameElement> <names:NameElement ElementType=\"FamilyName\">Harrison</names:NameElement> </names:PartyName>"},"externalDocs":{"description":"The OASIS standard for customer information quality","url":"http://docs.oasis-open.org/ciq/v3.0/prd03/specs/ciq-specs-v3-prd3.html#_Toc207716005"}},"NameComponent":{"description":"A component of an entity's name.","type":"object","xml":{"namespace":"urn:oasis:names:tc:ciq:xnl:3","prefix":"names","name":"NameElement"},"properties":{"type":{"type":"string","enum":["FirstName","FamilyName","MiddleName"],"default":"FirstName","xml":{"name":"ElementType","attribute":true}},"name":{"type":"string"}},"required":["type","name"]}},"securityDefinitions":{"Trial_Key":{"description":"Uses a unique identifier or API key to try out APIs.","type":"apiKey","name":"api_key","in":"header"}}}