openapi: 3.2.0
info:
  title: 'Mealie Users: Ratings API'
  description: '

    Mealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful

    API interactive documentation that can be used to explore the API. If you''re justing getting started with

    the API and want to get started quickly, you can use the

    [API Usage | Mealie Docs](https://docs.mealie.io/documentation/getting-started/api-usage/)

    as a reference for how to get started.



    If you have any questions or comments about mealie, please use the discord server to talk to the developers or other

    community members. If you''d like to file an issue, please use the

    [GitHub Issue Tracker | Mealie](https://github.com/mealie-recipes/mealie/issues/new/choose)



    ## Helpful Links

    - [Home Page](https://mealie.io)

    - [Documentation](https://docs.mealie.io)

    - [Discord](https://discord.gg/QuStdQGSGK)

    - [Demo](https://demo.mealie.io)

    '
  version: nightly
tags:
- name: 'Users: Ratings'
paths:
  /api/users/{id}/ratings:
    get:
      tags:
      - 'Users: Ratings'
      summary: Get Ratings
      description: Get user's rated recipes
      operationId: get_ratings_api_users__id__ratings_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Id
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRatings_UserRatingOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/{id}/favorites:
    get:
      tags:
      - 'Users: Ratings'
      summary: Get Favorites
      description: Get user's favorited recipes
      operationId: get_favorites_api_users__id__favorites_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Id
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRatings_UserRatingOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/{id}/ratings/{slug}:
    post:
      tags:
      - 'Users: Ratings'
      summary: Set Rating
      description: Sets the user's rating for a recipe
      operationId: set_rating_api_users__id__ratings__slug__post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Id
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRatingUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/{id}/favorites/{slug}:
    post:
      tags:
      - 'Users: Ratings'
      summary: Add Favorite
      description: Adds a recipe to the user's favorites
      operationId: add_favorite_api_users__id__favorites__slug__post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Id
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - 'Users: Ratings'
      summary: Remove Favorite
      description: Removes a recipe from the user's favorites
      operationId: remove_favorite_api_users__id__favorites__slug__delete
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Id
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UserRatings_UserRatingOut_:
      properties:
        ratings:
          items:
            $ref: '#/components/schemas/UserRatingOut'
          type: array
          title: Ratings
      type: object
      required:
      - ratings
      title: UserRatings[UserRatingOut]
    UserRatingOut:
      properties:
        recipeId:
          type: string
          format: uuid4
          title: Recipeid
        rating:
          anyOf:
          - type: number
          - type: 'null'
          title: Rating
        isFavorite:
          type: boolean
          title: Isfavorite
          default: false
        userId:
          type: string
          format: uuid4
          title: Userid
        id:
          type: string
          format: uuid4
          title: Id
      type: object
      required:
      - recipeId
      - userId
      - id
      title: UserRatingOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserRatingUpdate:
      properties:
        rating:
          anyOf:
          - type: number
          - type: 'null'
          title: Rating
        isFavorite:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Isfavorite
      type: object
      title: UserRatingUpdate
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/auth/token