openapi: 3.2.0
info:
  title: Tandoor Recipe Book 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: Recipe Book
paths:
  /api/recipe-book/:
    get:
      operationId: apiRecipeBookList
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: query
        name: limit
        schema:
          type: string
        description: limit number of entries to return
      - in: query
        name: order_direction
        schema:
          type: string
          enum:
          - asc
          - desc
        description: Order ascending or descending
      - in: query
        name: order_field
        schema:
          type: string
          enum:
          - id
          - name
          - order
        description: Field to order recipe books on
      - 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
      - in: query
        name: query
        schema:
          type: string
        description: lookup if query string is contained within the name, case insensitive
      - in: query
        name: random
        schema:
          type: string
        description: randomly orders entries (only works together with limit)
      - in: query
        name: updated_at
        schema:
          type: string
        description: if model has an updated_at timestamp, filter only models updated at or after datetime
        examples:
          DateFormat:
            value: '1972-12-05'
            summary: Date Format
      tags:
      - Recipe Book
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRecipeBookList'
          description: ''
      summary: Api recipe book list
      x-summary-source: derived
    post:
      operationId: apiRecipeBookCreate
      description: logs request counts to redis cache total/per user/
      tags:
      - Recipe Book
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeBook'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RecipeBook'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RecipeBook'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeBook'
          description: ''
      summary: Api recipe book create
      x-summary-source: derived
  /api/recipe-book/{id}/:
    get:
      operationId: apiRecipeBookRetrieve
      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 recipe book.
        required: true
      tags:
      - Recipe Book
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeBook'
          description: ''
      summary: Api recipe book retrieve
      x-summary-source: derived
    put:
      operationId: apiRecipeBookUpdate
      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 recipe book.
        required: true
      tags:
      - Recipe Book
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeBook'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RecipeBook'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RecipeBook'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeBook'
          description: ''
      summary: Api recipe book update
      x-summary-source: derived
    patch:
      operationId: apiRecipeBookPartialUpdate
      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 recipe book.
        required: true
      tags:
      - Recipe Book
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRecipeBook'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedRecipeBook'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedRecipeBook'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeBook'
          description: ''
      summary: Api recipe book partial update
      x-summary-source: derived
    delete:
      operationId: apiRecipeBookDestroy
      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 recipe book.
        required: true
      tags:
      - Recipe Book
      security:
      - ApiKeyAuth: []
      responses:
        '204':
          description: No response body
      summary: Api recipe book destroy
      x-summary-source: derived
  /api/recipe-book/{id}/cascading/:
    get:
      operationId: apiRecipeBookCascadingList
      description: get a paginated list of objects that will be cascaded (deleted) when deleting the selected object
      parameters:
      - in: query
        name: cache
        schema:
          type: boolean
          default: true
        description: If results can be cached or not
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this recipe book.
        required: true
      - 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:
      - Recipe Book
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGenericModelReferenceList'
          description: ''
      summary: Api recipe book cascading list
      x-summary-source: derived
  /api/recipe-book/{id}/nulling/:
    get:
      operationId: apiRecipeBookNullingList
      description: get a paginated list of objects where the selected object will be removed whe its deleted
      parameters:
      - in: query
        name: cache
        schema:
          type: boolean
          default: true
        description: If results can be cached or not
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this recipe book.
        required: true
      - 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:
      - Recipe Book
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGenericModelReferenceList'
          description: ''
      summary: Api recipe book nulling list
      x-summary-source: derived
  /api/recipe-book/{id}/protecting/:
    get:
      operationId: apiRecipeBookProtectingList
      description: get a paginated list of objects that are protecting the selected object form being deleted
      parameters:
      - in: query
        name: cache
        schema:
          type: boolean
          default: true
        description: If results can be cached or not
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this recipe book.
        required: true
      - 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:
      - Recipe Book
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGenericModelReferenceList'
          description: ''
      summary: Api recipe book protecting list
      x-summary-source: derived
components:
  schemas:
    PaginatedGenericModelReferenceList:
      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/GenericModelReference'
        timestamp:
          type: string
          format: date-time
    CustomFilter:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        search:
          type: string
        shared:
          type: array
          items:
            $ref: '#/components/schemas/User'
        created_by:
          type: integer
          readOnly: true
      required:
      - created_by
      - name
      - search
    PaginatedRecipeBookList:
      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/RecipeBook'
        timestamp:
          type: string
          format: date-time
    PatchedRecipeBook:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        description:
          type: string
        shared:
          type: array
          items:
            $ref: '#/components/schemas/User'
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
        filter:
          allOf:
          - $ref: '#/components/schemas/CustomFilter'
        order:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
    RecipeBook:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        description:
          type: string
        shared:
          type: array
          items:
            $ref: '#/components/schemas/User'
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
        filter:
          allOf:
          - $ref: '#/components/schemas/CustomFilter'
        order:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
      required:
      - created_by
      - name
      - shared
    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
    GenericModelReference:
      type: object
      properties:
        id:
          type: integer
          readOnly: false
        model:
          type: string
        name:
          type: string
      required:
      - model
      - name
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization