openapi: 3.2.0
info:
  title: Tandoor Shopping List Recipe API
  version: 0.0.0 (2.6.13)
  x-logo:
    url: /static/assets/brand_logo.svg
    backgroundColor: '#FFFFFF'
    altText: Tandoor logo
    href: /
  description: Tandoor API Docs
tags:
- name: Shopping List Recipe
paths:
  /api/shopping-list-recipe/:
    get:
      operationId: apiShoppingListRecipeList
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: query
        name: mealplan
        schema:
          type: integer
        description: Returns only entries associated with the given mealplan id
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Shopping List Recipe
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedShoppingListRecipeList'
          description: ''
      summary: Api shopping list recipe list
      x-summary-source: derived
    post:
      operationId: apiShoppingListRecipeCreate
      description: logs request counts to redis cache total/per user/
      tags:
      - Shopping List Recipe
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShoppingListRecipe'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ShoppingListRecipe'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ShoppingListRecipe'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShoppingListRecipe'
          description: ''
      summary: Api shopping list recipe create
      x-summary-source: derived
  /api/shopping-list-recipe/{id}/:
    get:
      operationId: apiShoppingListRecipeRetrieve
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this shopping list recipe.
        required: true
      tags:
      - Shopping List Recipe
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShoppingListRecipe'
          description: ''
      summary: Api shopping list recipe retrieve
      x-summary-source: derived
    put:
      operationId: apiShoppingListRecipeUpdate
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this shopping list recipe.
        required: true
      tags:
      - Shopping List Recipe
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShoppingListRecipe'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ShoppingListRecipe'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ShoppingListRecipe'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShoppingListRecipe'
          description: ''
      summary: Api shopping list recipe update
      x-summary-source: derived
    patch:
      operationId: apiShoppingListRecipePartialUpdate
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this shopping list recipe.
        required: true
      tags:
      - Shopping List Recipe
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedShoppingListRecipe'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedShoppingListRecipe'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedShoppingListRecipe'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShoppingListRecipe'
          description: ''
      summary: Api shopping list recipe partial update
      x-summary-source: derived
    delete:
      operationId: apiShoppingListRecipeDestroy
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this shopping list recipe.
        required: true
      tags:
      - Shopping List Recipe
      security:
      - ApiKeyAuth: []
      responses:
        '204':
          description: No response body
      summary: Api shopping list recipe destroy
      x-summary-source: derived
  /api/shopping-list-recipe/{id}/bulk_create_entries/:
    post:
      operationId: apiShoppingListRecipeBulkCreateEntriesCreate
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this shopping list recipe.
        required: true
      tags:
      - Shopping List Recipe
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShoppingListEntryBulkCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ShoppingListEntryBulkCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ShoppingListEntryBulkCreate'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShoppingListEntryBulkCreate'
          description: ''
      summary: Api shopping list recipe bulk create entries create
      x-summary-source: derived
components:
  schemas:
    PaginatedShoppingListRecipeList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ShoppingListRecipe'
        timestamp:
          type: string
          format: date-time
    ShoppingListEntrySimpleCreate:
      type: object
      properties:
        amount:
          type: number
          format: double
        unit_id:
          type:
          - integer
          - 'null'
        food_id:
          type:
          - integer
          - 'null'
        ingredient_id:
          type:
          - integer
          - 'null'
      required:
      - amount
      - food_id
      - ingredient_id
      - unit_id
    MealPlan:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        title:
          type: string
          maxLength: 64
        recipe:
          allOf:
          - $ref: '#/components/schemas/RecipeOverview'
        servings:
          type: number
          format: double
        note:
          type: string
        note_markdown:
          type: string
          readOnly: true
        from_date:
          type: string
          format: date-time
        to_date:
          type: string
          format: date-time
        meal_type:
          $ref: '#/components/schemas/MealType'
        created_by:
          type: integer
          readOnly: true
        recipe_name:
          type: string
          readOnly: true
        meal_type_name:
          type: string
          readOnly: true
        shopping:
          type: boolean
          readOnly: true
        addshopping:
          type: boolean
          writeOnly: true
      required:
      - created_by
      - from_date
      - meal_type
      - meal_type_name
      - note_markdown
      - recipe_name
      - servings
      - shopping
    ShoppingListRecipe:
      type: object
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 32
        recipe:
          type:
          - integer
          - 'null'
        recipe_data:
          allOf:
          - $ref: '#/components/schemas/RecipeOverview'
          readOnly: true
        meal_plan_data:
          allOf:
          - $ref: '#/components/schemas/MealPlan'
          readOnly: true
        mealplan:
          type:
          - integer
          - 'null'
        servings:
          type: number
          format: double
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
      required:
      - created_by
      - meal_plan_data
      - recipe_data
      - servings
    KeywordLabel:
      type: object
      properties:
        id:
          type: integer
          readOnly: false
        label:
          type: string
          readOnly: true
      required:
      - label
    MealType:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        order:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        time:
          type:
          - string
          - 'null'
          format: time
        color:
          type:
          - string
          - 'null'
          maxLength: 7
        created_by:
          type: integer
          readOnly: true
      required:
      - created_by
      - name
    RecipeOverview:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        description:
          type:
          - string
          - 'null'
          maxLength: 512
        image:
          type:
          - string
          - 'null'
          format: uri
          readOnly: true
        keywords:
          type: array
          items:
            $ref: '#/components/schemas/KeywordLabel'
          readOnly: true
        working_time:
          type: integer
          readOnly: true
        waiting_time:
          type: integer
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        internal:
          type: boolean
          readOnly: true
        private:
          type: boolean
        servings:
          type: integer
          readOnly: true
        servings_text:
          type: string
          readOnly: true
        rating:
          type:
          - number
          - 'null'
          format: double
          readOnly: true
        last_cooked:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        new:
          type: boolean
          readOnly: true
        recent:
          type: string
          readOnly: true
      required:
      - created_at
      - created_by
      - image
      - internal
      - keywords
      - last_cooked
      - name
      - new
      - rating
      - recent
      - servings
      - servings_text
      - updated_at
      - waiting_time
      - working_time
    ShoppingListEntryBulkCreate:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/ShoppingListEntrySimpleCreate'
        shopping_lists_ids:
          type: array
          items:
            type: integer
      required:
      - entries
    User:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        username:
          type: string
          readOnly: true
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        display_name:
          type: string
          readOnly: true
        is_staff:
          type: boolean
          readOnly: true
          title: Staff status
          description: Designates whether the user can log into this admin site.
        is_superuser:
          type: boolean
          readOnly: true
          title: Superuser status
          description: Designates that this user has all permissions without explicitly assigning them.
        is_active:
          type: boolean
          readOnly: true
          title: Active
          description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
      required:
      - display_name
      - is_active
      - is_staff
      - is_superuser
      - username
    PatchedShoppingListRecipe:
      type: object
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 32
        recipe:
          type:
          - integer
          - 'null'
        recipe_data:
          allOf:
          - $ref: '#/components/schemas/RecipeOverview'
          readOnly: true
        meal_plan_data:
          allOf:
          - $ref: '#/components/schemas/MealPlan'
          readOnly: true
        mealplan:
          type:
          - integer
          - 'null'
        servings:
          type: number
          format: double
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization