openapi: 3.1.0
info:
  title: Jelly Belly Wiki Beans API
  description: 'Unofficial REST API exposing Jelly Belly bean flavors, recipes, combinations,

    facts, and milestones.

    '
  version: '1.0'
  contact:
    name: Jelly Belly Wiki
    url: https://jelly-belly-wiki.netlify.app/
servers:
- url: https://jellybellywikiapi.onrender.com
  description: Public API host
tags:
- name: Beans
paths:
  /api/Beans:
    get:
      summary: List Jelly Belly beans (paginated)
      operationId: listBeans
      parameters:
      - in: query
        name: pageIndex
        schema:
          type: integer
          default: 1
      - in: query
        name: pageSize
        schema:
          type: integer
          default: 10
      - in: query
        name: flavorName
        schema:
          type: string
      responses:
        '200':
          description: Paginated beans list
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalItems:
                    type: integer
                  pageIndex:
                    type: integer
                  pageSize:
                    type: integer
                  totalPages:
                    type: integer
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bean'
      tags:
      - Beans
  /api/Beans/{id}:
    get:
      summary: Get a single bean by id
      operationId: getBean
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: A bean
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bean'
        '404':
          description: Not found
      tags:
      - Beans
components:
  schemas:
    Bean:
      type: object
      properties:
        beanId:
          type: integer
        flavorName:
          type: string
        description:
          type: string
        ingredients:
          type: array
          items:
            type: string
        groupName:
          type: array
          items:
            type: string
        backgroundColor:
          type: string
        glutenFree:
          type: boolean
        sugarFree:
          type: boolean
        seasonal:
          type: boolean
        kosher:
          type: boolean
        imageUrl:
          type: string
          format: uri