colinwarmstrong / haccp_builder_be

README

POST "/api/v1/companies" Required Parameters:

  {
    company:
      {
        name: 'a name as a string',
        email: 'a string that is an email address',
        password: 'a string, encryption/auth not finalized',
      }
  }

Successful POST: status: 200, body:

  {
  id: integer
  }

Failed POST: status: 500

PUT "/api/v1/companies/:id" Parameters:

 {
   company:
     {
     name: 'a new name'
     }
  }

Successful PUT: status: 200, body: The company object with the updated attributes

POST "/api/v1/products/:id/ingredients" Parameters:

{
 ingredient:
   {
     name: string,  (required)
     receiving_from: string, (required)
     receiving_letter: boolean, (defaults to false)
     receiving_dna: boolean, (defaults to false)
     receiving_other: string, (defaults to empty string)
     receiving_hazard_bio: boolean, (defaults to false)
     receiving_hazard_chem: boolean, (defaults to false)
     receiving_hazard_phys: boolean, (defaults to false)
     receiving_hazard_handling: string, (defaults to empty string)
     storage_type: string, (required)
     storage_dna: boolean, (defaults to false)
     storage_other: string, (defaults to empty string)
     storage_hazard_bio: boolean, (defaults to false)
     storage_hazard_chem: boolean, (defaults to false)
     storage_hazard_phys: boolean, (defaults to false)
     storage_hazard_handling: string, (defaults to empty string)
     preparation_method: string, (required)
     preparation_dna: boolean, (defaults to false)
     preparation_other: string, (defaults to empty string)
     preparation_hazard_bio: boolean, (defaults to false)
     preparation_hazard_chem: boolean, (defaults to false)
     preparation_hazard_phys: boolean, (defaults to false)
     preparation_hazard_handling: string (defaults to empty string)
     packaging_method: string, (required)
     packaging_dna: boolean, (defaults to false)
     packaging_other: string, (defaults to empty string)
     packaging_hazard_bio: boolean, (defaults to false)
     packaging_hazard_chem: boolean, (defaults to false)
     packaging_hazard_phys: boolean, (defaults to false)
     packaging_hazard_handling: string (defaults to empty string)
    }
   }

Successful POST: status: 200, body:

      {
        id: ingredient_id (integer)
       }

Failed POST: status: 500, body:

      {
        error: "Unable to create ingredient"
       }

PUT "/api/v1/ingredients/:id" Parameters:

          {
            ingredient:
                        {
                          name: "new name" (can be any of the listed fields, as many as desired)
                         }
           }

Successful PUT: status: 200, body:

     {
       id: ingredient.id
     }

Failed PUT: status: 500, body:

       {
         error: "Unable to update ingredient"
       }