{
     "name": "Customer api",
     "description": "Customer API documentation providing details for REST APIs",
     "base_url": "https://api.apibuilder.io",
     
     "info": {
       "contact": {
         "name": "IBM",
         "email": "",
         "url": ""
       },
       
        "license": {
         "name": "MIT",
         "url": "http://opensource.org/licenses/MIT"
       }
     },
     
     "imports": [
       
     ],
     
     
     "enums": {},

     "models": {
       "customer": {
         "description": "Customer",
         "fields": [
           { "name": "financialAccountNumber", "type": "uuid",    "description": "financialAccountNumber" },
           { "name": "customerName",           "type": "string",  "description": "customerName" },
           { "name": "branchNumber",           "type": "string",  "description": "branchNumber"},
           { "name": "address1",               "type": "string",  "description": "address1",                            "required": false },
           { "name": "address2",               "type": "string",  "description": "address2",                            "required": false },
           { "name": "city",                   "type": "string",  "description": "city",                                "required": false },
           { "name": "state",                  "type": "string",  "description": "state",                               "required": false },
           { "name": "zip",                    "type": "string",  "description": "zip",                                 "required": false }
           
         ]
       },

       "customer_summary": {
         "description": "Customer Summery",
         "fields": [
           { "name": "financialAccountNumber", "type": "uuid",      "description": "Financial Account Number" },
           { "name": "customerName",           "type": "string",    "description": "Customer Name"  }
         ]
       },

       "customer_create_form": {
        "description": "customer Creation Form", 
        "fields": [
           { "name": "branchNumber",    "type": "string",   "description": "Branch Number"},
           { "name": "customerName",    "type": "string",   "description": "customer Name",     "required": true},
           { "name": "email",           "type": "string",   "description": "Email",             "required": true},
           { "name": "address1",        "type": "string",   "description": "Address1",          "required": true},
           { "name": "address2",        "type": "string",   "description": "Address2",          "required": false},
           { "name": "city",            "type": "string",   "description": "City",              "required": true },
           { "name": "state",           "type": "string",   "description": "State",             "required": true },
           { "name": "zip",             "type": "string",   "description": "Zip",               "required": true }
         ]
       },

       "customer_update_form": {
        "description": "customer Update Form",   
         "fields": [
           { "name": "financialAccountNumber",  "type": "string",   "description": "Financial Account Number",   "required": true},
           { "name": "customerName",            "type": "string",   "description": "Customer Name",              "required": true},
           { "name": "email",                   "type": "string",   "description": "Email"},
           { "name": "address1",                "type": "string",   "description": "Address1"},
           { "name": "address2",                "type": "string",   "description": "Address2"},
           { "name": "city",                    "type": "string",   "description": "City"},
           { "name": "state",                   "type": "string",   "description": "State"},
           { "name": "zip",                     "type": "string",   "description": "Zip"}
         ]
       },
       
       "error": {
         "fields": [
           { "name": "code",            "type": "string",       "description": "Machine readable code for this specific error message" },
           { "name": "description",     "type": "string",       "description": "Description of the error" }
         ]
       }
     },
     
    "resources": {
       
        "customer": {
            "operations": [
            {
                "method": "GET",
                "description": "Search for a specific customer. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users.",
                "path": "/customers",
                "parameters": [
                    { "name": "financialAccountNumber",     "type": "uuid",     "description": "Find customer with this financialAccountNumber. Exact match", "required": false },
                    { "name": "email",                      "type": "string",   "description": "Find user with this email address. Case in-sensitive. Exact match", "required": false },
                    { "name": "customerName",               "type": "string",   "description": "Find user with the specified nickname. For users that register via GitHub, this will be their GitHub username. Case in-sensitive. Exact match", "required": false }
                ],
                "responses": {
                    "200": { "type": "[customer]" },
                    "404": { "type": "[error]" },
                    "500": { "type": "[error]" }
                }
            },

           {
             "method": "GET",
             "description": "Returns information about the user with this financialAccountNumber.",
             "path": "/:customerName",
             "responses": {
               "200": { "type": "customer" },
               "404": { "type": "[error]" },
               "500": { "type": "[error]" }
             }
           },

           {
             "method": "POST",
             "description": "Create a new customer.",
             "path": "/customers",
             "body": { "type": "customer_create_form" },
             "responses": {
               "200": { "type": "customer" },
               "500": { "type": "[error]" }
             }
           },

           {
             "method": "PUT",
             "path": "/:customerName",
             "description": "Updates information about the customer with the specified financialAccountNumber.",
             "body": { "type": "customer_update_form" },
             "responses": {
               "200": { "type": "customer" },
               "404": { "type": "[error]" },
               "500": { "type": "[error]" }
              }
           }
         ]
       }
     }
     
     
   }