freta 0.22.0

Project Freta client
Documentation 
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
98
99
100
101
102
103

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WebhookEvent",
  "description": "Freta Webhook Event\n\nThis struct defines the structure of a webhook event sent to user's configured HTTP endpoint via HTTP POST.",
  "type": "object",
  "required": [
    "event_id",
    "event_type",
    "timestamp"
  ],
  "properties": {
    "event_id": {
      "description": "Unique identifier for the event",
      "allOf": [
        {
          "$ref": "#/definitions/WebhookEventId"
        }
      ]
    },
    "event_type": {
      "description": "Type of the event",
      "allOf": [
        {
          "$ref": "#/definitions/WebhookEventType"
        }
      ]
    },
    "image": {
      "description": "The image that triggered the event, if applicable",
      "anyOf": [
        {
          "$ref": "#/definitions/ImageId"
        },
        {
          "type": "null"
        }
      ]
    },
    "timestamp": {
      "description": "Timestamp of when the event occurred",
      "type": "string"
    }
  },
  "definitions": {
    "ImageId": {
      "description": "Unique identifier for an `Image`",
      "type": "string",
      "format": "uuid"
    },
    "WebhookEventId": {
      "description": "Unique identifier for a `WebhookEvent` entry",
      "type": "string",
      "format": "uuid"
    },
    "WebhookEventType": {
      "description": "Webhook Event Types",
      "oneOf": [
        {
          "description": "Ping event, used to validate the webhook functionality",
          "type": "string",
          "enum": [
            "ping"
          ]
        },
        {
          "description": "an Image was created",
          "type": "string",
          "enum": [
            "image_created"
          ]
        },
        {
          "description": "an Image was deleted",
          "type": "string",
          "enum": [
            "image_deleted"
          ]
        },
        {
          "description": "an Image was successfully analyzed",
          "type": "string",
          "enum": [
            "image_analysis_completed"
          ]
        },
        {
          "description": "an Image failed to be analyzed",
          "type": "string",
          "enum": [
            "image_analysis_failed"
          ]
        },
        {
          "description": "an Image State was updated",
          "type": "string",
          "enum": [
            "image_state_updated"
          ]
        }
      ]
    }
  }
}