polyapi/json-schema/client-function.json at main · api-evangelist/polyapi · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/polyapi/blob/main/json-schema/client-function.json",
  "title": "PolyAPI Client Function",
  "description": "A client function is a shared function that runs wherever it is executed, rather than in the PolyAPI cloud infrastructure.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the client function."
    },
    "name": {
      "type": "string",
      "description": "The name of the client function."
    },
    "description": {
      "type": "string",
      "description": "A description of what the client function does."
    },
    "context": {
      "type": "string",
      "description": "The context path for organizing the function in the catalog."
    },
    "language": {
      "type": "string",
      "enum": ["typescript", "python", "java", "csharp"],
      "description": "The programming language of the function."
    },
    "code": {
      "type": "string",
      "description": "The function source code."
    },
    "state": {
      "type": "string",
      "enum": ["active", "inactive", "deprecated"],
      "description": "The lifecycle state of the function."
    },
    "owner": {
      "type": "string",
      "description": "The owner of the function."
    },
    "visibility": {
      "type": "string",
      "enum": ["public", "private"],
      "description": "The visibility of the function."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the function was created."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the function was last updated."
    }
  },
  "required": ["name", "language", "code"]
}