openapi: 3.2.0
info:
  description: 'Given a day or date range this API has methods to list:

    * fiscal day attributes

    * operational day attributes


    You can return return the _calendar dates_ for given fiscal day attributes:


    * fiscal year

    * fiscal month

    * week of a fiscal month

    * day of the week in a fiscal month


    **The Aramark Fiscal Year**


    * The first month of the fiscal year is October

    * Fiscal months rarely begin on the first day of their correspoinding calendar month.'
  version: 1.0.0-oas3
  title: Calendar Day API
servers:
- url: https://qa-marko.aramark.net/v1
  description: Testing server
- url: https://dev-marko.aramark.net/v1
  description: Development server
security:
- apiKey: []
tags:
- name: Calendar Day
paths:
  /calendar/day:
    get:
      summary: Calendar dates for fiscal params
      description: 'Return a list of calendar dates that meet spefic fiscal time creiteria.


        At a minimum you must specify fiscal_year or fiscal_period (e.g. month).


        !This endpoint is in production'
      operationId: getCalendarDay
      parameters:
      - $ref: '#/components/parameters/fiscalYearParam'
      - $ref: '#/components/parameters/fiscalPeriodParam'
      - $ref: '#/components/parameters/fiscalWeekOfMonthParam'
      - $ref: '#/components/parameters/fiscalDayOfWeekParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      tags:
      - Calendar Day
      responses:
        '200':
          description: List of calendar day information
          content:
            '*/*':
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success' or 'Error'
                    default: Success
                  count:
                    type: string
                    description: Number of calendar dates returned
                  calendar_dates:
                    type: array
                    items:
                      $ref: '#/components/schemas/calendar_dates'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
components:
  parameters:
    fiscalYearParam:
      in: query
      name: fiscal_year
      description: Fiscal year (e.g. "2021")
      required: false
      schema:
        type: number
    fiscalPeriodParam:
      in: query
      name: fiscal_period
      description: Aramark fiscal month using format "MON_FY-YY" (e.g. "JAN_FY-21")
      required: false
      schema:
        type: string
    bypassCacheParam:
      in: header
      name: bypass-cache
      description: This HTTP Header variable will bypass cache.
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
    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
        enum:
        - 'true'
        - 'false'
    fiscalWeekOfMonthParam:
      in: query
      required: false
      name: fiscal_week_of_month
      description: Week of the fiscal month. Only works when fiscal_period (e.g. month) is specified.
      schema:
        type: number
        enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
    fiscalDayOfWeekParam:
      in: query
      required: false
      name: fiscal_day_of_week
      description: 'Day of the week. Only works only when fiscal_period (e.g. month) _and_ fiscal_week_of_month are specified.

        * `1` - Saturday

        * `2` - Sunday

        * `3` - Monday

        * `4` - Tuesday

        * `5` - Wednesday

        * `6` - Thursday

        * `7` - Friday'
      schema:
        type: number
        enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
  schemas:
    calendar_dates:
      type: object
      properties:
        calendar_date:
          type: string
          description: Calendar date for fiscal options provided. "MM/DD/YYYY"
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.