core-extensions/swagger2.0/oic.r.pushproxy.swagger.json at 8d4208972cd6f288cb188f40fc8845c5d327c910 · openconnectivityfoundation/core-extensions · 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
{
  "swagger": "2.0",
  "info": {
    "title": "Push Proxy",
    "version": "2019-04-23",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://openconnectivityfoundation.github.io/core/LICENSE.md",
      "x-copyright": "Copyright 2019 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/PushProxyResURI" : {
      "get": {
        "description": "Resource that when composed with another Resource allows for events to be pushed.",
        "parameters": [
          {
            "$ref": "#/parameters/interface-all"
          }
        ],
        "responses": {
          "200": {
            "description" : "",
            "x-example": {
              "n":    "My Friendly Resource Name",
              "rt":   ["oic.r.pushproxy"],
              "pushtarget": "ocf://850faa5d-ccaf-4293-9452-f4fcab2e2c39/light",
              "pushqif":    "oic.if.a",
              "sourcert":   ["oic.r.switch.binary"],
              "state":      "waitingforupdate"
            },
            "schema": {
              "$ref": "#/definitions/PushProxy"
            }
          }
        }
      },
      "post": {
        "description": "Update the Push Proxy Properties.",
        "parameters": [
          {
            "$ref": "#/parameters/interface-rw"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/PushProxy-Update"
            },
            "x-example": {
              "pushtarget": "ocf://850faa5d-ccaf-4293-9452-f4fcab2e2c39/thermostat/settemp",
              "pushqif":    "oic.if.a",
              "sourcert":   ["oic.r.temperature"],
              "state":      "waitingforupdate"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "x-example":  {
              "pushtarget": "ocf://850faa5d-ccaf-4293-9452-f4fcab2e2c39/thermostat/settemp",
              "pushqif":    "oic.if.a",
              "sourcert":   ["oic.r.temperature"]
            },
            "schema": {
              "$ref": "#/definitions/PushProxy-Update"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface-rw" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.rw"]
    },
    "interface-all" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.rw", "oic.if.baseline"]
    }
  },
  "definitions": {
    "PushProxy": {
      "properties": {
        "rt":  {
          "description": "Resource Type of the Resource.",
          "items": {
            "enum": ["oic.r.pushproxy"],
            "type": "string",
            "maxLength": 64
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "pushtarget": {
          "description": "Resource that is the target of the push.  This can be local to the Device or remote.",
          "type": "string"
        },
        "pushqif": {
          "description": "OCF Interface to be used in the UPDATE operation to the target of the push.",
          "maxLength": 64,
          "type": "string",
          "enum": [
            "oic.if.baseline",
            "oic.if.b",
            "oic.if.rw",
            "oic.if.a"
          ]
        },
        "sourcert": {
          "description": "Set of one or more source Resource Types that define the payload in the UPDATE operation.",
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 64
          },
          "minItems": 1,
          "uniqueItems": true
        },
        "state": {
          "description": "Current state of the push proxy.",
          "maxLength": 64,
          "type": "string",
          "enum": [
            "waitingforprovisioning",
            "waitingforupdate",
            "waitingforresponse",
            "error",
            "timeout"
          ]
        },
        "n": {
          "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "id": {
          "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "if": {
          "description": "The OCF Interfaces supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.rw",
              "oic.if.baseline"
            ],
            "type": "string",
            "maxLength": 64
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type" : "object",
      "required": ["pushtarget", "pushqif", "sourcert", "state"]
    },
    "PushProxy-Update" : {
      "properties": {
        "pushtarget": {
          "description": "Resource that is the target of the push.  This can be local to the Device or remote",
          "type": "string"
        },
        "pushqif": {
          "description": "OCF Interface to be used in the UPDATE operation to the target of the push",
          "maxLength": 64,
          "type": "string",
          "enum": [
            "oic.if.baseline",
            "oic.if.b",
            "oic.if.rw",
            "oic.if.a"
          ]
        },
        "sourcert": {
          "description": "Set of one or more source Resource Types that define the payload in the UPDATE operation",
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 64
          },
          "minItems": 1,
          "uniqueItems": true
        },
        "state": {
          "description": "Current state of the push proxy.",
          "maxLength": 64,
          "type": "string",
          "enum": [
            "waitingforupdate"
          ]
        }
      },
      "type" : "object"
    }
  }
}