Tandoor Recipes Step API

openapi: 3.2.0
info:
  title: Tandoor Step 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: Step
paths:
  /api/step/:
    get:
      operationId: apiStepList
      description: logs request counts to redis cache total/per user/
      parameters:
      - 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: Query string matched (fuzzy) against object name.
      - in: query
        name: recipe
        schema:
          type: array
          items:
            type: integer
        description: ID of recipe a step is part of. For multiple repeat parameter.
      tags:
      - Step
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedStepList'
          description: ''
      summary: Api step list
      x-summary-source: derived
    post:
      operationId: apiStepCreate
      description: logs request counts to redis cache total/per user/
      tags:
      - Step
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Step'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Step'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Step'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Step'
          description: ''
      summary: Api step create
      x-summary-source: derived
  /api/step/{id}/:
    get:
      operationId: apiStepRetrieve
      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 step.
        required: true
      tags:
      - Step
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Step'
          description: ''
      summary: Api step retrieve
      x-summary-source: derived
    put:
      operationId: apiStepUpdate
      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 step.
        required: true
      tags:
      - Step
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Step'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Step'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Step'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Step'
          description: ''
      summary: Api step update
      x-summary-source: derived
    patch:
      operationId: apiStepPartialUpdate
      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 step.
        required: true
      tags:
      - Step
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedStep'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedStep'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedStep'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Step'
          description: ''
      summary: Api step partial update
      x-summary-source: derived
    delete:
      operationId: apiStepDestroy
      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 step.
        required: true
      tags:
      - Step
      security:
      - ApiKeyAuth: []
      responses:
        '204':
          description: No response body
      summary: Api step destroy
      x-summary-source: derived
