Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 1.72 KB

README.md

File metadata and controls

27 lines (14 loc) · 1.72 KB

core

This repo contains the data models that are part of the OCF core specification. The latest version of which can be found at:

https://openconnectivity.org/specs/OCF_Core_Specification.pdf

referencing files with full URL

This repo uses the github pages feature. e.g. all files can be accessed by using the URL:

http://openconnectivityfoundation.github.io/core/

and then use the path and filename to retrieve the file by means of http(s). For example, the URL of the swagger file with rt type = oic.wk.p is:

http://openconnectivityfoundation.github.io/core/swagger2.0/oic.wk.p.swagger.json

The full url can be used to reference a property definition. For example to reference in a schema the definition of UUID defined in the schema file: oic.types-schema.json use:

"$ref": "http://openconnectivityfoundation.github.io/core/schemas/oic.types-schema.json#definitions/uuid"

Introspection examples

The examples folder contains two examples showing how Introspection Device Data (IDD) may be constructed for a Device.

introspectiondevicedataexample.swagger.json illustrates a simple device that exposes an instance of a Binary Switch Resource and an instance of a Brightness Resource

introspectiondevicedataexample.swagger.json illustrates a case where the Device supports the ability to create instances of Binary Switch and instances of Humidity via a Collection that exposes the "oic.if.create" OCF Interface.