Skip to content

BZ 2658 - Push Proxy #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marktrayer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

BZ 2658 - Push Proxy #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 215 additions & 0 deletions swagger2.0/oic.r.pushproxy.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,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"
}
}
}