components:
  schemas:
    Step:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        instruction:
          type: string
        ingredients:
          type: array
          items:
            $ref: '#/components/schemas/Ingredient'
        instructions_markdown:
          type: string
          readOnly: true
        time:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        order:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        show_as_header:
          type: boolean
        file:
          allOf:
          - $ref: '#/components/schemas/UserFileView'
        step_recipe:
          type:
          - integer
          - 'null'
        step_recipe_data:
          readOnly: true
        numrecipe:
          type: integer
          readOnly: true
        show_ingredients_table:
          type: boolean
      required:
      - ingredients
      - instructions_markdown
      - numrecipe
      - step_recipe_data
    SupermarketCategory:
      type: object
      description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\n\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\n\nExample of usage:\n```\n    class Child(models.Model):\n    field = models.CharField(unique=True)\n\n\nclass Parent(models.Model):\n    child = models.ForeignKey('Child')\n\n\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n    class Meta:\n        model = Child\n\n\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n    child = ChildSerializer()\n\n    class Meta:\n        model = Parent\n```\n\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\n\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
          minLength: 1
        description:
          type:
          - string
          - 'null'
        open_data_slug:
          type:
          - string
          - 'null'
          maxLength: 128
      required:
      - name
    FoodSimple:
      type: object
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
          minLength: 1
        plural_name:
          type:
          - string
          - 'null'
          maxLength: 128
      required:
      - name
    FoodInheritField:
      type: object
      description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\n\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\n\nExample of usage:\n```\n    class Child(models.Model):\n    field = models.CharField(unique=True)\n\n\nclass Parent(models.Model):\n    child = models.ForeignKey('Child')\n\n\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n    class Meta:\n        model = Child\n\n\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n    child = ChildSerializer()\n\n    class Meta:\n        model = Parent\n```\n\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\n\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type:
          - string
          - 'null'
        field:
          type:
          - string
          - 'null'
      required: []
    Unit:
      type: object
      description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\n\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\n\nExample of usage:\n```\n    class Child(models.Model):\n    field = models.CharField(unique=True)\n\n\nclass Parent(models.Model):\n    child = models.ForeignKey('Child')\n\n\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n    class Meta:\n        model = Child\n\n\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n    child = ChildSerializer()\n\n    class Meta:\n        model = Parent\n```\n\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\n\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
          minLength: 1
        plural_name:
          type:
          - string
          - 'null'
          maxLength: 128
        description:
          type:
          - string
          - 'null'
        base_unit:
          type:
          - string
          - 'null'
          maxLength: 256
        open_data_slug:
          type:
          - string
          - 'null'
          maxLength: 128
      required:
      - name
    Property:
      type: object
      description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\n\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\n\nExample of usage:\n```\n    class Child(models.Model):\n    field = models.CharField(unique=True)\n\n\nclass Parent(models.Model):\n    child = models.ForeignKey('Child')\n\n\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n    class Meta:\n        model = Child\n\n\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n    child = ChildSerializer()\n\n    class Meta:\n        model = Parent\n```\n\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\n\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
      properties:
        id:
          type: integer
          readOnly: false
        property_amount:
          type:
          - number
          - 'null'
          format: double
        property_type:
          $ref: '#/components/schemas/PropertyType'
      required:
      - property_amount
      - property_type
    ShoppingList:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 32
        description:
          type: string
        color:
          type:
          - string
          - 'null'
          maxLength: 7
      required: []
    PatchedStep:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        instruction:
          type: string
        ingredients:
          type: array
          items:
            $ref: '#/components/schemas/Ingredient'
        instructions_markdown:
          type: string
          readOnly: true
        time:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        order:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        show_as_header:
          type: boolean
        file:
          allOf:
          - $ref: '#/components/schemas/UserFileView'
        step_recipe:
          type:
          - integer
          - 'null'
        step_recipe_data:
          readOnly: true
        numrecipe:
          type: integer
          readOnly: true
        show_ingredients_table:
          type: boolean
    Ingredient:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        food:
          allOf:
          - $ref: '#/components/schemas/Food'
        unit:
          allOf:
          - $ref: '#/components/schemas/Unit'
        amount:
          type: number
          format: double
        conversions:
          type: array
          items: {}
          readOnly: true
        note:
          type:
          - string
          - 'null'
          maxLength: 256
        order:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        is_header:
          type: boolean
        no_amount:
          type: boolean
        original_text:
          type:
          - string
          - 'null'
          maxLength: 512
        used_in_recipes:
          type: array
          items: {}
          readOnly: true
        checked:
          type: boolean
          readOnly: true
          default: false
          description: Just laziness to have a checked field on the frontend API client
      required:
      - amount
      - checked
      - conversions
      - food
      - unit
      - used_in_recipes
    RecipeSimple:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        url:
          type: string
          readOnly: true
      required:
      - name
      - url
    PaginatedStepList:
      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/Step'
        timestamp:
          type: string
          format: date-time
    Food:
      type: object
      description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\n\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\n\nExample of usage:\n```\n    class Child(models.Model):\n    field = models.CharField(unique=True)\n\n\nclass Parent(models.Model):\n    child = models.ForeignKey('Child')\n\n\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n    class Meta:\n        model = Child\n\n\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n    child = ChildSerializer()\n\n    class Meta:\n        model = Parent\n```\n\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\n\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
          minLength: 1
        plural_name:
          type:
          - string
          - 'null'
          maxLength: 128
        description:
          type: string
        shopping:
          type: string
          readOnly: true
        recipe:
          allOf:
          - $ref: '#/components/schemas/RecipeSimple'
        url:
          type:
          - string
          - 'null'
          maxLength: 1024
        properties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Property'
        properties_food_amount:
          type: number
          format: double
        properties_food_unit:
          allOf:
          - $ref: '#/components/schemas/Unit'
        fdc_id:
          type:
          - integer
          - 'null'
          maximum: 2147483647
          minimum: -2147483648
        food_onhand:
          type:
          - boolean
          - 'null'
        supermarket_category:
          allOf:
          - $ref: '#/components/schemas/SupermarketCategory'
        parent:
          type: integer
          readOnly: true
        numchild:
          type: integer
          readOnly: true
        inherit_fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FoodInheritField'
        full_name:
          type: string
          description: 'Returns a string representation of a tree node and it''s ancestors,

            e.g. ''Cuisine > Asian > Chinese > Catonese''.'
          readOnly: true
        ignore_shopping:
          type: boolean
        substitute:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FoodSimple'
        substitute_siblings:
          type: boolean
        substitute_children:
          type: boolean
        substitute_onhand:
          type: boolean
          readOnly: true
        child_inherit_fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FoodInheritField'
        open_data_slug:
          type:
          - string
          - 'null'
          maxLength: 128
        shopping_lists:
          type: array
          items:
            $ref: '#/components/schemas/ShoppingList'
      required:
      - full_name
      - name
      - numchild
      - parent
      - shopping
      - substitute_onhand
    PropertyType:
      type: object
      description: Adds nested create feature
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        unit:
          type:
          - string
          - 'null'
          maxLength: 64
        description:
          type:
          - string
          - 'null'
          maxLength: 512
        order:
          type: integer
          default: 0
        open_data_slug:
          type:
          - string
          - 'null'
          maxLength: 128
        fdc_id:
          type:
          - integer
          - 'null'
          maximum: 2147483647
          minimum: -2147483648
      required:
      - name
    UserFileView:
      type: object
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 128
        file_download:
          type: string
          readOnly: true
        preview:
          type: string
          readOnly: true
        file_size_kb:
          type: integer
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - created_by
      - file_download
      - file_size_kb
      - name
      - preview
    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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization