Skip to content

Instantly share code, notes, and snippets.

@wogsland
Last active August 29, 2015 14:23
Show Gist options
  • Save wogsland/4c66be6238450328a090 to your computer and use it in GitHub Desktop.
Save wogsland/4c66be6238450328a090 to your computer and use it in GitHub Desktop.
Swagger Path
"/advertisers/create": {
"post": {
"tags": [
"advertisers"
],
"summary": "Creates an advertiser",
"description": "This endpoint is for the creation of an advertiser....",
"operationId": "create",
"produces": [
"application/json"
],
"parameters": [
{
"name": "advertiserName",
"in": "query",
"description": "The name of the advertiser",
"required": true,
"type": "string"
},
{
"name": "firstName",
"in": "query",
"description": "The first name of the contact at the advertiser",
"required": true,
"type": "string"
},
{
"name": "lastName",
"in": "query",
"description": "The last name of the contact at the advertiser",
"required": true,
"type": "string"
},
{
"name": "email",
"in": "query",
"description": "The email of the contact at the advertiser",
"required": true,
"type": "string"
},
{
"name": "password",
"in": "query",
"description": "Password the contact at the advertiser",
"required": true,
"type": "string"
},
{
"name": "phoneNumber",
"in": "query",
"description": "The phone number of the advertiser",
"required": false,
"type": "string"
},
{
"name": "address",
"in": "query",
"description": "Line 1 of the address of the advertiser",
"required": false,
"type": "string"
},
{
"name": "address2",
"in": "query",
"description": "Line 2 of the address of the advertiser",
"required": false,
"type": "string"
},
{
"name": "city",
"in": "query",
"description": "The city of the advertiser",
"required": false,
"type": "string"
},
{
"name": "state",
"in": "query",
"description": "The state of the advertiser",
"required": false,
"type": "string"
},
{
"name": "zipCode",
"in": "query",
"description": "The ZIP code of the advertiser",
"required": false,
"type": "string"
},
{
"name": "portalAccess",
"in": "query",
"description": "Whether the advertiser is granted access to the advertiser portal",
"required": false,
"type": "string",
"enum": [
"Yes",
"No"
]
}
],
"responses": {
"200": {
"description": "successful operation"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment