crowdsec-yaml-schemas/collection_schema.yaml at main · crowdsecurity/crowdsec-yaml-schemas · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
$schema: "https://json-schema.org/draft-04/schema"
$id: "http://schemas.crowdsec.net/schemas/collection.yaml"
title: "CrowdSec Collection"
type: object
additionalProperties: false
properties:
  description:
    type: string
    description: "description of the parser usage"
  name:
    type: string
    description: |
      The mandatory name of the node. If not present, node will be
      skipped at runtime. It is used for example in debug log to help
      you track things.
  parsers:
    anyOf:
      - type: array
        items:
          type: string
          description: |
            List of parsers to include in the collection.
      - type: "null"
  scenarios:
    anyOf:
      - type: array
        items:
          type: string
          description: |
            List of scenarios to include in the collection.
      - type: "null"
  appsec-configs:
    anyOf:
      - type: array
        items:
          type: string
          description: |
            List of appsec-configs to include in the collection.
      - type: "null"
  appsec-rules:
    anyOf:
      - type: array
        items:
          type: string
          description: |
            List of appsec-rules to include in the collection.
      - type: "null"
  postoverflows:
    anyOf:
      - type: array
        items:
          type: string
          description: |
            List of postoverflows to include in the collection.
      - type: "null"
  collections:
    anyOf:
      - type: array
        items:
          type: string
          description: |
            List of collections to include in the collection.
      - type: "null"
  contexts:
    anyOf:
      - type: array
        items:
          type: string
          description: |
            List of context to include in the collection.
      - type: "null"
  author:
    type: string
    description: |
      The name of the author.
  tags:
    type: array
    items:
      type: string
    description: |
      List of tags.
  labels:
    $ref: "#/$defs/labels"
$defs:
  labels:
    type: object
    description: |
      Labels is a set of key–value pairs that provide contextual information for
      users. They help users select appropriate collections and allow the hub
      interface to display clearer descriptions.
    patternProperties:
      "^.*$":
        type:
          - string
          - boolean
          - array
          - integer