Skip to content

Instantly share code, notes, and snippets.

@boillodmanuel
Last active August 29, 2015 14:07
Show Gist options
  • Save boillodmanuel/df7b7e48d8efec6d41a8 to your computer and use it in GitHub Desktop.
Save boillodmanuel/df7b7e48d8efec6d41a8 to your computer and use it in GitHub Desktop.
{
"specVersion":"0.9.0",
"contact":{
"name":null,
"email":"mail@yahoo.fr",
"url":null
},
"contract":{
"description":"",
"name":"apiname3",
"sections":[
],
"representations":[
{
"description":null,
"extendedType":null,
"identifier":null,
"name":"Contact",
"properties":[
{
"defaultValue":null,
"description":"Auto-generated primary key field",
"enumeration":[
],
"max":null,
"maxOccurs":1,
"min":null,
"minOccurs":1,
"name":"id",
"type":"String",
"uniqueItems":false
},
{
"defaultValue":null,
"description":null,
"enumeration":[
],
"max":null,
"maxOccurs":1,
"min":null,
"minOccurs":1,
"name":"firstName",
"type":"String",
"uniqueItems":false
},
{
"defaultValue":null,
"description":null,
"enumeration":[
],
"max":null,
"maxOccurs":1,
"min":null,
"minOccurs":1,
"name":"lastName",
"type":"String",
"uniqueItems":false
},
{
"defaultValue":null,
"description":null,
"enumeration":[
],
"max":null,
"maxOccurs":1,
"min":null,
"minOccurs":1,
"name":"age",
"type":"Integer",
"uniqueItems":false
}
],
"raw":false,
"sections":[
]
},
{
"description":null,
"extendedType":null,
"identifier":null,
"name":"ContactList",
"properties":[
{
"defaultValue":null,
"description":null,
"enumeration":[
],
"max":null,
"maxOccurs":-1,
"min":null,
"minOccurs":0,
"name":"list",
"type":"Contact",
"uniqueItems":false
}
],
"raw":false,
"sections":[
]
}
],
"resources":[
{
"description":null,
"name":"ContactList",
"operations":[
{
"consumes":[
],
"description":"Loads a list of Contact",
"headers":[
],
"inputPayLoad":null,
"method":"GET",
"name":"getContactList",
"produces":[
"application/json",
"application/xml",
"text/xml",
"application/x-yaml"
],
"queryParameters":[
{
"allowMultiple":false,
"defaultValue":null,
"description":"Configures the way to retrieve content in case of complex representations. Possible values are: \"load\" to all content and \"reference\" to only load root content and references to other elements.",
"enumeration":[
],
"name":"strategy",
"required":false,
"type":"string",
"separator":null
}
],
"responses":[
{
"code":200,
"description":null,
"outputPayLoad":{
"array":false,
"type":"ContactList",
"description":null
},
"message":"The request has succeeded",
"name":"success",
"headers":null
}
]
},
{
"consumes":[
"application/xml",
"text/xml",
"application/json",
"application/x-yaml"
],
"description":"Adds a Contact",
"headers":[
],
"inputPayLoad":null,
"method":"POST",
"name":"postContactList",
"produces":[
"application/xml",
"text/xml",
"application/json",
"application/x-yaml"
],
"queryParameters":[
],
"responses":[
{
"code":200,
"description":null,
"outputPayLoad":{
"array":false,
"type":"Contact",
"description":null
},
"message":"The request has succeeded",
"name":"success",
"headers":null
}
]
}
],
"pathVariables":[
],
"resourcePath":"/contacts/",
"authenticationProtocol":null,
"sections":[
]
},
{
"description":null,
"name":"Contact",
"operations":[
{
"consumes":[
],
"description":"Loads a Contact",
"headers":[
],
"inputPayLoad":null,
"method":"GET",
"name":"getContact",
"produces":[
"application/xml",
"text/xml",
"application/json",
"application/x-yaml"
],
"queryParameters":[
{
"allowMultiple":false,
"defaultValue":null,
"description":"Configures the way to retrieve content in case of complex representations. Possible values are: \"load\" to all content and \"reference\" to only load root content and references to other elements.",
"enumeration":[
],
"name":"strategy",
"required":false,
"type":"string",
"separator":null
}
],
"responses":[
{
"code":200,
"description":null,
"outputPayLoad":{
"array":false,
"type":"Contact",
"description":null
},
"message":"The request has succeeded",
"name":"success",
"headers":null
}
]
},
{
"consumes":[
"application/xml",
"text/xml",
"application/json",
"application/x-yaml"
],
"description":"Stores a Contact",
"headers":[
],
"inputPayLoad":null,
"method":"PUT",
"name":"putContact",
"produces":[
"application/xml",
"text/xml",
"application/json",
"application/x-yaml"
],
"queryParameters":[
],
"responses":[
{
"code":200,
"description":null,
"outputPayLoad":{
"array":false,
"type":"Contact",
"description":null
},
"message":"The request has succeeded",
"name":"success",
"headers":null
}
]
},
{
"consumes":[
],
"description":"Deletes a Contact",
"headers":[
],
"inputPayLoad":null,
"method":"DELETE",
"name":"deleteContact",
"produces":[
],
"queryParameters":[
],
"responses":[
{
"code":200,
"description":null,
"outputPayLoad":null,
"message":"The request has succeeded",
"name":"success",
"headers":null
}
]
}
],
"pathVariables":[
{
"description":"Identifier of the Contact",
"name":"contactid",
"type":"string"
}
],
"resourcePath":"/contacts/{contactid}",
"authenticationProtocol":null,
"sections":[
]
}
]
},
"endpoints":[
],
"license":{
"name":null,
"url":null
},
"version":"1.0.0",
"termsOfService":null,
"keywords":null,
"attribution":null
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment