diff --git a/swagger2.0/oic.r.notificationselector-pushproxy.swagger.json b/swagger2.0/oic.r.notificationselector-pushproxy.swagger.json deleted file mode 100644 index 165697c..0000000 --- a/swagger2.0/oic.r.notificationselector-pushproxy.swagger.json +++ /dev/null @@ -1,334 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Notification Selector-Push Proxy", - "version": "2022-06-15", - "license": { - "name": "OCF Data Model License", - "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/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": { - "/NotificationSelectorPushproxyResURI?if=oic.if.rw" : { - "get": { - "description": "Resource that defines the selector for Push Notifications", - "parameters": [ - {"$ref": "#/parameters/interface-rw"} - ], - "responses": { - "200": { - "description" : "", - "x-example": { - "phref": "/myAirquality", - "prt": [ - "oic.r.airquality" - ], - "pushtarget" : "coaps://[2001::200]:49355/pushed-resource-airquality", - "sourcert": [ - "oic.r.pushpayload" - ], - "state": "waitingforupdate" - }, - "schema": { "$ref": "#/definitions/get-nspp-rw-response" } - } - } - }, - "post": { - "description": "Updates the current notification selector information.\n", - "parameters": [ - { "$ref": "#/parameters/interface-rw" }, - { "$ref": "#/parameters/body-update" } - ], - "responses": { - "204": { - "description" : "the notification selector-push proxy is updated successfully\n" - } - } - } - }, - "/NotificationSelectorPushproxyResURI?if=oic.if.baseline" : { - "get": { - "description": "Resource that defines the selector for Push Notifications", - "parameters": [ - {"$ref": "#/parameters/interface-baseline"} - ], - "responses": { - "200": { - "description" : "", - "x-example": { - "rt": ["oic.r.notificationselector", "oic.r.pushproxy"], - "if": ["oic.if.rw", "oic.if.baseline"], - "phref": "/myAirquality", - "prt": [ - "oic.r.airquality" - ], - "pushtarget" : "coaps://[2001::200]:49355/pushed-resource-airquality", - "sourcert": [ - "oic.r.pushpayload" - ], - "state": "waitingforupdate" - }, - "schema": { "$ref": "#/definitions/get-nspp-baseline-response" } - } - } - } - } - }, - "parameters": { - "interface-rw" : { - "in" : "query", - "name" : "if", - "type" : "string", - "enum" : ["oic.if.rw"] - }, - "interface-baseline" : { - "in" : "query", - "name" : "if", - "type" : "string", - "enum" : ["oic.if.baseline"] - }, - "body-update": { - "name": "notificationselector-pushproxy", - "in": "body", - "required": true, - "schema": { "$ref": "#/definitions/post-nspp-rw-request" }, - "x-example": { - "phref": "/myFilterResURI", - "pushtarget" : "coaps://[2001::200]:49355/pushed-resource-filter", - "sourcert": [ - "oic.r.pushpayload" - ] - } - } - }, - "definitions": { - "get-nspp-baseline-response" : { - "type": "object", - "properties": { - "rt": { - "description": "Resource Type of the Resource", - "items": { - "enum": ["oic.r.notificationselector", "oic.r.pushproxy"], - "type": "string", - "maxLength": 64 - }, - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "type": "array" - }, - "if": { - "description": "The interface set supported by this resource", - "items": { - "enum": [ - "oic.if.rw", - "oic.if.baseline" - ], - "type": "string", - "maxLength": 64 - }, - "minItems": 1, - "readOnly": true, - "uniqueItems": true, - "type": "array" - }, - "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" - }, - "phref" : { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/href" - }, - "prt": { - "description": "Resource Type(s) of the Resource(s) to be pushed", - "type": "array", - "items" : { - "type" : "string", - "maxLength": 64 - }, - "minItems" : 1 - }, - "pif": { - "description": "The OCF Interface(s) of the Resource(s) to be pushed", - "type": "array", - "items": { - "type" : "string", - "enum" : ["oic.if.baseline", "oic.if.ll", "oic.if.b", "oic.if.lb", "oic.if.rw", "oic.if.r", "oic.if.a", "oic.if.s" ] - }, - "minItems": 1 - }, - "pushtarget": { - "description": "Points to the target of the UPDATE operation sent as a notification", - "type": "string", - "maxLength": 256 - }, - "sourcert": { - "description" : "Always set to oic.r.pushpayload", - "type" : "array", - "uniqueItems" : true, - "items" : { - "type": "string", - "maxLength": 64, - "enum" : [ - "oic.r.pushpayload" - ] - } - }, - "state": { - "description": "Current state of the Push Proxy", - "type": "string", - "enum": [ - "waitingforprovisioning", - "waitingforupdate", - "waitingforresponse", - "waitingforupdatemitigation", - "waitingforresponsemitigation", - "error", - "timeout" - ] - } - }, - "required": [ - "rt", - "if", - "pushtarget", - "sourcert", - "state" - ] - }, - "get-nspp-rw-response" : { - "type": "object", - "properties": { - "phref" : { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/href" - }, - "prt": { - "description": "Resource Type(s) of the Resource(s) to be pushed", - "type": "array", - "items" : { - "type" : "string", - "maxLength": 64 - }, - "minItems" : 1 - }, - "pif": { - "description": "The OCF Interface(s) of the Resource(s) to be pushed", - "type": "array", - "items": { - "type" : "string", - "enum" : ["oic.if.baseline", "oic.if.ll", "oic.if.b", "oic.if.lb", "oic.if.rw", "oic.if.r", "oic.if.a", "oic.if.s" ] - }, - "minItems": 1 - }, - "pushtarget": { - "description": "Points to the target of the UPDATE operation sent as a notification", - "type": "string", - "maxLength": 256 - }, - "sourcert": { - "description" : "Always set to oic.r.pushpayload", - "type" : "array", - "uniqueItems" : true, - "items" : { - "type": "string", - "maxLength": 64, - "enum" : [ - "oic.r.pushpayload" - ] - } - }, - "state": { - "description": "Current state of the Push Proxy", - "type": "string", - "enum": [ - "waitingforprovisioning", - "waitingforupdate", - "waitingforresponse", - "waitingforupdatemitigation", - "waitingforresponsemitigation", - "error", - "timeout" - ] - } - }, - "required": [ - "pushtarget", - "sourcert", - "state" - ] - }, - "post-nspp-rw-request" : { - "type": "object", - "properties": { - "phref" : { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/href" - }, - "prt": { - "description": "Resource Type(s) of the Resource(s) to be pushed", - "type": "array", - "items" : { - "type" : "string", - "maxLength": 64 - }, - "minItems" : 1 - }, - "pif": { - "description": "The OCF Interface(s) of the Resource(s) to be pushed", - "type": "array", - "items": { - "type" : "string", - "enum" : ["oic.if.baseline", "oic.if.ll", "oic.if.b", "oic.if.lb", "oic.if.rw", "oic.if.r", "oic.if.a", "oic.if.s" ] - }, - "minItems": 1 - }, - "pushtarget": { - "description": "Points to the target of the UPDATE operation sent as a notification", - "type": "string", - "maxLength": 256 - }, - "sourcert": { - "description" : "Always set to oic.r.pushpayload", - "type" : "array", - "uniqueItems" : true, - "items" : { - "type": "string", - "maxLength": 64, - "enum" : [ - "oic.r.pushpayload" - ] - } - }, - "state": { - "description": "Current state of the Push Proxy", - "type": "string", - "enum": [ - "waitingforprovisioning", - "waitingforupdate", - "waitingforresponse", - "waitingforupdatemitigation", - "waitingforresponsemitigation", - "error", - "timeout" - ] - } - }, - "required": [ - "pushtarget", - "sourcert" - ] - } - } -} diff --git a/swagger2.0/oic.r.pushconfiguration.swagger.json b/swagger2.0/oic.r.pushconfiguration.swagger.json deleted file mode 100644 index 1164d24..0000000 --- a/swagger2.0/oic.r.pushconfiguration.swagger.json +++ /dev/null @@ -1,532 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Push Configuration", - "version": "2022-06-15", - "license": { - "name": "OCF Data Model License", - "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/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": { - "/PushConfigurationResURI" : { - "get": { - "description": "Collection of oic.r.notificationselector with associated push proxies.\nAllows a Server to be configured with one or more Push Notification destinations.\n", - "parameters": [ - {"$ref": "#/parameters/interface-ll"} - ], - "responses": { - "200": { - "description" : "", - "x-example": [ - {"href": "/pushconfig/1", "rt": ["oic.r.notificationselector","oic.r.pushproxy"], "if": ["oic.if.rw","oic.if.baseline"], "eps": [{"ep": "coaps://[fe80::b1d6]:1122"}]}, - {"href": "/pushconfig/2", "rt": ["oic.r.notificationselector", "oic.r.pushproxy"], "if": ["oic.if.rw","oic.if.baseline"], "eps": [{"ep": "coaps://[fe80::b1d6]:1122"}]} - ], - "schema": { "$ref": "#/definitions/links-in-response" } - } - } - } - }, - "/PushConfigurationResURI?if=oic.if.baseline" : { - "get": { - "description": "Collection of oic.r.notificationselector and associated push proxies.\nAllows a Server to be configured with one or more Push Notification destinations.\n", - "parameters": [ - {"$ref": "#/parameters/interface-baseline"} - ], - "responses": { - "200": { - "description" : "", - "x-example": { - "rt": ["oic.r.pushconfiguration"], - "if": ["oic.if.ll","oic.if.create","oic.if.baseline"], - "rts": ["oic.r.notificationselector", "oic.r.pushproxy"], - "links": [ - {"href": "/pushconfig/1", "rt": ["oic.r.notificationselector","oic.r.pushproxy"], "if": ["oic.if.rw","oic.if.baseline"], "eps": [{"ep": "coaps://[fe80::b1d6]:1122"}]}, - {"href": "/pushconfig/2", "rt": ["oic.r.notificationselector", "oic.r.pushproxy"], "if": ["oic.if.rw","oic.if.baseline"], "eps": [{"ep": "coaps://[fe80::b1d6]:1122"}]} - ] - }, - "schema": { "$ref": "#/definitions/get-baseline-response" } - } - } - } - }, - "/PushConfigurationResURI?if=oic.if.create" : { - "post": { - "description": "Collection of oic.r.notificationselector and associated push proxies.\nAllows a Server to be configured with one or more Push Notification destinations.\n", - "parameters": [ - { - "$ref": "#/parameters/interface-create" - }, - { - "$ref": "#/parameters/body-create" - } - ], - "responses": { - "201": { - "description" : "new link and corresponding target Resource are created", - "x-example": { - "href": "/pushconfig/1", - "rt": ["oic.r.notificationselector", "oic.r.pushproxy"], - "if": ["oic.if.baseline", "oic.if.rw"], - "ins": 4213291245, - "p": { "bm": 3 }, - "rep": { - "rt": ["oic.r.notificationselector", "oic.r.pushproxy"], - "if": ["oic.if.rw", "oic.if.baseline"], - "phref": "/myAirquality", - "prt": [ - "oic.r.airquality" - ], - "pushtarget" : "coaps://[2001::200]:49355/pushed-resource-airquality", - "sourcert": [ - "oic.r.pushpayload" - ], - "state": "waitingforupdate" - } - }, - "schema": { "$ref": "#/definitions/post-create-response" } - } - } - } - } - }, - "parameters": { - "interface-baseline" : { - "in" : "query", - "name" : "if", - "type" : "string", - "enum" : ["oic.if.baseline"] - }, - "interface-ll" : { - "in" : "query", - "name" : "if", - "type" : "string", - "enum" : ["oic.if.ll"] - }, - "interface-create" : { - "in" : "query", - "name" : "if", - "type" : "string", - "enum" : ["oic.if.create"] - }, - "body-create" : { - "in" : "body", - "name" : "notificationselector-pushproxy", - "required" : true, - "schema" : { - "$ref" : "#/definitions/post-create-request" - }, - "x-example" : { - "rt": [ "oic.r.notificationselector", "oic.r.pushproxy" ], - "if": [ "oic.if.rw", "oic.if.baseline" ], - "rep": { - "phref": "/myFilterResURI", - "prt": [ - "oic.r.airquality" - ], - "pushtarget" : "coaps://[2001::200]:49355/pushed-resource-filter", - "sourcert": [ - "oic.r.pushpayload" - ] - } - } - } - }, - "definitions": { - "oic.oic-link": { - "type": "object", - "properties": { - "if": { - "description": "The OCF Interface set supported by the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": [ - "oic.if.baseline", - "oic.if.rw" - ] - } - }, - "rt": { - "description": "Resource Type of the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "enum": [ - "oic.r.notificationselector", - "oic.r.pushproxy" - ], - "type": "string", - "maxLength": 64 - } - }, - "anchor": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/anchor" - }, - "di": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/di" - }, - "eps": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/eps" - }, - "href": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/href" - }, - "ins": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/ins" - }, - "p": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/p" - }, - "rel": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/rel_array" - }, - "title": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/title" - }, - "type": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/type" - } - }, - "required": [ - "href", - "rt", - "if" - ] - }, - "links-in-response": { - "type": "array", - "items": { - "$ref": "#/definitions/oic.oic-link" - } - }, - "get-baseline-response" : { - "type" : "object", - "properties": { - "rt": { - "type": "array", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": ["oic.r.pushconfiguration"] - } - }, - "if": { - "description": "The OCF Interface set supported by this Resource", - "type": "array", - "minItems": 1, - "readOnly": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": [ - "oic.if.ll", - "oic.if.create", - "oic.if.baseline" - ] - } - }, - "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" - }, - "rts": { - "type": "array", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": [ - "oic.r.notificationselector", - "oic.r.pushproxy" - ] - } - }, - "links": { - "$ref": "#/definitions/links-in-response" - } - }, - "required": [ - "rt", - "if", - "links" - ] - }, - "rep-in-request": { - "type": "object", - "properties": { - "phref": { - "description": "URI of a Resource to be pushed", - "type": "string", - "maxLength": 256 - }, - "prt": { - "description": "Resource type(s) of Resource(s) to be pushed", - "type": "array", - "uniqueItems": true, - "items": { - "type": "string", - "maxLength": 64 - } - }, - "pif": { - "description": "OCF Interface(s) of Resource(s) to be pushed", - "type": "array", - "uniqueItems": true, - "items": { - "type": "string", - "maxLength": 64 - } - }, - "pushtarget": { - "description": "Points to the target of the UPDATE operation sent as a notifcation", - "type": "string", - "maxLength": 256 - }, - "sourcert": { - "description" : "Always set to oic.r.pushpayload", - "type" : "array", - "uniqueItems" : true, - "items" : { - "type": "string", - "maxLength": 64, - "enum" : [ - "oic.r.pushpayload" - ] - } - }, - "state": { - "description": "Current state of the Push Proxy", - "type": "string", - "enum": [ - "waitingforprovisioning", - "waitingforupdate", - "waitingforresponse", - "waitingforupdatemitigation", - "waitingforresponsemitigation", - "error", - "timeout" - ] - } - }, - "required": [ - "pushtarget", - "sourcert" - ] - }, - "rep-in-response": { - "type": "object", - "properties": { - "rt": { - "description": "Resource Type of the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "enum": [ - "oic.r.notificationselector", - "oic.r.pushproxy" - ], - "type": "string", - "maxLength": 64 - } - }, - "if": { - "description": "The OCF Interface set supported by the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": [ - "oic.if.rw", - "oic.if.baseline" - ] - } - }, - "phref": { - "description": "URI of a Resource to be pushed", - "type": "string", - "maxLength": 256 - }, - "prt": { - "description": "Resource type(s) of Resource(s) to be pushed", - "type": "array", - "uniqueItems": true, - "items": { - "type": "string", - "maxLength": 64 - } - }, - "pif": { - "description": "OCF Interface(s) of Resource(s) to be pushed", - "type": "array", - "uniqueItems": true, - "items": { - "type": "string", - "maxLength": 64 - } - }, - "pushtarget": { - "description": "Points to the target of the UPDATE operation sent as a notifcation", - "type": "string", - "maxLength": 256 - }, - "sourcert": { - "description" : "Always set to oic.r.pushpayload", - "type" : "array", - "uniqueItems" : true, - "items" : { - "type": "string", - "maxLength": 64, - "enum" : [ - "oic.r.pushpayload" - ] - } - }, - "state": { - "description": "Current state of the Push Proxy", - "type": "string", - "enum": [ - "waitingforprovisioning", - "waitingforupdate", - "waitingforresponse", - "waitingforupdatemitigation", - "waitingforresponsemitigation", - "error", - "timeout" - ] - } - }, - "required": [ - "rt", - "if", - "pushtarget", - "sourcert", - "state" - ] - }, - "post-create-request": { - "type" : "object", - "properties": { - "rt": { - "description": "Resource Type of the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "enum": [ - "oic.r.notificationselector", - "oic.r.pushproxy" - ], - "type": "string", - "maxLength": 64 - } - }, - "if": { - "description": "The OCF Interface set supported by the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": [ - "oic.if.rw", - "oic.if.baseline" - ] - } - }, - "rep": { - "$ref": "#/definitions/rep-in-request" - } - }, - "required": [ - "rt", - "if", - "rep" - ] - }, - "post-create-response": { - "type" : "object", - "properties": { - "href": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/href" - }, - "rt": { - "description": "Resource Type of the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "enum": [ - "oic.r.notificationselector", - "oic.r.pushproxy" - ], - "type": "string", - "maxLength": 64 - } - }, - "if": { - "description": "The OCF Interface set supported by the target Resource", - "type": "array", - "minItems": 1, - "uniqueItems": true, - "readOnly": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": [ - "oic.if.rw", - "oic.if.baseline" - ] - } - }, - "ins": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/ins" - }, - "p": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/p" - }, - "rep": { - "$ref": "#/definitions/rep-in-response" - } - }, - "required": [ - "href", - "rt", - "if", - "ins", - "rep" - ] - } - } -} diff --git a/swagger2.0/oic.r.pushpayload.swagger.json b/swagger2.0/oic.r.pushpayload.swagger.json deleted file mode 100644 index c571f7c..0000000 --- a/swagger2.0/oic.r.pushpayload.swagger.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Payload", - "version": "2019-03-25", - "license": { - "name": "OCF Data Model License", - "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/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": { - "/PushpayloadResURI" : { - "post": { - "description": "Defines the payload sent in a Push Notification (POST to a target URI).\n", - "parameters": [ - { - "$ref": "#/parameters/interface-all" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { "$ref": "#/definitions/Payload" }, - "x-example": [ - { - "anchor": "ocf://5c68f373-0c4c-4604-9922-db639e20533d", - "href": "/mysensor", - "rt": ["oic.r.sensor.carbonmonoxide"], - "if": ["oic.if.s"], - "rep": { - "value": true - } - } - ] - } - ], - "responses": { - "200": { - "description" : "Success path response code\n" - } - } - } - } - }, - "parameters": { - "interface-all" : { - "in" : "query", - "name" : "if", - "type" : "string", - "enum" : ["oic.if.r", "oic.if.baseline"] - } - }, - "definitions": { - "Payload" : { - "type" : "array", - "title" : "Push Payload Format", - "items" : { - "type": "object", - "additionalProperties": true, - "properties": { - "anchor": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/anchor" - }, - "href": { - "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.links.properties.core-schema.json#/definitions/href" - }, - "if": { - "description": "The interface associated with the representation provided.", - "items": { - "enum": [ - "oic.if.baseline", - "oic.if.ll", - "oic.if.b", - "oic.if.lb", - "oic.if.rw", - "oic.if.r", - "oic.if.a", - "oic.if.s" - ], - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "readOnly": true, - "type": "array" - }, - "rep": { - "description": "The push payload for a single Resource", - "type": "object" - }, - "rt": { - "description": "Resource Type of the resource being pushed", - "items": { - "maxLength": 64, - "type": "string" - }, - "minItems": 1, - "readOnly": true, - "type": "array" - } - }, - "required": [ - "anchor", - "rt", - "if", - "rep" - ] - } - } - } -} diff --git a/swagger2.0/oic.r.pushreceiver.swagger.json b/swagger2.0/oic.r.pushreceiver.swagger.json deleted file mode 100644 index 04040dd..0000000 --- a/swagger2.0/oic.r.pushreceiver.swagger.json +++ /dev/null @@ -1,263 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Push Receiver", - "version": "2022-06-15", - "license": { - "name": "OCF Data Model License", - "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/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": { - "/PushReceiverResURI": { - "get": { - "description": "Resource that defines the receiver for Push Notifications", - "parameters": [ - { - "$ref": "#/parameters/interface-rw" - } - ], - "responses": { - "200": { - "description": "", - "x-example": { - "receivers": [ - { - "receiveruri": "/mylocaltargeturiforthermostats", - "rts": ["oic.r.temperature", "oic.r.humidity"] - }, - { - "receiveruri": "/mylocaltargeturifordontcare", - "rts": [] - } - ] - }, - "schema": { "$ref": "#/definitions/get-rw-response" } - } - } - }, - "post": { - "description": "replace whole push receiver objects\n", - "parameters": [ - { "$ref": "#/parameters/interface-rw" }, - { "$ref": "#/parameters/body-receivers-update" } - ], - "responses": { - "204": { - "description": "whole receiver objects are replaced successfully\n" - } - } - }, - "delete": { - "description": "delete whole push receiver objects\n", - "parameters": [ - { - "$ref": "#/parameters/interface-rw" - } - ], - "responses": { - "204": { - "description": "whole receiver objects are removed successfully\n" - } - } - } - }, - "/PushReceiverResURI?receiveruri=": { - "post": { - "description": "Updates a push receiver object which has `receiveruri`\n", - "parameters": [ - { "$ref": "#/parameters/interface-rw" }, - { "$ref": "#/parameters/receiveruri" }, - { "$ref": "#/parameters/body-receiver-update" } - ], - "responses": { - "204": { - "description": "a receiver object is updated successfully\n" - } - } - }, - "delete": { - "description": "delete a push receiver object which has `receiveruri`\n", - "parameters": [ - { "$ref": "#/parameters/interface-rw" }, - { "$ref": "#/parameters/receiveruri" } - ], - "responses": { - "204": { - "description": "a receiver object was removed successfully\n" - } - } - } - }, - "/PushReceiverResURI?if=oic.if.baseline": { - "get": { - "description": "Resource that defines the receiver for Push Notifications", - "parameters": [ - { "$ref": "#/parameters/interface-baseline" } - ], - "responses": { - "200": { - "description": "", - "x-example": { - "rt": ["oic.r.pushreceiver"], - "if": ["oic.if.rw", "oic.if.baseline"], - "receivers": [ - { - "receiveruri": "/mylocaltargeturiforthermostats", - "rts": ["oic.r.temperature", "oic.r.humidity"] - }, - { - "receiveruri": "/mylocaltargeturifordontcare", - "rts": [] - } - ] - }, - "schema": { "$ref": "#/definitions/get-baseline-response" } - } - } - } - } - }, - "parameters": { - "interface-baseline": { - "in": "query", - "name": "if", - "type": "string", - "enum": ["oic.if.baseline"] - }, - "interface-rw": { - "in": "query", - "name": "if", - "type": "string", - "enum": ["oic.if.rw"] - }, - "receiveruri": { - "in": "query", - "name": "receiveruri", - "type": "string" - }, - "body-receiver-update": { - "in": "body", - "name": "receiver", - "required": true, - "schema": { - "$ref": "#/definitions/receiver" - }, - "x-example": { - "receiveruri": "/mylocaltargeturifordontcare", - "rts": [] - } - }, - "body-receivers-update": { - "in": "body", - "name": "receivers", - "required": true, - "schema": { - "$ref": "#/definitions/post-rw-request" - }, - "x-example": { - "receivers": [ - { - "receiveruri": "/mylocaltargeturifordontcare", - "rts": [] - }, - { - "receiveruri": "/mylocaltargeturifordontcare-2", - "rts": [] - } - ] - } - } - }, - "definitions": { - "receiver": { - "description": "a definition of URIs at which push payloads may be received", - "type": "object", - "properties": { - "receiveruri": { - "format": "uri", - "type": "string" - }, - "rts": { - "description": "The list of allowable Resource Types for this instance of a push receiver", - "type": "array", - "items": { - "type": "string", - "maxLength": 64 - }, - "minItems": 0 - } - }, - "required": ["receiveruri", "rts"] - }, - "receivers": { - "description": "Definitions of URIs at which push payloads may be received", - "type": "array", - "items": { - "$ref": "#/definitions/receiver" - }, - "minItems": 0 - }, - "get-rw-response": { - "type": "object", - "properties": { - "receivers": { - "$ref": "#/definitions/receivers" - } - }, - "required": ["receivers"] - }, - "get-baseline-response": { - "type": "object", - "properties": { - "rt": { - "type": "array", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": ["oic.r.pushreceiver"] - } - }, - "if": { - "description": "The OCF Interface set supported by this Resource", - "type": "array", - "minItems": 1, - "readOnly": true, - "items": { - "type": "string", - "maxLength": 64, - "enum": ["oic.if.rw", "oic.if.baseline"] - } - }, - "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" - }, - "receivers": { - "$ref": "#/definitions/receivers" - } - }, - "required": [ - "rt", "if", "receivers" - ] - }, - "post-rw-request": { - "type": "object", - "properties": { - "receivers": { - "$ref": "#/definitions/receivers" - } - }, - "required": ["receivers"] - } - } -}