OCM-API/schemas/ocm-discovery.json at 84737cf15e718f9509d54030966a558f04971ec7 · cs3org/OCM-API · 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
98
99
100
101
{
  "title": "OCM API Discovery",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "apiVersion": {
      "type": "string"
    },
    "endPoint": {
      "type": "string",
      "format": "uri"
    },
    "provider": {
      "type": "string"
    },
    "resourceTypes": {
      "type": "array",
      "items": { "$ref": "#/$defs/resourceType" }
    },
    "capabilities": {
      "type": "array",
      "description": "Capability values of 'enforce-mfa', 'exchange-token', 'http-sig', 'invites', 'invite-wayf', 'notifications', 'protocol-object', and 'webdav-uri' are defined in the draft",
      "items": {
        "type": "string"
      }
    },
    "criteria": {
      "type": "array",
      "description": "Criteria values of 'http-request-signatures', 'token-exchange', 'denylist', 'allowlist', and 'invite' are defined in the draft",
      "items": {
        "type": "string"
      }
    },
    "publicKey": {
      "$ref": "#/$defs/publicKey"
    },
    "inviteAcceptDialog": {
      "type": "string",
      "format": "uri"
    },
    "tokenEndPoint": {
      "type": "string",
      "format": "uri",
      "description": "URL of the token endpoint hosted by the Sending Server."
    }
  },
  "required": [
    "enabled",
    "apiVersion",
    "endPoint",
    "resourceTypes"
  ],
  "$defs": {
    "resourceType": {
      "properties": {
        "name": {
          "type": "string"
        },
        "shareTypes": {
          "type": "array"
        },
        "protocols": { "$ref": "#/$defs/protocols" }
      },
      "required": ["name", "shareTypes", "protocols"]
    },
    "protocols": {
      "type": "object",
      "minProperties": 1,
      "description": "Additional protocols besides 'webdav', 'webapp' and 'datatx' may be defined.",
      "properties": {
        "webdav": {
          "type": "string",
          "pattern": "^/"
        },
        "webapp": {
          "type": "string",
          "pattern": "^/"
        },
        "datatx": {
          "type": "string",
          "pattern": "^/"
        }
      }
    },
    "publicKey": {
      "type": "object",
      "properties": {
        "keyId": {
          "type": "string"
        },
        "publicKeyPem": {
          "type": "string"
        }
      },
      "required": ["keyId", "publicKeyPem"]
    }
  }
}