models.yaml

openapi: 3.0.1
info:
  title: GOMP
  version: "1.0"
paths: {}
components:
  schemas:
    accessLevel:
      description: Access level assigned to a user and used for authorization scopes.
      example: editor
      type: string
      enum:
        - admin
        - editor
        - viewer
      x-go-custom-tag: db:"access_level"
      x-oapi-codegen-extra-tags:
        db: access_level
    recipeState:
      description: Lifecycle state of a recipe.
      example: active
      type: string
      enum:
        - active
        - archived
      x-go-custom-tag: db:"current_state"
      x-oapi-codegen-extra-tags:
        db: current_state
    searchField:
      description: Recipe field to include when applying text search.
      example: ingredients
      type: string
      enum:
        - name
        - ingredients
        - directions
        - storage_instructions
        - nutrition_info
      x-enum-varnames:
        - Name
        - Ingredients
        - Directions
        - StorageInstructions
        - Nutrition
    sortBy:
      description: Field used to order recipe search results.
      example: modified
      type: string
      enum:
        - name
        - id
        - rating
        - created
        - modified
        - random
      x-go-custom-tag: db:"sort_by"
      x-oapi-codegen-extra-tags:
        db: sort_by
    sortDir:
      description: Direction used to sort search results.
      example: desc
      type: string
      enum:
        - asc
        - desc
      x-go-custom-tag: db:"sort_dir"
      x-oapi-codegen-extra-tags:
        db: sort_dir
    appInfo:
      description: Read-only application metadata.
      example:
        copyright: Copyright 2016-2026
        version: 1.12.0
      type: object
      required:
        - copyright
        - version
      properties:
        copyright:
          type: string
        version:
          type: string
    appConfiguration:
      description: Application-wide configuration values managed by administrators.
      example:
        title: The App Title
      required:
        - title
      type: object
      properties:
        title:
          type: string
          x-go-custom-tag: db:"title"
          x-oapi-codegen-extra-tags:
            db: title
    note:
      description: A free-form note attached to a single recipe.
      example:
        id: 14
        recipeId: 3
        text: Add chopped parsley right before serving.
        createdAt: "2026-04-21T14:05:00Z"
        modifiedAt: "2026-04-21T14:05:00Z"
      required:
        - text
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
          x-go-custom-tag: db:"id"
          x-oapi-codegen-extra-tags:
            db: id
        recipeId:
          type: integer
          format: int64
          readOnly: true
          x-go-custom-tag: db:"recipe_id"
          x-oapi-codegen-extra-tags:
            db: recipe_id
        text:
          minLength: 1
          type: string
          x-go-custom-tag: db:"note"
          x-oapi-codegen-extra-tags:
            db: note
        createdAt:
          type: string
          format: date-time
          readOnly: true
          x-go-custom-tag: db:"created_at"
          x-oapi-codegen-extra-tags:
            db: created_at
          x-go-type: time.Time
        modifiedAt:
          type: string
          format: date-time
          readOnly: true
          x-go-custom-tag: db:"modified_at"
          x-oapi-codegen-extra-tags:
            db: modified_at
          x-go-type: time.Time
    recipePatch:
      description: Partial recipe update used for PATCH requests.
      example:
        state: archived
        rating: 4
        mainImageName: old-image.jpg
      type: object
      properties:
        state:
          $ref: "#/components/schemas/recipeState"
        rating:
          type: number
          minimum: 0
          maximum: 5
        mainImageName:
          type: string
    recipeCompact:
      description: Compact recipe representation used when returning lists.
      example:
        id: 3
        name: Lemon Garlic Chicken
        state: active
        mainImageName: lemon-garlic-chicken.jpg
        rating: 4.5
        createdAt: "2026-04-19T09:00:00Z"
        modifiedAt: "2026-04-20T18:15:00Z"
      type: object
      required:
        - name
        - state
        - mainImageName
        - rating
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
          x-go-custom-tag: db:"id"
          x-oapi-codegen-extra-tags:
            db: id
        name:
          minLength: 1
          type: string
          x-go-custom-tag: db:"name"
        state:
          $ref: "#/components/schemas/recipeState"
        mainImageName:
          type: string
          x-go-custom-tag: db:"main_image_name"
          x-oapi-codegen-extra-tags:
            db: main_image_name
        rating:
          type: number
          readOnly: true
          x-go-custom-tag: db:"rating"
          x-oapi-codegen-extra-tags:
            db: rating
        createdAt:
          type: string
          format: date-time
          readOnly: true
          x-go-custom-tag: db:"created_at"
          x-oapi-codegen-extra-tags:
            db: created_at
          x-go-type: time.Time
        modifiedAt:
          type: string
          format: date-time
          readOnly: true
          x-go-custom-tag: db:"modified_at"
          x-oapi-codegen-extra-tags:
            db: modified_at
          x-go-type: time.Time
    recipe:
      description: Full recipe details including ingredients, directions, and tags.
      example:
        id: 3
        name: Lemon Garlic Chicken
        state: active
        mainImageName: lemon-garlic-chicken.jpg
        servingSize: 4 servings
        time: 45 minutes
        nutritionInfo: 420 kcal per serving
        ingredients: 1.5 lb chicken thighs\n2 tbsp olive oil\n3 cloves garlic\n1 lemon
        directions: Marinate chicken, then roast at 400F until cooked through.
        storageInstructions: Refrigerate in an airtight container for up to 3 days.
        sourceUrl: https://example.com/recipes/lemon-garlic-chicken
        tags:
          - weeknight
          - chicken
          - high-protein
        createdAt: "2026-04-19T09:00:00Z"
        modifiedAt: "2026-04-20T18:15:00Z"
      allOf:
        - $ref: "#/components/schemas/recipeCompact"
        - type: object
          required:
            - servingSize
            - nutritionInfo
            - ingredients
            - directions
            - storageInstructions
            - sourceUrl
            - time
            - tags
          properties:
            servingSize:
              type: string
              x-go-custom-tag: db:"serving_size"
              x-oapi-codegen-extra-tags:
                db: serving_size
            time:
              type: string
              x-go-custom-tag: db:"recipe_time"
              x-oapi-codegen-extra-tags:
                db: recipe_time
            nutritionInfo:
              type: string
              x-go-custom-tag: db:"nutrition_info"
              x-oapi-codegen-extra-tags:
                db: nutrition_info
            ingredients:
              type: string
              x-go-custom-tag: db:"ingredients"
              x-oapi-codegen-extra-tags:
                db: ingredients
            directions:
              type: string
              x-go-custom-tag: db:"directions"
              x-oapi-codegen-extra-tags:
                db: directions
            storageInstructions:
              type: string
              x-go-custom-tag: db:"storage_instructions"
              x-oapi-codegen-extra-tags:
                db: storage_instructions
            sourceUrl:
              type: string
              x-go-custom-tag: db:"source_url"
              x-oapi-codegen-extra-tags:
                db: source_url
            tags:
              type: array
              items:
                type: string
              x-go-custom-tag: db:"tags"
              x-oapi-codegen-extra-tags:
                db: tags
    searchFilter:
      description: Search filter criteria used to find recipes.
      example:
        query: chicken lemon
        withPictures: true
        fields:
          - name
          - ingredients
        states:
          - active
        tags:
          - weeknight
          - high-protein
        sortBy: modified
        sortDir: desc
      type: object
      required:
        - query
        - withPictures
        - fields
        - states
        - tags
        - sortBy
        - sortDir
      properties:
        query:
          type: string
          x-go-custom-tag: db:"query"
          x-oapi-codegen-extra-tags:
            db: query
        withPictures:
          type: boolean
          nullable: true
          x-go-custom-tag: db:"with_pictures"
          x-oapi-codegen-extra-tags:
            db: with_pictures
        fields:
          type: array
          items:
            $ref: "#/components/schemas/searchField"
        states:
          type: array
          items:
            $ref: "#/components/schemas/recipeState"
        tags:
          type: array
          items:
            type: string
        sortBy:
          $ref: "#/components/schemas/sortBy"
        sortDir:
          $ref: "#/components/schemas/sortDir"
    savedSearchFilterCompact:
      description: Compact saved search representation used when returning lists.
      example:
        id: 9
        userId: 1
        name: Weeknight Dinners
      required:
        - name
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
          x-go-custom-tag: db:"id"
          x-oapi-codegen-extra-tags:
            db: id
        userId:
          type: integer
          format: int64
          readOnly: true
          x-go-custom-tag: db:"user_id"
          x-oapi-codegen-extra-tags:
            db: user_id
        name:
          minLength: 1
          type: string
          x-go-custom-tag: db:"name"
          x-oapi-codegen-extra-tags:
            db: name
    savedSearchFilter:
      description: Full saved search filter with metadata and filtering criteria.
      example:
        id: 9
        userId: 1
        name: Weeknight Dinners
        query: chicken lemon
        withPictures: true
        fields:
          - name
          - ingredients
        states:
          - active
        tags:
          - weeknight
        sortBy: modified
        sortDir: desc
      allOf:
        - $ref: "#/components/schemas/savedSearchFilterCompact"
        - $ref: "#/components/schemas/searchFilter"
    user:
      description: User account details and authorization level.
      example:
        id: 1
        username: user1
        accessLevel: admin
        createdAt: "2026-04-21T12:00:00Z"
        modifiedAt: "2026-04-21T12:00:00Z"
      type: object
      required:
        - username
        - accessLevel
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
          x-go-custom-tag: db:"id"
          x-oapi-codegen-extra-tags:
            db: id
        username:
          type: string
          x-go-custom-tag: db:"username"
          x-oapi-codegen-extra-tags:
            db: username
        accessLevel:
          $ref: "#/components/schemas/accessLevel"
        createdAt:
          type: string
          format: date-time
          readOnly: true
          x-go-custom-tag: db:"created_at"
          x-oapi-codegen-extra-tags:
            db: created_at
          x-go-type: time.Time
        modifiedAt:
          type: string
          format: date-time
          readOnly: true
          x-go-custom-tag: db:"modified_at"
          x-oapi-codegen-extra-tags:
            db: modified_at
          x-go-type: time.Time
    userSettings:
      description: Per-user UI preferences and quick-access tag settings.
      example:
        userId: 1
        homeTitle: My Home Title
        homeImageUrl: https://example.com/my-image.jpg
        favoriteTags:
          - quick
          - kid-friendly
          - vegetarian
      type: object
      required:
        - favoriteTags
      properties:
        userId:
          type: integer
          format: int64
          readOnly: true
          x-go-custom-tag: db:"user_id"
          x-oapi-codegen-extra-tags:
            db: user_id
        homeTitle:
          type: string
          nullable: true
          x-go-custom-tag: db:"home_title"
          x-oapi-codegen-extra-tags:
            db: home_title
        homeImageUrl:
          type: string
          nullable: true
          x-go-custom-tag: db:"home_image_url"
          x-oapi-codegen-extra-tags:
            db: home_image_url
        favoriteTags:
          type: array
          items:
            type: string
          x-go-custom-tag: db:"favorite_tags"
          x-oapi-codegen-extra-tags:
            db: favorite_tags
    backup:
      description: A full export of all application data for backup and restore purposes.
      example:
        metadata:
          name: 2026-04-21
          version: 1.0
        fileName: backup-2026-04-21.zip
        fileUrl: /backups/backup-2026-04-21.zip
      type: object
      required:
        - metadata
        - fileName
        - fileUrl
      properties:
        sizeInBytes:
          type: integer
          format: int64
        metadata:
          $ref: "#/components/schemas/backupMetadata"
        fileName:
          type: string
        fileUrl:
          type: string
          format: uri
    backupMetadata:
      description: |
        Metadata about a backup file,
        such as its name and the version of the application that created it.
      example:
        name: backup-2026-04-21
        version: 1.0
      type: object
      required:
        - name
        - version
      properties:
        name:
          type: string
        version:
          type: string