openapi/specification/resources/databases/models/firewall_rule.yml at 3deaa957474f81b3203ebd77eed774c588cdc414 · dweinshenker/openapi · 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
type: object

properties:
  uuid:
    type: string
    pattern: '^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}'
    example: 79f26d28-ea8a-41f2-8ad8-8cfcdd020095
    description: A unique ID for the firewall rule itself.
  cluster_uuid:
    type: string
    pattern: '^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}'
    example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    readOnly: true
    description: A unique ID for the database cluster to which the rule is applied.
  type:
    type: string
    enum:
      - droplet
      - k8s
      - ip_addr
      - tag
      - app
    example: droplet
    description: >-
      The type of resource that the firewall rule allows to access the database
      cluster.
  value:
    type: string
    example: ff2a6c52-5a44-4b63-b99c-0e98e7a63d61
    description: >-
      The ID of the specific resource, the name of a tag applied to a group of
      resources, or the IP address that the firewall rule allows to access the
      database cluster.
  created_at:
    type: string
    format: date-time
    example: 2019-01-11T18:37:36Z
    description: >-
      A time value given in ISO8601 combined date and time format that
      represents when the firewall rule was created.
    readOnly: true
  description:
      type: string
      example: 'an IP address for local development'
      description: >-
        A human-readable description of the rule.
required:
  - type
  - value