RecipeOpenAPISpec.yaml

openapi: 3.1.0
info:
  title: Recipe Book API
  description: A simple (and fictional) API to manage recipes for a Recipe Book.
  version: 1.0.0
servers:
  - url: https://api.recipeBook.com/v1
    description: Main production server

paths:
  /recipes/{id}/status:
    get:
      summary: Get the status of a recipe
      operationId: getRecipeStatus
      tags:
        - status
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The status of the recipe
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeStatus'

  /recipes:
    x-speakeasy-errors:
      statusCodes:
        - 4XX
        - 5XX
    get:
      parameters:
      - name: page
        in: query
        schema:
          type: integer
        required: true
      x-speakeasy-errors:
        statusCodes:
          - 401
          - 404
          - 500
      summary: Get all recipes
      operationId: getRecipes
      x-speakeasy-name-override: fetchAllRecipes
      x-speakeasy-group: recipes
      responses:
        '200':
          description: A list of recipes
          content:
            application/json:
              schema:
                title: res
                type: object
                properties:
                  resultArray:
                    type: array
                    items:
                      $ref: '#/components/schemas/Recipe'
                required: 
                  - resultArray
        x-speakeasy-pagination:
          type: offsetLimit
          inputs:
            - name: page
              in: parameters
              type: page
          outputs:
            results: $.resultArray
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthError"
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    post:
      summary: Create a new recipe
      operationId: createRecipe
      x-speakeasy-group: recipes
      requestBody:
        description: Recipe to add to the book
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeInput'
      responses:
        '201':
          description: Recipe created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipe'

  /recipes/{recipeId}:
    get:
      summary: Get a recipe by ID
      operationId: getRecipeById
      parameters:
        - name: recipeId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A single recipe
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipe'
        '404':
          description: Recipe not found
    put:
      summary: Update an existing recipe by ID
      operationId: updateRecipe
      parameters:
        - name: recipeId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: Updated recipe data
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeInput'
      responses:
        '200':
          description: Recipe updated successfully
        '404':
          description: Recipe not found
    delete:
      summary: Delete a recipe by ID
      operationId: deleteRecipe
      parameters:
        - name: recipeId
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Recipe deleted successfully
        '404':
          description: Recipe not found
          
  /internal/staff:
    get:
      summary: Internal staff endpoint
      operationId: internalStaff
      description: This is an internal endpoint for staff management.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: 
                type: object
                properties:
                  message:
                    type: string
                    example: "Internal staff data"
tags:
  - name: status
    description: Status of a recipe

components:
  schemas:
    RecipeStatus:
      type: string
      enum:
        - not_started
        - in_progress
        - complete
      x-speakeasy-enums:
        - NotStarted
        - InProgress
        - Complete
      x-speakeasy-unknown-values: allow
    Recipe:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the recipe
        name:
          type: string
          description: Name of the recipe
        ingredients:
          type: array
          description: List of ingredients
          items:
            type: string
        instructions:
          type: string
          description: Cooking instructions for the recipe
        servings:
          type: integer
          description: Number of servings
        prepTime:
          type: integer
          description: Preparation time in minutes
    RecipeInput:
      type: object
      required:
        - name
        - ingredients
        - instructions
      properties:
        name:
          type: string
          description: Name of the recipe
        ingredients:
          type: array
          description: List of ingredients
          items:
            type: string
        instructions:
          type: string
          description: Cooking instructions for the recipe
        servings:
          type: integer
          description: Number of servings
        prepTime:
          type: integer
          description: Preparation time in minutes
    AuthError:
      type: object
      properties:
        message:
          type: string
          x-speakeasy-error-message: true