openapi: 3.2.0
info:
  description: 'This API will return a collection of Prima Units of Measure for menu items and recipes


    The base endpoint URL for this API in production is: `https://marko.aramark.net/v1/recipe`.


    For testing the API with the "Try" tool on this page or in your app, use either our testing server "qa-marko" or our development server "dev-marko".'
  version: 1.0.0-oas3
  title: Units of Measure API
servers:
- url: https://qa-marko.aramark.net/v1/recipe
  description: Testing server
- url: https://dev-marko.aramark.net/v1/recipe
  description: Development server
security:
- apiKey: []
tags:
- name: Units of Measure
paths:
  /units_of_measure:
    get:
      summary: Units of measure
      description: 'Returns units of measure results


        !This endpoint is in production'
      operationId: getUnitsOfMeasure
      parameters:
      - $ref: '#/components/parameters/uomIdParam'
      - $ref: '#/components/parameters/fieldsParam'
      - $ref: '#/components/parameters/smokeParam'
      - $ref: '#/components/parameters/smokeParam'
      tags:
      - Units of Measure
      responses:
        '200':
          description: Provides units of measure
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                  count:
                    type: string
                    description: Number of records returned by request
                  unit_of_measure:
                    type: array
                    items:
                      $ref: '#/components/schemas/units_of_measure'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
components:
  schemas:
    units_of_measure:
      type: object
      properties:
        uom_id:
          type: string
          description: Unit of measure ID from Prima
        description:
          type: string
          description: Unit of measure description
        uom_type:
          type: string
          description: Unit of measure type ie. COUNT, VOLUME, WEIGHT
        ozw_factor:
          type: number
          description: Decimal factor used for conversion of Once Weight
        grams_factor:
          type: number
          description: Decimal factor used for conversion of grams
        tsp_factor:
          type: number
          description: Decimal factor used for conversion of teaspoons
        ml_factor:
          type: number
          description: Decimal factor used for conversion of milliliters
        standard_flag:
          type: string
          description: Y/N is unit of measure in standard format
        metric_flag:
          type: string
          description: Y/N is unit of measure in metric format
        uom_cut_flag:
          type: string
          description: Y/N is unit of measure in cut size
  parameters:
    uomIdParam:
      in: query
      name: uom_id
      description: Unique ID of Recipe Unit of Measure
      required: false
      schema:
        type: string
    smokeParam:
      in: header
      name: smoke
      description: When set to 'true' this HTTP header variable will route the API call to the Integration testing environment. Only applicable in QA.
      schema:
        type: string
        default: 'false'
    fieldsParam:
      name: fields
      in: query
      description: Comma delimited list to reduce the number of fields in response object. When used the property "uom_id" will always be appended to the list for a consistent field for response testing.
      required: false
      schema:
        type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.