schema.yaml

# Generated by core/scripts/generate_schema.py
# using Bottica model from core/tests/schema.py

definitions:
  BotEntry:
    description: 'A bot verification entry.


      Should have at least one of fcrdns_hosts, ip_list, ip_ranges, or

      cidr_list specified. If more than one of these is specified, the bot

      must meet ALL the requirements to be considered verified.


      All IPs may be either IPv4 or IPv6.'
    properties:
      cidr_list:
        description: A list of CIDR IP blocks that the bot may use. Items must be
          unique.
        example:
        - 8.8.8.0/24
        items:
          minLength: 1
          type: string
        minLength: 1
        title: Cidr List
        type: array
      fcrdns_hosts:
        description: A list of hosts that the bot's IP may match in a Forward confirmed
          reverse DNS (FCrDNS) query. If this keyis present but the list is empty,
          any host will be allowed, but FCrDNS verification will still be performed.
          Items must be unique.
        example:
        - google.com
        - googlebot.com
        items:
          minLength: 0
          type: string
        minLength: 0
        title: Fcrdns Hosts
        type: array
      ip_list:
        description: A whitelist of IPs that the bot may use. Items must be unique.
        example:
        - 8.8.8.8
        - 8.8.4.4
        items:
          minLength: 1
          type: string
        minLength: 1
        title: Ip List
        type: array
      ip_ranges:
        description: A list of IP ranges that the bot may use. Items must be unique.
        items:
          $ref: '#/definitions/IPRange'
        title: Ip Ranges
        type: array
      name:
        description: A unique name for the bot in question. Should matchuser_agent.family
          from the ua-parser project.
        example: Googlebot
        minLength: 1
        title: Name
        type: string
    required:
    - name
    title: BotEntry
    type: object
  IPRange:
    description: A range of allowed IPs
    properties:
      max:
        description: The maximum IP in the range
        example: 8.8.8.8
        title: Max
        type: string
      min:
        description: The minimum IP in the range
        example: 8.8.8.4
        title: Min
        type: string
    required:
    - min
    - max
    title: IPRange
    type: object
description: The list of all bot verification requirements.
properties:
  bots:
    items:
      $ref: '#/definitions/BotEntry'
    title: Bots
    type: array
required:
- bots
title: Bottica
type: object