├── README.md ├── schemas ├── oic.baseresource.properties-schema.json └── oic.genre.properties-schema.json ├── .github └── workflows │ └── validate.yml ├── IlluminanceSensorResURI.swagger.json ├── UVRadiationResURI.swagger.json ├── TouchResURI.swagger.json ├── soundPressureResURI.swagger.json ├── ButtonResURI.swagger.json ├── soundPressureLevelResURI.swagger.json ├── MotionResURI.swagger.json ├── SleepSensorResURI.swagger.json ├── EnergyGenerationResURI.swagger.json ├── PresenceResURI.swagger.json ├── GlassBreakResURI.swagger.json ├── UserIDResURI.swagger.json ├── ContactResURI.swagger.json ├── EnergyOverloadResURI.swagger.json ├── KeyCardSwitchResURI.swagger.json ├── UVBRadiationResURI.swagger.json ├── ThreeAxisResURI.swagger.json ├── ORFIDTagResURI.swagger.json ├── TimeStampResURI.swagger.json ├── UVARadiationResURI.swagger.json ├── CalorificValueResURI.swagger.json ├── HVACCapacityResURI.swagger.json ├── SignalStrengthResURI.swagger.json ├── MagneticFieldDirectionResURI.swagger.json ├── HeartRateZoneResURI.swagger.json ├── muscleoxygensaturation.swagger.json ├── EnergyConsumptionResURI.swagger.json ├── GlucoseTesterResURI.swagger.json ├── PulsatileOccurrence.swagger.json ├── ConversionFactorResURI.swagger.json ├── HeartRate.swagger.json ├── GasConsumptionResURI.swagger.json ├── GlucoseMealResURI.swagger.json ├── HeatingZoneResURI.swagger.json ├── Cadence.swagger.json ├── Torque.swagger.json ├── GlucoseHealthResURI.swagger.json ├── BodyLocationTemperatureResURI.swagger.json ├── PulseRateResURI.swagger.json ├── GlucoseSampleLocationResURI.swagger.json ├── ColourRenderingIndexResURI.swagger.json ├── Speed.swagger.json ├── VehicleConnectorResURI.swagger.json ├── AccelerationResURI.swagger.json ├── NightModeResURI.swagger.json ├── AltimeterResURI.swagger.json ├── BinarySwitchResURI.swagger.json ├── BMIResURI.swagger.json ├── AtmosphericPressureResURI.swagger.json ├── WaterResURI.swagger.json ├── AutomaticDocumentFeederResURI.swagger.json ├── ExerciseResURI.swagger.json ├── GlucoseHbA1cResURI.swagger.json ├── SmokeSensorResURI.swagger.json ├── ContinuousGlucoseMeterSensor.swagger.json ├── GenericSensorResURI.swagger.json ├── AutoFocusResURI.swagger.json ├── AutoWhiteBalanceResURI.swagger.json ├── CarbonDioxideResURI.swagger.json └── CarbonMonoxideResURI.swagger.json /README.md: -------------------------------------------------------------------------------- 1 | # Open Connectivity Foundatation | IoT Data Models 2 | © 2016-2022 Open Connectivity Foundatation. All rights reserved. 3 | 4 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 5 | 6 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 7 | 8 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 9 | 10 | THIS SOFTWARE IS PROVIDED BY THE OPEN CONNECTIVITY FOUNDATION "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE OR WARRANTIES OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE OPEN CONNECTIVITY FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 11 | 12 | The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, by the Open Connectivity Foundation. 13 | -------------------------------------------------------------------------------- /schemas/oic.baseresource.properties-schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "http://openconnectivityfoundation.github.io/IoTDataModels/oic.baseresource.properties-schema.json#", 3 | "$schema": "http://json-schema.org/draft-04/schema#", 4 | "description" : "Copyright (c) 2018-2019 Open Connectivity Foundation, Inc. All rights reserved.", 5 | "title": "Base Resource properties (resource specification)", 6 | "definitions": { 7 | "precision": { 8 | "type": "number", 9 | "readOnly": true, 10 | "description": "When exposed the value in 'precision' provides a +/- tolerance against the Properties in the Resource. Thus if a Property is UPDATED to a value and that Property then RETRIEVED, the RETRIEVED value is valid if in the range of the set value +/- precision" 11 | }, 12 | "range_integer": { 13 | "type": "array", 14 | "description": "The valid range for the Property in the Resource as an integer. The first value in the array is the minimum value, the second value in the array is the maximum value.", 15 | "readOnly": true, 16 | "minItems": 2, 17 | "maxItems": 2, 18 | "items": { 19 | "type": "integer" 20 | } 21 | }, 22 | "range_number": { 23 | "type": "array", 24 | "description": "The valid range for the Property in the Resource as a number. The first value in the array is the minimum value, the second value in the array is the maximum value.", 25 | "readOnly": true, 26 | "minItems": 2, 27 | "maxItems": 2, 28 | "items": { 29 | "type": "number" 30 | } 31 | }, 32 | "step_integer": { 33 | "description": "Step value across the defined range when the range is an integer. This is the increment for valid values across the range; so if range is 0..10 and step is 2 then valid values are 0,2,4,6,8,10.", 34 | "readOnly": true, 35 | "type": "integer" 36 | }, 37 | "step_number": { 38 | "description": "Step value across the defined range an integer when the range is a number. This is the increment for valid values across the range; so if range is 0.0..10.0 and step is 2.5 then valid values are 0.0,2.5,5.0,7.5,10.0.", 39 | "readOnly": true, 40 | "type": "number" 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /.github/workflows/validate.yml: -------------------------------------------------------------------------------- 1 | # This is a basic workflow to help you get started with Actions 2 | 3 | name: CI-validate 4 | 5 | # Controls when the action will run. Triggers the workflow on push or pull request 6 | # events but only for the master branch 7 | 8 | #outputs: 9 | # random-number: 10 | # description: "Random number" 11 | # value: ${{ steps.random-number-generator.outputs.random-id }} 12 | #runs: 13 | # using: "composite" 14 | # steps: 15 | # - id: random-number-generator 16 | # run: echo "::set-output name=random-id::$(echo $RANDOM)" 17 | # shell: bash 18 | 19 | on: 20 | push: 21 | branches: [ master ] 22 | pull_request: 23 | branches: [ master ] 24 | 25 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 26 | jobs: 27 | # This workflow contains a single job called "build" 28 | build: 29 | # The type of runner that the job will run on 30 | runs-on: ubuntu-latest 31 | 32 | # Steps represent a sequence of tasks that will be executed as part of the job 33 | steps: 34 | - name: Get Repo 35 | id: getrepo 36 | uses: actions/checkout@v2 37 | - name: Get OpenAPI files 38 | id: getfiles 39 | run: | 40 | # Using github env (newline separated file list) 41 | # find . -type f \( -iname ".*" ! -iname ".htaccess" \) 42 | # Refrige Refrigera 43 | echo 'FILE_LIST<> $GITHUB_ENV 44 | find . -type f -iname "*.swagger.json" ! -name '*BaseResourceS*' ! -name '*PulseOxi' ! -name 'Refrige*' ! -name '*AM.*' ! -iname '*AMResURI.*' ! -iname '*UsageResURI*' ! -iname 'EnergyRes*' ! -iname 'ValueCondi*' ! -iname 'AirFlowC*' ! -iname 'IASZo*' >> $GITHUB_ENV 45 | echo 'EOF' >> $GITHUB_ENV 46 | ## files not checked: 47 | find . -type f -name '*BaseResourceS*' 48 | find . -type f -name '*PulseOxi' 49 | find . -type f -name 'Refrige*' 50 | find . -type f -name '*AM.*' 51 | find . -type f -iname '*AMResURI.*' 52 | find . -type f -iname '*UsageResURI*' 53 | find . -type f -iname 'EnergyRes*' 54 | find . -type f -iname 'ValueCondi*' 55 | find . -type f -iname 'AirFlowC*' 56 | find . -type f -iname 'IASZo*' 57 | # Using step output (space separated file list) 58 | FILES="$(find . -type f -iname "*.json")" 59 | echo "::set-output name=file_list::$FILES" 60 | 61 | - name: swagger-validator 62 | #uses: mbowman100/swagger-validator-action@master 63 | uses: mbowman100/swagger-validator-action@2.0 64 | #'if: env.FILE_COUNT != '0' # Comment out if you want it to fail if no files found 65 | with: 66 | files: ${{ env.FILE_LIST }} 67 | #files: ${{ steps.getfiles.outputs.file_list }} # For if you're using output -------------------------------------------------------------------------------- /schemas/oic.genre.properties-schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.genre.properties-schema.json#", 3 | "$schema": "http://json-schema.org/draft-04/schema#", 4 | "description" : "Copyright (c) 2018 Open Connectivity Foundation, Inc. All rights reserved.", 5 | "title": "Genre for Media and Channel Information", 6 | "definitions": { 7 | "category": { 8 | "type": "string", 9 | "description": "Genre Category for Media and Channel Information.", 10 | "enum": ["Arts", "Books", "Education", "Hobbies", "Movie", "Music", "News", "Photography", "Show", "Social", "Special", "Sports", "Youth", "Other", "None"] 11 | }, 12 | "subcategory": { 13 | "type": "string", 14 | "description": "Genre Sub-Category for Media and Channel Information.", 15 | "enum": ["Movie", "Action", "Adventure", "Adult", "Animation", "Biography", "Classic", "Comedy", "Crime", "Documentary", "Drama", "Family", "Fantasy", "Fitness and health", "Foreign", "History", "Horror", "Musical", "Mystery", "Religion", "Romance", "Sci-Fi", "Short", "Super-hero", "Soap", "Thriller", "War", "Western", "Arts", "Broadcasting", "Cinema", "Culture", "Experimental film", "Fashion", "Film", "Fine art", "Literature", "News media", "Performing", "Popular culture", "Press", "Traditional", "Books", "Business", "Fiction", "Food", "Investing", "Memoirs", "Money", "Suspense", "Wine", "Education", "Animals", "Environment", "Expeditions", "Factual topics", "Further education", "Languages", "Magazines", "Medicine", "Nature", "Natural sciences", "Physiology", "Psychology", "Science", "Social sciences", "Spiritual sciences", "Technology", "Hobbies", "Advertisement", "Cooking", "Gardening", "Handicraft", "Motoring", "Shopping", "Tourism", "Travel", "Music", "Alternatives", "Ballet", "Blues", "Broadway", "Children", "Christian", "Classical", "Classic rock", "Country", "Dance", "Folk", "Gospel", "Hard Rock", "Hip-Hop", "Holiday", "Jazz", "Latin", "Metal", "New Age", "Opera", "Pop", "R&B", "Rap", "Rock", "Soundtrack", "Vocal", "World", "News", "Current affairs", "Debate", "Discussion", "Interview", "Weather report", "Photography", "Aerial", "Architectural", "Conceptual", "Candid", "Landscape", "Night-long exposure", "Photojournalism", "Portraiture", "Street", "Wildlife", "Show", "Contest", "Game", "Quiz", "Reality TV", "Talk", "Variety", "Sports", "Athletics", "Equestrian", "Football", "Martial", "Motor", "Soccer", "Special events", "Squash", "Team", "Tennis", "Water", "Winter", "Social issues", "Economics", "Economics advisory", "Political issues", "Remarkable people", "Reports", "Social advisory", "Original language", "Black and white", "Live broadcast", "Local or Regional", "Plano-stereoscopic", "Unpublished", "Youth", "Cartoon", "Children Pre-school", "Children 6 to 14", "Children 10 to 16", "Educational", "Informational", "Puppets", "School", "Other", "None"] 16 | } 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /IlluminanceSensorResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Illuminance Sensor", 5 | "version": "2019-08-08", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/IlluminanceSensorResURI": { 18 | "get": { 19 | "description": "This Resource describes an illuminance sensor.\nThe Property \"illuminance\" is a float and represents the sensed luminous flux per unit area in lux.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description": "", 26 | "x-example": { 27 | "rt": ["oic.r.sensor.illuminance"], 28 | "if": ["oic.if.s", "oic.if.baseline"], 29 | "illuminance": 450.0, 30 | "range": [100.0, 500.0] 31 | }, 32 | "schema": {"$ref": "#/definitions/Illuminance"} 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "Illuminance": { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.illuminance"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "illuminance": { 62 | "description": "The sensed luminous flux per unit area in lux.", 63 | "readOnly": true, 64 | "type": "number" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "range": { 73 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 74 | }, 75 | "if": { 76 | "description": "The OCF Interface set supported by this Resource.", 77 | "items": { 78 | "enum": [ 79 | "oic.if.s", 80 | "oic.if.baseline" 81 | ], 82 | "type": "string" 83 | }, 84 | "minItems": 2, 85 | "uniqueItems": true, 86 | "readOnly": true, 87 | "type": "array" 88 | } 89 | }, 90 | "type": "object", 91 | "required": ["illuminance"] 92 | } 93 | } 94 | } -------------------------------------------------------------------------------- /UVRadiationResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "UV Radiation", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/UVRadiationResURI" : { 18 | "get": { 19 | "description": "This Resource specifies UV radiation measurement.\nThe Property \"measurement\" is the current measured UV Index", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.radiation.uv"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "measurement": 3.5 31 | } 32 | , 33 | "schema": { "$ref": "#/definitions/UVRadiation" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface": { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "UVRadiation" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.sensor.radiation.uv"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "measurement": { 63 | "description": "The measured UV Index.", 64 | "readOnly": true, 65 | "type": "number" 66 | }, 67 | "n": { 68 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 69 | }, 70 | "id": { 71 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 72 | }, 73 | "if" : 74 | { 75 | "description": "The OCF Interface set supported by this Resource.", 76 | "items": { 77 | "enum": [ 78 | "oic.if.s", 79 | "oic.if.baseline" 80 | ], 81 | "type": "string" 82 | }, 83 | "minItems": 2, 84 | "uniqueItems": true, 85 | "readOnly": true, 86 | "type": "array" 87 | } 88 | }, 89 | "type": "object", 90 | "required": ["measurement"] 91 | } 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /TouchResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Touch Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/TouchResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether a touch has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that touch has been sensed.\nA value of 'false' means that touch not been sensed.\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.touch"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/Touch" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in" : "query", 41 | "name" : "if", 42 | "type" : "string", 43 | "enum" : ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "Touch" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.touch"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The touch sensor, true = sensed, false = not sensed.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["value"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /soundPressureResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Sound Pressure in Pascal", 5 | "version": "2020-09-01", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2020 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/SoundPressureResURI" : { 18 | "get": { 19 | "description": "This Resource describes a measured sound pressure in Pascal (pa).\n The Sound pressure is a property of the sound field at a point in space where the point is the actual location of the sensor.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": { 27 | "rt": ["oic.r.sound.pressure"], 28 | "if": ["oic.if.s", "oic.if.baseline"], 29 | "soundpa": 0.002 30 | }, 31 | "schema": { "$ref": "#/definitions/SoundPressure" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in": "query", 40 | "name": "if", 41 | "type": "string", 42 | "enum": ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "SoundPressure" : { 47 | "properties": { 48 | "rt": { 49 | "description": "The Resource Type.", 50 | "items": { 51 | "enum": ["oic.r.sound.pressure"], 52 | "maxLength": 64, 53 | "type": "string" 54 | }, 55 | "minItems": 1, 56 | "uniqueItems": true, 57 | "readOnly": true, 58 | "type": "array" 59 | }, 60 | "soundpa": { 61 | "description": "The sound pressure in pascal.", 62 | "type": "number", 63 | "readOnly": true, 64 | "minimum": 0 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["soundpa"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /ButtonResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Button Switch", 5 | "version": "2019-02-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/ButtonResURI" : { 18 | "get": { 19 | "description": "This Resource describes the operation of a button style switch.\nThe Property \"value\" is a boolean.\nA value of 'true' means that the button is being pushed/pressed.\nA value of 'false' means that the button is not being pushed/pressed.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.button"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | } 32 | , 33 | "schema": { "$ref": "#/definitions/Button" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface" : { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "Button" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.button"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "value": { 63 | "description": "The status of the button", 64 | "readOnly": true, 65 | "type": "boolean" 66 | }, 67 | "n": { 68 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 69 | }, 70 | "id": { 71 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 72 | }, 73 | "if": { 74 | "description": "The OCF Interface set supported by this Resource.", 75 | "items": { 76 | "enum": [ 77 | "oic.if.s", 78 | "oic.if.baseline" 79 | ], 80 | "type": "string" 81 | }, 82 | "minItems": 2, 83 | "uniqueItems": true, 84 | "readOnly": true, 85 | "type": "array" 86 | } 87 | }, 88 | "type": "object", 89 | "required": ["value"] 90 | } 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /soundPressureLevelResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Sound Pressure Level in dB", 5 | "version": "2020-09-01", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2020 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/SoundPressureLevelResURI" : { 18 | "get": { 19 | "description": "This Resource describes a measured sound pressure in dB.\n The Sound pressure is a property of the sound field at a point in space where the point is the actual location of the sensor.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": { 27 | "rt": ["oic.r.sound.pressurelevel"], 28 | "if": ["oic.if.s", "oic.if.baseline"], 29 | "sounddB": 40.3 30 | }, 31 | "schema": { "$ref": "#/definitions/SoundPressureLevel" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in": "query", 40 | "name": "if", 41 | "type": "string", 42 | "enum": ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "SoundPressureLevel" : { 47 | "properties": { 48 | "rt": { 49 | "description": "The Resource Type.", 50 | "items": { 51 | "enum": ["oic.r.sound.pressurelevel"], 52 | "maxLength": 64, 53 | "type": "string" 54 | }, 55 | "minItems": 1, 56 | "uniqueItems": true, 57 | "readOnly": true, 58 | "type": "array" 59 | }, 60 | "sounddB": { 61 | "description": "The sound pressure level in dB.", 62 | "type": "number", 63 | "readOnly": true, 64 | "minimum": 0 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["sounddB"] 89 | } 90 | } 91 | } -------------------------------------------------------------------------------- /MotionResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Motion Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/MotionResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether motion has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that motion has been sensed.\nA value of 'false' means that motion not been sensed.\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.motion"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/Motion" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in" : "query", 41 | "name" : "if", 42 | "type" : "string", 43 | "enum" : ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "Motion" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.motion"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The motion sensor, true = motion sensed, false = motion not sensed.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["value"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /SleepSensorResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Sleep Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/SleepSensorResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether human sleep has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that sleep has been sensed.\nA value of 'false' means that sleep not been sensed.\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.sleep"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/sleep" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "sleep" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.sleep"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The sleep sensor, true = sleep sensed, false = sleep not sensed.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["value"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /EnergyGenerationResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Energy Generation", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/EnergyGenerationResURI" : { 18 | "get": { 19 | "description": "This Resource describes the attributes associated with energy generation\nThe Property \"energygenerated\" is a number that provides the energy generated in Watt-hour(Wh).", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description": "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.energy.generation"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "energygenerated": 3000.00 31 | }, 32 | "schema": { "$ref": "#/definitions/EnergyGeneration" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in" : "query", 41 | "name" : "if", 42 | "type" : "string", 43 | "enum" : ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "EnergyGeneration" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.energy.generation"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "energygenerated": { 62 | "description": "The energy generated in Watt-hour(Wh).", 63 | "readOnly": true, 64 | "type": "number" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["energygenerated"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /PresenceResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Presence Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/PresenceResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether presence has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that presence has been sensed.\nA value of 'false' means that presence not been sensed.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.presence"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/Presence" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "Presence" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.presence"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The presences sensor, true = precense sensed, false = precensenot sensed.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["value"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /GlassBreakResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Glass Break Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/GlassBreakResURI" : { 18 | "get": { 19 | "description": "This Resource describes a glass break sensor.\nThe Property \"value\" is a boolean.\nA value of 'true' means that glass break has been sensed.\nA value of 'false' means that glass break not been sensed.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.glassbreak"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/GlassBreak" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "GlassBreak" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.glassbreak"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The glassbreak indication, true = glass break sensed, false = glass break not sensed.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["value"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /UserIDResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "User ID", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/UserIDResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with user id of an OCF Client.\nThe userid Property is a single value of type string.\nThe userid Property is a read-only value that is provided by the Server.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.userid" 37 | ], 38 | "userid": "USER1" 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/UserID" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.r", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "UserID": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.userid" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "userid": { 77 | "description": "Id of a patient/user of healthcare devices", 78 | "readOnly": true, 79 | "type": "string" 80 | }, 81 | "n": { 82 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 83 | }, 84 | "if": { 85 | "description": "The OCF Interface set supported by this Resource", 86 | "items": { 87 | "enum": [ 88 | "oic.if.r", 89 | "oic.if.baseline" 90 | ], 91 | "type": "string", 92 | "maxLength": 64 93 | }, 94 | "minItems": 1, 95 | "readOnly": true, 96 | "uniqueItems": true, 97 | "type": "array" 98 | } 99 | }, 100 | "type": "object", 101 | "required": [ 102 | "userid" 103 | ] 104 | } 105 | } 106 | } 107 | -------------------------------------------------------------------------------- /ContactResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Contact Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/ContactResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether a contact sensor has been tripped or not.\nTypical use case is in Security Systems detecting window or door open.\nThe Property \"value\" is a boolean.\nA value of 'true' means that contact has been broken (open).\nA value of 'false' means that contact is in place (closed).\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description": "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.contact"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/Contact" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "Contact" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.contact"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The contact indication, true = broken (open), false = in place (closed).", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["value"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /EnergyOverloadResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Energy Overload/Circuit Breaker", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/EnergyOverloadResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether an energy overload detector/circuit breaker is currently tripped.\nThe Property \"value\" is a boolean.\nA value of 'true' means that energy overload has been tripped.\nA value of 'false' means that energy overload has not been tripped.\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.energy.overload"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/EnergyOverload" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "EnergyOverload" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.energy.overload"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The energy overload indication,true = tripped, false = not tripped.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["value"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /KeyCardSwitchResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "KeyCard Switch", 5 | "version": "2019-08-07", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/KeyCardSwitchResURI" : { 18 | "get": { 19 | "description": "This Resource describes the operation of a KeyCard style switch. It has one mandatory Property,\"stateofcard\", which is a string enum type. It has two enum values: \"validCardInserted\", \"validCardNotInserted\". \"validCardInserted\" means that a keycard was inserted and passed validation check. \"validCardNotInserted\" means that a keycard is not inserted or it was inserted but failed to pass validation check.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.keycardswitch"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "stateofcard": "validCardInserted" 31 | } 32 | , 33 | "schema": { "$ref": "#/definitions/KeyCardSwitch" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface" : { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "KeyCardSwitch" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type of KeyCardSwitch", 52 | "items": { 53 | "enum": ["oic.r.keycardswitch"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "stateofcard": { 63 | "description": "The status of the keycardswitch. \"validCardInserted\" means that a keycard was inserted and passed validation check. \"validCardNotInserted\" means that a keycard is not inserted or it was inserted but failed to pass validation check.", 64 | "readOnly": true, 65 | "type": "string", 66 | "enum": [ 67 | "validCardInserted", 68 | "validCardNotInserted" 69 | ] 70 | }, 71 | "n": { 72 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 73 | }, 74 | "id": { 75 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 76 | }, 77 | "if": { 78 | "description": "The OCF Interface set supported by this Resource.", 79 | "items": { 80 | "enum": [ 81 | "oic.if.s", 82 | "oic.if.baseline" 83 | ], 84 | "type": "string" 85 | }, 86 | "minItems": 2, 87 | "uniqueItems": true, 88 | "readOnly": true, 89 | "type": "array" 90 | } 91 | }, 92 | "type": "object", 93 | "required": ["stateofcard"] 94 | } 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /UVBRadiationResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "UVB Radiation", 5 | "version": "2020-08-13", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2020 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/UVRadiationResURI" : { 18 | "get": { 19 | "description": "This Resource specifies UV radiation measurement.\nThe Property \"measurement\" is the current measured UVB. The intensity of UV radiation is measured in the units of milliwatts per square centimeter (mW/cm2) which is energy per square centimeter received per second. UVB is measured between 280 and 315 nanometers in the electromagnetic spectrum.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.radiation.uvb"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "measurement": 35.5 31 | } 32 | , 33 | "schema": { "$ref": "#/definitions/UVBRadiation" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface": { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "UVBRadiation" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.sensor.radiation.uvb"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "measurement": { 63 | "description": "The measured UVB.", 64 | "readOnly": true, 65 | "type": "number", 66 | "minimum": 0 67 | }, 68 | "n": { 69 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 70 | }, 71 | "id": { 72 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 73 | }, 74 | "if" : 75 | { 76 | "description": "The OCF Interface set supported by this Resource.", 77 | "items": { 78 | "enum": [ 79 | "oic.if.s", 80 | "oic.if.baseline" 81 | ], 82 | "type": "string" 83 | }, 84 | "minItems": 2, 85 | "uniqueItems": true, 86 | "readOnly": true, 87 | "type": "array" 88 | } 89 | }, 90 | "type": "object", 91 | "required": ["measurement"] 92 | } 93 | } 94 | } 95 | -------------------------------------------------------------------------------- /ThreeAxisResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Three Axis Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/ThreeAxisResURI" : { 18 | "get": { 19 | "description": "This Resource provides a representation of the measurement from a three-axis sensor.\nThe Property \"orientation\" is an array of numbers representing x-plane, y-plane and z-plane values.\nThe unit of measurement for each pane is 'g'.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.threeaxis"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "orientation": [0.7, 1.1, -0.2] 31 | }, 32 | "schema": { "$ref": "#/definitions/threeAxis" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "threeAxis" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.threeaxis"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "orientation": { 62 | "description": "The array containing x-plane, y-plane and z-plane orientation in 'g'.", 63 | "items": { 64 | "type": "number" 65 | }, 66 | "maxItems": 3, 67 | "minItems": 3, 68 | "readOnly": true, 69 | "type": "array" 70 | }, 71 | "n": { 72 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 73 | }, 74 | "id": { 75 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 76 | }, 77 | "if": { 78 | "description": "The OCF Interface set supported by this Resource.", 79 | "items": { 80 | "enum": [ 81 | "oic.if.s", 82 | "oic.if.baseline" 83 | ], 84 | "type": "string" 85 | }, 86 | "minItems": 2, 87 | "uniqueItems": true, 88 | "readOnly": true, 89 | "type": "array" 90 | } 91 | }, 92 | "type": "object", 93 | "required": ["orientation"] 94 | } 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /ORFIDTagResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Optical RFID Tag", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/ORFIDTagResURI" : { 18 | "get": { 19 | "description": "The Property \"tagid\" is an integer showing the currently read optical augmented RFID tag's identity information.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "RETRIEVES the tag information from optical augmented RFID reader in smart factory environment.", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.orfid.tag"], 29 | "if": ["oic.if.r", "oic.if.baseline"], 30 | "tagid": 10965742, 31 | "reading": true 32 | }, 33 | "schema": { "$ref": "#/definitions/ORFID" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface": { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.r", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "ORFID" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.orfid.tag"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "tagid": { 63 | "description": "The tag read by the RFID reader.", 64 | "readOnly": true, 65 | "type": "integer" 66 | }, 67 | "reading": { 68 | "description": "The reading indication. true: the tagid is read e.g. being valid. false: the tagid is invalid.", 69 | "readOnly": true, 70 | "type": "boolean" 71 | }, 72 | "n": { 73 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 74 | }, 75 | "id": { 76 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 77 | }, 78 | "if": { 79 | "description": "The OCF Interface set supported by this Resource.", 80 | "items": { 81 | "enum": [ 82 | "oic.if.r", 83 | "oic.if.baseline" 84 | ], 85 | "type": "string" 86 | }, 87 | "minItems": 2, 88 | "uniqueItems": true, 89 | "readOnly": true, 90 | "type": "array" 91 | } 92 | }, 93 | "type": "object", 94 | "required": ["tagid", "reading"] 95 | } 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /TimeStampResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Time Stamp", 5 | "version": "2019-03-27", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/TimeStampResURI" : { 18 | "get": { 19 | "description": "This Resource describes Properties associated with a timestamp.\nThe \"timestamp\" Property is a string that captures a timestamp using the RFC3339 datetime format (e.g: 2007-04-05T14:30Z) (Time+Date+Timezone).", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.time.stamp"], 29 | "if": ["oic.if.s", "oic.if.r", "oic.if.baseline"], 30 | "timestamp": "2015-11-05T14:30:00Z" 31 | }, 32 | "schema": { "$ref": "#/definitions/TimeStamp" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.r", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "TimeStamp" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.time.stamp"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "timestamp": { 62 | "description": "An RFC3339 formated time indicating when the data was observed (e.g.: 2016-02-15T09:19Z, 1996-12-19T16:39:57-08:00).", 63 | "format": "date-time", 64 | "readOnly": true, 65 | "type": "string" 66 | }, 67 | "n": { 68 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 69 | }, 70 | "id": { 71 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 72 | }, 73 | "if": { 74 | "description": "The OCF Interface set supported by this Resource.", 75 | "items": { 76 | "enum": [ 77 | "oic.if.s", 78 | "oic.if.r", 79 | "oic.if.baseline" 80 | ], 81 | "type": "string" 82 | }, 83 | "minItems": 2, 84 | "uniqueItems": true, 85 | "readOnly": true, 86 | "type": "array" 87 | } 88 | }, 89 | "type": "object", 90 | "required": ["timestamp"] 91 | } 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /UVARadiationResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "UVA Radiation", 5 | "version": "2020-08-13", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2020 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/UVRadiationResURI" : { 18 | "get": { 19 | "description": "This Resource specifies UV radiation measurement.\nThe Property \"measurement\" is the current measured UVA. The intensity of UV radiation is measured in the units of milliwatts per square centimeter (mW/cm2) which is energy per square centimeter received per second. UVA is measured between 315 and 400 nanometers in the electromagnetic spectrum.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.radiation.uva"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "measurement": 23.5 31 | } 32 | , 33 | "schema": { "$ref": "#/definitions/UVARadiation" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface": { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "UVARadiation" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.sensor.radiation.uva"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "measurement": { 63 | "description": "The measured UVA.", 64 | "readOnly": true, 65 | "type": "number", 66 | "minimum": 0 67 | }, 68 | "n": { 69 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 70 | }, 71 | "id": { 72 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 73 | }, 74 | "if" : 75 | { 76 | "description": "The OCF Interface set supported by this Resource.", 77 | "items": { 78 | "enum": [ 79 | "oic.if.s", 80 | "oic.if.baseline" 81 | ], 82 | "type": "string" 83 | }, 84 | "minItems": 2, 85 | "uniqueItems": true, 86 | "readOnly": true, 87 | "type": "array" 88 | } 89 | }, 90 | "type": "object", 91 | "required": ["measurement"] 92 | } 93 | } 94 | } -------------------------------------------------------------------------------- /CalorificValueResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Calorific Value", 5 | "version": "2019-03-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://openconnectivityfoundation.github.io/core/LICENSE.md", 9 | "x-copyright": "Copyright 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/CalorificValueResURI" : { 18 | "get": { 19 | "description": "This Resource describes Properties associated with the energy associated with the consumption of different fuels (including natural gas)\nThe calorific value is a number\nthe calorific value is a measure of the available heat energy, used as part of the calculation to convert a volume of a fuel (e.g. m3) to an energy value (e.g. KWh).\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "Success path response for the Resource", 26 | "x-example": { 27 | "rt": ["oic.r.calorificvalue"], 28 | "calorific": 39.2 29 | }, 30 | "schema": { "$ref": "#/definitions/Calorific" } 31 | } 32 | } 33 | } 34 | } 35 | }, 36 | "parameters": { 37 | "interface" : { 38 | "in" : "query", 39 | "name" : "if", 40 | "type" : "string", 41 | "enum" : ["oic.if.r", "oic.if.baseline"] 42 | } 43 | }, 44 | "definitions": { 45 | "Calorific" : { 46 | "properties": { 47 | "rt" : { 48 | "description": "Resource Type", 49 | "items": { 50 | "maxLength": 64, 51 | "type": "string", 52 | "enum": ["oic.r.calorificvalue"] 53 | }, 54 | "minItems": 1, 55 | "readOnly": true, 56 | "uniqueItems": true, 57 | "type": "array" 58 | }, 59 | "if" : { 60 | "description": "The OCF Interfaces supported by this Resource", 61 | "items": { 62 | "enum": ["oic.if.baseline", "oic.if.r"], 63 | "type": "string", 64 | "maxLength": 64 65 | }, 66 | "minItems": 2, 67 | "readOnly": true, 68 | "uniqueItems": true, 69 | "type": "array" 70 | }, 71 | "n": { 72 | "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 73 | }, 74 | "id": { 75 | "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 76 | }, 77 | "precision" : { 78 | "description": "Accuracy granularity of the exposed value", 79 | "readOnly": true, 80 | "type": "number" 81 | }, 82 | "calorific" : { 83 | "description": "Calorific value of fuel", 84 | "readOnly": true, 85 | "type": "number", 86 | "minimum": 0, 87 | "exclusiveMinimum": true 88 | } 89 | }, 90 | "type" : "object", 91 | "required": ["calorific"] 92 | } 93 | } 94 | } 95 | -------------------------------------------------------------------------------- /HVACCapacityResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "HVAC Capacity", 5 | "version": "2019-07-24", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/HVACCapacityResURI" : { 18 | "get": { 19 | "description": "This Resource describes the capacity (heating or cooling) of a HVAC system.\n \"capacity\" is a number in units of kW (kilowatts).\n To convert from kW to other units that may be commonly used in certain geographic locales the following conversions should be applied:\n - to convert to BTU/hr: BTU/hr = 3412.142 * kW\n - to convert to ton: ton = kW/3.5168525", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "RETRIEVES the current capacity.", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.hvac.capacity"], 29 | "if": ["oic.if.r", "oic.if.baseline"], 30 | "capacity": 2.5 31 | }, 32 | "schema": { "$ref": "#/definitions/capacity" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface": { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.r", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "capacity" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.hvac.capacity"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "capacity": { 62 | "description": "The rated capacity for the Device.", 63 | "minimum": 0, 64 | "exclusiveMinimum": true, 65 | "readOnly": true, 66 | "type": "number" 67 | }, 68 | "n": { 69 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 70 | }, 71 | "id": { 72 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 73 | }, 74 | "if": { 75 | "description": "The OCF Interface set supported by this Resource.", 76 | "items": { 77 | "enum": [ 78 | "oic.if.r", 79 | "oic.if.baseline" 80 | ], 81 | "type": "string" 82 | }, 83 | "minItems": 2, 84 | "uniqueItems": true, 85 | "readOnly": true, 86 | "type": "array" 87 | } 88 | }, 89 | "type": "object", 90 | "required": ["capacity"] 91 | } 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /SignalStrengthResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Signal Strength", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/SignalStrengthResURI" : { 18 | "get": { 19 | "description": "This Resource describes the strength of a signal by means of lqi and rssi.\nThe Property \"lqi\" is a floating point number that represents Link Quality Indicator.\nThe Property \"rssi\" is a floating point number that represents the received signal strength indicator.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.signalstrength"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "lqi": 10.0, 31 | "rssi": 55.0 32 | } 33 | , 34 | "schema": { "$ref": "#/definitions/SignalStrength" } 35 | } 36 | } 37 | } 38 | } 39 | }, 40 | "parameters": { 41 | "interface": { 42 | "in": "query", 43 | "name": "if", 44 | "type": "string", 45 | "enum": ["oic.if.s", "oic.if.baseline"] 46 | } 47 | }, 48 | "definitions": { 49 | "SignalStrength" : { 50 | "properties": { 51 | "rt": { 52 | "description": "The Resource Type.", 53 | "items": { 54 | "enum": ["oic.r.signalstrength"], 55 | "maxLength": 64, 56 | "type": "string" 57 | }, 58 | "minItems": 1, 59 | "uniqueItems": true, 60 | "readOnly": true, 61 | "type": "array" 62 | }, 63 | "lqi": { 64 | "description": "The current value of Link Quality Indicator.", 65 | "readOnly": true, 66 | "type": "number" 67 | }, 68 | "rssi": { 69 | "description": "The current value of Received Signal Strength Indicator.", 70 | "readOnly": true, 71 | "type": "number" 72 | }, 73 | "n": { 74 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 75 | }, 76 | "id": { 77 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 78 | }, 79 | "if": { 80 | "description": "The OCF Interface set supported by this Resource.", 81 | "items": { 82 | "enum": [ 83 | "oic.if.s", 84 | "oic.if.baseline" 85 | ], 86 | "type": "string" 87 | }, 88 | "minItems": 2, 89 | "uniqueItems": true, 90 | "readOnly": true, 91 | "type": "array" 92 | } 93 | }, 94 | "type": "object", 95 | "required": ["lqi", "rssi"] 96 | } 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /MagneticFieldDirectionResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Magnetic Field Direction Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/MagneticFieldDirectionResURI" : { 18 | "get": { 19 | "description": "This Resource describes the direction of the Earth's magnetic field at the observer's current point in space.\nTypical use case includes measurement of compass readings on a personal device.\nThe Property \"value\" is an array containing Hx, Hy, Hz (in that order) each of which are floats.\nEach of Hx, Hy and Hz are expressed in A/m (Amperes per metre).", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.magneticfielddirection"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "value": [100.0, 15.0, 90.0] 31 | }, 32 | "schema": { "$ref": "#/definitions/magneticFieldDirection" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in" : "query", 41 | "name" : "if", 42 | "type" : "string", 43 | "enum" : ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "magneticFieldDirection" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.magneticfielddirection"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The array containing Hx, Hy, Hz.", 63 | "items": { 64 | "type": "number" 65 | }, 66 | "maxItems": 3, 67 | "minItems": 3, 68 | "readOnly": true, 69 | "type": "array" 70 | }, 71 | "n": { 72 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 73 | }, 74 | "id": { 75 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 76 | }, 77 | "if": { 78 | "description": "The OCF Interface set supported by this Resource.", 79 | "items": { 80 | "enum": [ 81 | "oic.if.s", 82 | "oic.if.baseline" 83 | ], 84 | "type": "string" 85 | }, 86 | "minItems": 2, 87 | "uniqueItems": true, 88 | "readOnly": true, 89 | "type": "array" 90 | } 91 | }, 92 | "type": "object", 93 | "required": ["value"] 94 | } 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /HeartRateZoneResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Heart Rate Zone", 5 | "version": "2019-03-28", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/HeartRateZoneResURI" : { 18 | "get": { 19 | "description": "This Resource describes a measured heart rate by the current Zone using the Zoladz method. The Zoladz method defines Zones based on maximum heart rate; Zone 1 is the lowest, Zone 5 is the highest.\nThe heartRateZone is an enumeration containing one of: \"Zone1\", \"Zone2\", \"Zone3\", \"Zone4\", and \"Zone5\".\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.heart.zone"], 29 | "heartRateZone": "Zone3" 30 | }, 31 | "schema": { "$ref": "#/definitions/heartRateZone" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in" : "query", 40 | "name" : "if", 41 | "type" : "string", 42 | "enum" : ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "heartRateZone" : { 47 | "properties": { 48 | "rt": { 49 | "description": "Resource Type", 50 | "items": { 51 | "enum": ["oic.r.sensor.heart.zone"], 52 | "maxLength": 64, 53 | "type": "string" 54 | }, 55 | "minItems": 1, 56 | "readOnly": true, 57 | "uniqueItems": true, 58 | "type": "array" 59 | }, 60 | "n": { 61 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 62 | }, 63 | "id": { 64 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 65 | }, 66 | "heartRateZone": { 67 | "description": "Current heart rate zone based on the Zoladz system.", 68 | "enum": [ 69 | "Zone1", 70 | "Zone2", 71 | "Zone3", 72 | "Zone4", 73 | "Zone5" 74 | ], 75 | "readOnly": true, 76 | "type": "string" 77 | }, 78 | "if": { 79 | "description": "The OCF Interface set supported by this Resource", 80 | "items": { 81 | "enum": [ 82 | "oic.if.s", 83 | "oic.if.baseline" 84 | ], 85 | "type": "string", 86 | "maxLength": 64 87 | }, 88 | "minItems": 1, 89 | "readOnly": true, 90 | "uniqueItems": true, 91 | "type": "array" 92 | } 93 | }, 94 | "type" : "object", 95 | "required": ["heartRateZone"] 96 | } 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /muscleoxygensaturation.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Muscle Oxygen Saturation", 5 | "version": "2019-08-20", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/MuscleOxygenSaturationResURI": { 24 | "get": { 25 | "description": "This Resource describes the muscle oxygen saturation (SmO2), which is the percentage of hemoglobin that is saturated with oxygen in the capillaries of a muscle.\n The unit is percentage.\n The smo2 Property is a read-only value that is provided by the server.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.muscleoxygensaturation" 37 | ], 38 | "muscleoxygensaturation": 80.0 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/MuscleOxygenSaturation" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "MuscleOxygenSaturation": { 61 | "properties": { 62 | "muscleoxygensaturation": { 63 | "description": "This Property describes the muscle oxygen saturation (SmO2), which is the percentage of hemoglobin that is saturated with oxygen in the capillaries of a muscle. The unit is percentage.", 64 | "type": "number", 65 | "minimum": 0, 66 | "maximum": 100, 67 | "readOnly": true 68 | }, 69 | "rt": { 70 | "description": "The Resource Type.", 71 | "items": { 72 | "enum": [ 73 | "oic.r.muscleoxygensaturation" 74 | ], 75 | "type": "string" 76 | }, 77 | "minItems": 1, 78 | "uniqueItems": true, 79 | "readOnly": true, 80 | "type": "array" 81 | }, 82 | "n": { 83 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 84 | }, 85 | "if": { 86 | "description": "The OCF Interface set supported by this Resource.", 87 | "items": { 88 | "enum": [ 89 | "oic.if.s", 90 | "oic.if.baseline" 91 | ], 92 | "type": "string" 93 | }, 94 | "minItems": 1, 95 | "uniqueItems": true, 96 | "readOnly": true, 97 | "type": "array" 98 | } 99 | }, 100 | "type": "object", 101 | "required": [ 102 | "muscleoxygensaturation" 103 | ] 104 | } 105 | } 106 | } -------------------------------------------------------------------------------- /EnergyConsumptionResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Energy Consumption", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/EnergyConsumptionResURI" : { 18 | "get": { 19 | "description": "This Resource describes the energy consumed by the Device since power up (the energy value is in Watt Hours [Wh]) \nand the instantaneous power draw of the device (the power value is in Watts [W]) at the time the resource was queried.\nThe Property \"power\" value is in Watts [W].\nThe Property \"energy\" value is in Watt Hours [Wh].\nThe Resource provides the current power draw and cumulative energy usage.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.energy.consumption"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "power": 2000.1, 31 | "energy": 3500.4 32 | }, 33 | "schema": { "$ref": "#/definitions/Consumption" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface" : { 41 | "in" : "query", 42 | "name" : "if", 43 | "type" : "string", 44 | "enum" : ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "Consumption" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.energy.consumption"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "power": { 63 | "description": "The instantaneous Power.", 64 | "readOnly": true, 65 | "type": "number" 66 | }, 67 | "energy": { 68 | "description": "The energy consumed.", 69 | "readOnly": true, 70 | "type": "number" 71 | }, 72 | "n": { 73 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 74 | }, 75 | "id": { 76 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 77 | }, 78 | "if": { 79 | "description": "The OCF Interface set supported by this Resource.", 80 | "items": { 81 | "enum": [ 82 | "oic.if.s", 83 | "oic.if.baseline" 84 | ], 85 | "type": "string" 86 | }, 87 | "minItems": 2, 88 | "uniqueItems": true, 89 | "readOnly": true, 90 | "type": "array" 91 | } 92 | }, 93 | "type": "object", 94 | "required": ["power", "energy"] 95 | } 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /GlucoseTesterResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Context Tester for Glucose Meter", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/GlucoseTesterResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with context tester.\nThe tester Property is a read-only value that is provided by the Server where especially\nhcp stands for HealthCare Professional.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.glucose.tester" 37 | ], 38 | "tester": "self" 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/GlucoseTester" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.r", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "GlucoseTester": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.glucose.tester" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "tester": { 77 | "description": "The possible cases of testers who may perform the blood sugar measurement.", 78 | "enum": [ 79 | "self", 80 | "hcp", 81 | "lab" 82 | ], 83 | "readOnly": true, 84 | "type": "string" 85 | }, 86 | "n": { 87 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 88 | }, 89 | "id": { 90 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 91 | }, 92 | "if": { 93 | "description": "The OCF Interface set supported by this Resource", 94 | "items": { 95 | "enum": [ 96 | "oic.if.r", 97 | "oic.if.baseline" 98 | ], 99 | "type": "string", 100 | "maxLength": 64 101 | }, 102 | "minItems": 1, 103 | "readOnly": true, 104 | "uniqueItems": true, 105 | "type": "array" 106 | } 107 | }, 108 | "type": "object", 109 | "required": [ 110 | "tester" 111 | ] 112 | } 113 | } 114 | } 115 | -------------------------------------------------------------------------------- /PulsatileOccurrence.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Pulsatile Occurrence for Pulse Oximeter", 5 | "version": "2019-03-04", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/PulsatileOccurrenceResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with a Pulsatile Occurrence detected by a Pulse Oximeter.\n The occurrence Property is a read-only value that is provided by the server.\n When range (from \"oic.r.baseresource\") is omitted the default is 0 to +MAXFLOAT.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.pulsatileoccurrence" 37 | ], 38 | "occurrence": "BEAT" 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/pulsatileoccurrence" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "pulsatileoccurrence": { 61 | "properties": { 62 | "occurrence": { 63 | "type": "string", 64 | "readOnly": true, 65 | "enum": [ 66 | "BEAT", 67 | "BEAT_MAX_INRUSH", 68 | "NOS" 69 | ], 70 | "description": "This Property describes the Pulsatile Occurrence detected by a Pulse Oximeter. BEAT - Pulsatile occurrence has occurred. BEAT_MAX_INRUSH - Maximal inrush of the pulsatile wave has occurred. NOS - No pulsatile event occurred.", 71 | "default": "NOS" 72 | }, 73 | "rt": { 74 | "description": "The Resource Type.", 75 | "items": { 76 | "enum": [ 77 | "oic.r.pulsatileoccurrence" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 1, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | }, 86 | "n": { 87 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 88 | }, 89 | "if": { 90 | "description": "The OCF Interface set supported by this Resource.", 91 | "items": { 92 | "enum": [ 93 | "oic.if.s", 94 | "oic.if.baseline" 95 | ], 96 | "type": "string" 97 | }, 98 | "minItems": 1, 99 | "uniqueItems": true, 100 | "readOnly": true, 101 | "type": "array" 102 | } 103 | }, 104 | "type": "object", 105 | "required": [ 106 | "occurrence" 107 | ] 108 | } 109 | } 110 | } -------------------------------------------------------------------------------- /ConversionFactorResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Conversion Factor", 5 | "version": "2019-03-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://openconnectivityfoundation.github.io/core/LICENSE.md", 9 | "x-copyright": "Copyright 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/ConversionFactorResURI" : { 18 | "get": { 19 | "description": "This Resource describes Properties associated with the energy associated with the consumption of different fuels (including natural gas)\nThe conversion factor is a number used as part of the calculation to convert gas volume to gas energy. The value used for this calculation is generally defined by local regulations and the conversion factor resource is therefore configurable.\nProvides the conversion factor used/required as part of the calculation to convert from fuel volume (m3) to fuel energy (kWh).\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "Success path response for the Resource", 26 | "x-example": { 27 | "rt": ["oic.r.conversionfactor"], 28 | "conversion": 1.02264 29 | }, 30 | "schema": { "$ref": "#/definitions/Conversion" } 31 | } 32 | } 33 | } 34 | } 35 | }, 36 | "parameters": { 37 | "interface" : { 38 | "in" : "query", 39 | "name" : "if", 40 | "type" : "string", 41 | "enum" : ["oic.if.r", "oic.if.baseline"] 42 | } 43 | }, 44 | "definitions": { 45 | "Conversion" : { 46 | "properties": { 47 | "rt" : { 48 | "description": "Resource Type", 49 | "items": { 50 | "maxLength": 64, 51 | "type": "string", 52 | "enum": ["oic.r.conversionfactor"] 53 | }, 54 | "minItems": 1, 55 | "readOnly": true, 56 | "uniqueItems": true, 57 | "type": "array" 58 | }, 59 | "if" : { 60 | "description": "The OCF Interfaces supported by this Resource", 61 | "items": { 62 | "enum": [ 63 | "oic.if.r", 64 | "oic.if.baseline" 65 | ], 66 | "type": "string", 67 | "maxLength": 64 68 | }, 69 | "minItems": 2, 70 | "readOnly": true, 71 | "uniqueItems": true, 72 | "type": "array" 73 | }, 74 | "n": { 75 | "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 76 | }, 77 | "id": { 78 | "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 79 | }, 80 | "conversion" : { 81 | "description": "Conversion factor to convert a volume of a fuel to energy consumption", 82 | "readOnly": true, 83 | "type": "number", 84 | "minimum": 0, 85 | "exclusiveMinimum": true 86 | }, 87 | "precision" : { 88 | "description": "Accuracy granularity of the exposed value", 89 | "readOnly": true, 90 | "type": "number" 91 | } 92 | }, 93 | "type" : "object", 94 | "required": ["conversion"] 95 | } 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /HeartRate.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Heart Rate", 5 | "version": "2019-03-04", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/HeartRateResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with a person's heart rate.\n The unit, which is the default unit, is bpm.\n The heartrate Property is a read-only value that is provided by the server.\n When range (from \"oic.r.baseresource\") is omitted the default is 0 to +MAXFLOAT.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.heartrate" 37 | ], 38 | "heartrate": 80 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/HeartRate" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "HeartRate": { 61 | "properties": { 62 | "heartrate": { 63 | "description": "This Property describes the heart rate in bpm.", 64 | "type": "integer", 65 | "minimum": 0, 66 | "readOnly": true 67 | }, 68 | "rt": { 69 | "description": "The Resource Type.", 70 | "items": { 71 | "enum": [ 72 | "oic.r.heartrate" 73 | ], 74 | "type": "string" 75 | }, 76 | "minItems": 1, 77 | "uniqueItems": true, 78 | "readOnly": true, 79 | "type": "array" 80 | }, 81 | "n": { 82 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 83 | }, 84 | "if": { 85 | "description": "The OCF Interface set supported by this Resource.", 86 | "items": { 87 | "enum": [ 88 | "oic.if.s", 89 | "oic.if.baseline" 90 | ], 91 | "type": "string" 92 | }, 93 | "minItems": 1, 94 | "uniqueItems": true, 95 | "readOnly": true, 96 | "type": "array" 97 | }, 98 | "range": { 99 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_integer" 100 | }, 101 | "step": { 102 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_integer" 103 | } 104 | }, 105 | "type": "object", 106 | "required": [ 107 | "heartrate" 108 | ] 109 | } 110 | } 111 | } -------------------------------------------------------------------------------- /GasConsumptionResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Gas Consumption", 5 | "version": "2019-03-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://openconnectivityfoundation.github.io/core/LICENSE.md", 9 | "x-copyright": "Copyright 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/GasConsumptionResURI" : { 18 | "get": { 19 | "description": "This Resource describes Properties associated with the energy associated with the consumption of natural gas\nThe gas value is in kilowatt hours [kWh].\nThe volume value is in metres cubed [m3].\nProvides the cumulative gas energy, the cumulative gas volume and the calorific value and conversion factor used/required to convert from gas volume (m3[TB1]) to gas energy (KWh).\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "Success path response for the Resource", 26 | "x-example": { 27 | "rt": ["oic.r.gas.consumption"], 28 | "gas": 11135.41, 29 | "volume": 1000.0 30 | }, 31 | "schema": { "$ref": "#/definitions/Consumption" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in" : "query", 40 | "name" : "if", 41 | "type" : "string", 42 | "enum" : ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "Consumption" : { 47 | "properties": { 48 | "rt": { 49 | "description": "Resource Type", 50 | "items": { 51 | "maxLength": 64, 52 | "type": "string", 53 | "enum": ["oic.r.gas.consumption"] 54 | }, 55 | "minItems": 1, 56 | "uniqueItems": true, 57 | "readOnly": true, 58 | "type": "array" 59 | }, 60 | "if": { 61 | "description": "The OCF Interfaces supported by this Resource", 62 | "items": { 63 | "enum": ["oic.if.r", "oic.if.baseline"], 64 | "type": "string" 65 | }, 66 | "minItems": 1, 67 | "readOnly": true, 68 | "uniqueItems": true, 69 | "type": "array" 70 | }, 71 | "n": { 72 | "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 73 | }, 74 | "id": { 75 | "$ref" : "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 76 | }, 77 | "gas" : { 78 | "description": "gas energy consumed in kWh", 79 | "readOnly": true, 80 | "type": "number", 81 | "minimum": 0 82 | }, 83 | "precision" : { 84 | "description": "Accuracy granularity of the exposed value", 85 | "readOnly": true, 86 | "type": "number" 87 | }, 88 | "volume" : { 89 | "description": "gas volume consumed in m3 (metres cubed)", 90 | "readOnly": true, 91 | "type": "number", 92 | "minimum": 0 93 | } 94 | }, 95 | "type" : "object", 96 | "required": ["gas"] 97 | } 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /GlucoseMealResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Context Meal for Glucose Meter", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/GlucoseMealResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with context meal.\nPreprandial means pre-meal.\nPostprandial means post-meal.\nFasting means the effect of long-term absence of food intake (overnight).\nThe meal Property is a read-only value that is provided by the Server.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.glucose.meal" 37 | ], 38 | "meal": "preprandial" 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/GlucoseMeal" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "GlucoseMeal": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.glucose.meal" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "meal": { 77 | "description": "Time of day when the measurement is taken.", 78 | "enum": [ 79 | "preprandial", 80 | "postprandial", 81 | "fasting", 82 | "bedtime", 83 | "casual" 84 | ], 85 | "readOnly": true, 86 | "type": "string" 87 | }, 88 | "n": { 89 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 90 | }, 91 | "id": { 92 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 93 | }, 94 | "if": { 95 | "description": "The OCF Interface set supported by this Resource", 96 | "items": { 97 | "enum": [ 98 | "oic.if.s", 99 | "oic.if.baseline" 100 | ], 101 | "type": "string", 102 | "maxLength": 64 103 | }, 104 | "minItems": 1, 105 | "readOnly": true, 106 | "uniqueItems": true, 107 | "type": "array" 108 | } 109 | }, 110 | "type": "object", 111 | "required": [ 112 | "meal" 113 | ] 114 | } 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /HeatingZoneResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Heating Zone", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/HeatingZoneResURI" : { 18 | "get": { 19 | "description": "This Resource provides information about the status of a (single) heating zone of a Cook-Top.\nIt describes the case of a Cook-Top whose zones can be activated dynamically (i.e. the device implements pot recognition).\nThe Property \"maxheatinglevel\" defines the max level for the heating zone\nThe Property \"heatinglevel\" is the current heating level of the zone\n For each element, the value range is from 0 (indication that the zone is not heating) to \"maxheatinglevel\".", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "RETRIEVES the current heating zone information.", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.heatingzone"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "maxheatinglevel": 6, 31 | "heatinglevel": 0 32 | }, 33 | "schema": { "$ref": "#/definitions/HeatingZone" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface": { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "HeatingZone" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.heatingzone"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "heatinglevel": { 63 | "description": "The current heating level for the zone.", 64 | "readOnly": true, 65 | "type": "integer" 66 | }, 67 | "maxheatinglevel": { 68 | "description": "The maximum heating level for the zone.", 69 | "readOnly": true, 70 | "type": "integer" 71 | }, 72 | "n": { 73 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 74 | }, 75 | "id": { 76 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 77 | }, 78 | "if": { 79 | "description": "The OCF Interface set supported by this Resource.", 80 | "items": { 81 | "enum": [ 82 | "oic.if.s", 83 | "oic.if.baseline" 84 | ], 85 | "type": "string" 86 | }, 87 | "minItems": 2, 88 | "uniqueItems": true, 89 | "readOnly": true, 90 | "type": "array" 91 | } 92 | }, 93 | "type": "object", 94 | "required": ["maxheatinglevel", "heatinglevel"] 95 | } 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /Cadence.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Cadence", 5 | "version": "2019-06-11", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/CadenceResURI": { 24 | "get": { 25 | "description": "This Resource describes the cadence, which is the number of revolutions of crank per minute when cyclists pedal the pedals.\n The unit, which is the default unit, is rpm.\n The cadence Property is a read-only value that is provided by the server.\n When range (from \"oic.r.baseresource\") is omitted the default is 0 to +MAXFLOAT.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.cadence" 37 | ], 38 | "cadence": 60 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/Cadence" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "Cadence": { 61 | "properties": { 62 | "cadence": { 63 | "description": "This Property describes the rate at which a cyclist is pedalling/turning the pedals.", 64 | "type": "integer", 65 | "minimum": 0, 66 | "readOnly": true 67 | }, 68 | "rt": { 69 | "description": "The Resource Type.", 70 | "items": { 71 | "enum": [ 72 | "oic.r.cadence" 73 | ], 74 | "type": "string" 75 | }, 76 | "minItems": 1, 77 | "uniqueItems": true, 78 | "readOnly": true, 79 | "type": "array" 80 | }, 81 | "n": { 82 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 83 | }, 84 | "if": { 85 | "description": "The OCF Interface set supported by this Resource.", 86 | "items": { 87 | "enum": [ 88 | "oic.if.s", 89 | "oic.if.baseline" 90 | ], 91 | "type": "string" 92 | }, 93 | "minItems": 1, 94 | "uniqueItems": true, 95 | "readOnly": true, 96 | "type": "array" 97 | }, 98 | "range": { 99 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_integer" 100 | }, 101 | "step": { 102 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_integer" 103 | } 104 | }, 105 | "type": "object", 106 | "required": [ 107 | "cadence" 108 | ] 109 | } 110 | } 111 | } -------------------------------------------------------------------------------- /Torque.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Torque", 5 | "version": "2019-09-25", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/TorqueResURI": { 24 | "get": { 25 | "description": "This Resource describes the torque, which is the rotational equivalent of linear force.\n The unit, which is the default SI unit, is N*m (Newton metre).\n The torque Property is a read-only value that is provided by the server.\n When range (from \"oic.r.baseresource\") is omitted the default is 0 to +MAXFLOAT.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.torque" 37 | ], 38 | "torque": 10.0 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/Torque" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "Torque": { 61 | "properties": { 62 | "torque": { 63 | "description": "This Resource describes the torque, which is the rotational equivalent of linear force, in N*m (Newton metre).", 64 | "type": "number", 65 | "minimum": 0.0, 66 | "readOnly": true 67 | }, 68 | "rt": { 69 | "description": "The Resource Type.", 70 | "items": { 71 | "enum": [ 72 | "oic.r.torque" 73 | ], 74 | "type": "string" 75 | }, 76 | "minItems": 1, 77 | "uniqueItems": true, 78 | "readOnly": true, 79 | "type": "array" 80 | }, 81 | "n": { 82 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 83 | }, 84 | "if": { 85 | "description": "The OCF Interface set supported by this Resource.", 86 | "items": { 87 | "enum": [ 88 | "oic.if.s", 89 | "oic.if.baseline" 90 | ], 91 | "type": "string" 92 | }, 93 | "minItems": 1, 94 | "uniqueItems": true, 95 | "readOnly": true, 96 | "type": "array" 97 | }, 98 | "range": { 99 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 100 | }, 101 | "step": { 102 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 103 | } 104 | }, 105 | "type": "object", 106 | "required": [ 107 | "torque" 108 | ] 109 | } 110 | } 111 | } -------------------------------------------------------------------------------- /GlucoseHealthResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Context Health for Glucose Meter", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/GlucoseHealthResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with context health.\nThe health Property is a read-only value that is provided by the Server where\nminor and major are related to the general health or the level of illness of the person;\nmenses refers to the female menstrual cycle;\nstress refers to physiological or psychological stress.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.glucose.health" 37 | ], 38 | "health": "major" 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/GlucoseHealth" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "GlucoseHealth": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.glucose.health" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "readOnly": true, 73 | "type": "array" 74 | }, 75 | "health": { 76 | "description": "The various levels of health a person feels when taking a glucose.", 77 | "enum": [ 78 | "minor", 79 | "major", 80 | "menses", 81 | "stress", 82 | "none" 83 | ], 84 | "readOnly": true, 85 | "type": "string" 86 | }, 87 | "n": { 88 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 89 | }, 90 | "id": { 91 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 92 | }, 93 | "if": { 94 | "description": "The OCF Interface set supported by this Resource", 95 | "items": { 96 | "enum": [ 97 | "oic.if.s", 98 | "oic.if.baseline" 99 | ], 100 | "type": "string", 101 | "maxLength": 64 102 | }, 103 | "minItems": 1, 104 | "readOnly": true, 105 | "uniqueItems": true, 106 | "type": "array" 107 | } 108 | }, 109 | "type": "object", 110 | "required": [ 111 | "health" 112 | ] 113 | } 114 | } 115 | } 116 | -------------------------------------------------------------------------------- /BodyLocationTemperatureResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Body Location Temperature", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/BodyLocationTemperatureResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with body location for temperature measurement of a person.\nThe bloc Property is a read-only value that is provided by the Server.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.body.location.temperature" 37 | ], 38 | "bloc": "ear" 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/BodyLocationTemperature" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "BodyLocationTemperature": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.body.location.temperature" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "bloc": { 77 | "description": "A list specific to temperature site", 78 | "enum": [ 79 | "axillary", 80 | "body", 81 | "ear", 82 | "finger", 83 | "gitract", 84 | "mouth", 85 | "rectum", 86 | "toe", 87 | "tympanum" 88 | ], 89 | "readOnly": true, 90 | "type": "string" 91 | }, 92 | "n": { 93 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 94 | }, 95 | "id": { 96 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 97 | }, 98 | "if": { 99 | "description": "The OCF Interface set supported by this Resource", 100 | "items": { 101 | "enum": [ 102 | "oic.if.s", 103 | "oic.if.baseline" 104 | ], 105 | "type": "string", 106 | "maxLength": 64 107 | }, 108 | "minItems": 1, 109 | "readOnly": true, 110 | "uniqueItems": true, 111 | "type": "array" 112 | } 113 | }, 114 | "type": "object", 115 | "required": [ 116 | "bloc" 117 | ] 118 | } 119 | } 120 | } 121 | -------------------------------------------------------------------------------- /PulseRateResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Pulse Rate", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/PulseRateResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with a person's pulse rate.\nThe unit, which is the default unit, is bpm.\nThe pulserate and unit Properties are read-only values that are provided by the Server.\nWhen range is omitted the default is 0 to +MAXFLOAT.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.pulserate" 37 | ], 38 | "pulserate": 80, 39 | "range": [20, 220], 40 | "step": 1 41 | }, 42 | "schema": { 43 | "$ref": "#/definitions/PulseRate" 44 | } 45 | } 46 | } 47 | } 48 | } 49 | }, 50 | "parameters": { 51 | "interface": { 52 | "in": "query", 53 | "name": "if", 54 | "type": "string", 55 | "enum": [ 56 | "oic.if.s", 57 | "oic.if.baseline" 58 | ] 59 | } 60 | }, 61 | "definitions": { 62 | "PulseRate": { 63 | "properties": { 64 | "rt": { 65 | "description": "Resource Type", 66 | "items": { 67 | "enum": [ 68 | "oic.r.pulserate" 69 | ], 70 | "type": "string", 71 | "maxLength": 64 72 | }, 73 | "minItems": 1, 74 | "uniqueItems": true, 75 | "readOnly": true, 76 | "type": "array" 77 | }, 78 | "pulserate": { 79 | "description": "Pulse rate in bpm.", 80 | "minimum": 0, 81 | "readOnly": true, 82 | "type": "integer" 83 | }, 84 | "if": { 85 | "description": "The OCF Interface set supported by this Resource", 86 | "items": { 87 | "enum": [ 88 | "oic.if.s", 89 | "oic.if.baseline" 90 | ], 91 | "type": "string", 92 | "maxLength": 64 93 | }, 94 | "minItems": 1, 95 | "readOnly": true, 96 | "uniqueItems": true, 97 | "type": "array" 98 | }, 99 | "range": { 100 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_integer" 101 | }, 102 | "step": { 103 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_integer" 104 | }, 105 | "n": { 106 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 107 | } 108 | }, 109 | "type": "object", 110 | "required": [ 111 | "pulserate" 112 | ] 113 | } 114 | } 115 | } 116 | -------------------------------------------------------------------------------- /GlucoseSampleLocationResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Context Sample Location for Glucose Meter", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/GlucoseSampleLocationResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with context sample Location.\nAST means Alternative Site Test specifying that the location of test performed was from an alternative site on the body.\nThe samplelocation Property is a read-only value that is provided by the Server.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.glucose.samplelocation" 37 | ], 38 | "samplelocation": "finger" 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/GlucoseSampleLocation" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.r", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "GlucoseSampleLocation": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.glucose.samplelocation" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "samplelocation": { 77 | "description": "The possible blood locations where the blood sample may be taken.", 78 | "enum": [ 79 | "finger", 80 | "ast", 81 | "earlobe", 82 | "ctrlsolution" 83 | ], 84 | "readOnly": true, 85 | "type": "string" 86 | }, 87 | "n": { 88 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 89 | }, 90 | "id": { 91 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 92 | }, 93 | "if": { 94 | "description": "The OCF Interface set supported by this Resource", 95 | "items": { 96 | "enum": [ 97 | "oic.if.r", 98 | "oic.if.baseline" 99 | ], 100 | "type": "string", 101 | "maxLength": 64 102 | }, 103 | "minItems": 1, 104 | "readOnly": true, 105 | "uniqueItems": true, 106 | "type": "array" 107 | } 108 | }, 109 | "type": "object", 110 | "required": [ 111 | "samplelocation" 112 | ] 113 | } 114 | } 115 | } 116 | -------------------------------------------------------------------------------- /ColourRenderingIndexResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Colour Rendering Index", 5 | "version": "2020-10-16", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2020 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/ColourRenderingIndexResURI" : { 18 | "get": { 19 | "description": "This Resource describes a Colour Rendering Index (CRI).\nThe Property \"cri\" is an number.\nA colour rendering index (CRI) is a quantitative measure of the ability of a light source to reveal the colours of various objects faithfully in comparison with an ideal or natural light source.\nLight sources with a high CRI are desirable in colour-critical applications such as neonatal care and art restoration.\nIt is defined by the International Commission on Illumination (CIE) as follows:[1] \nColour rendering: Effect of an illuminant on the colour appearance of objects by conscious or subconscious comparison with their colour appearance under a reference illuminant. The value often quoted as 'CRI' on commercially available lighting products is properly called the CIE Ra value, 'CRI' being a general term and CIE Ra being the international standard colour rendering index", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": { 27 | "rt": ["oic.r.colour.renderingindex"], 28 | "if": ["oic.if.s", "oic.if.baseline"], 29 | "cri": 80.1 30 | }, 31 | "schema": { "$ref": "#/definitions/RenderingIndex" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in": "query", 40 | "name": "if", 41 | "type": "string", 42 | "enum": ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "RenderingIndex" : { 47 | "properties": { 48 | "rt": { 49 | "description": "The Resource Type.", 50 | "items": { 51 | "enum": ["oic.r.colour.renderingindex"], 52 | "maxLength": 64, 53 | "type": "string" 54 | }, 55 | "minItems": 1, 56 | "uniqueItems": true, 57 | "readOnly": true, 58 | "type": "array" 59 | }, 60 | "cri": { 61 | "description": "The colour rendering index.", 62 | "maximum": 100, 63 | "type": "number", 64 | "readOnly": true 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "if": { 73 | "description": "The OCF Interface set supported by this Resource.", 74 | "items": { 75 | "enum": [ 76 | "oic.if.s", 77 | "oic.if.baseline" 78 | ], 79 | "type": "string" 80 | }, 81 | "minItems": 2, 82 | "uniqueItems": true, 83 | "readOnly": true, 84 | "type": "array" 85 | } 86 | }, 87 | "type": "object", 88 | "required": ["cri"] 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /Speed.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Speed", 5 | "version": "2019-05-13", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/SpeedResURI": { 24 | "get": { 25 | "description": "This Resource describes the speed of an object, which is the magnitude of its velocity.\n The unit, which is the default SI unit, is metre per second.\n The speed Property is a read-only value that is provided by the server.\n When range (from \"oic.r.baseresource\") is omitted the default is 0 to +MAXFLOAT.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.speed" 37 | ], 38 | "speed": 10.0 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/Speed" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "Speed": { 61 | "properties": { 62 | "speed": { 63 | "description": "This Property describes the speed of an object in metre per second (SI Unit). It should be noted, however, that the most common unit of speed everyday usage is the kilometre per hour or, in the US and the UK, miles per hour.", 64 | "type": "number", 65 | "minimum": 0.0, 66 | "readOnly": true 67 | }, 68 | "rt": { 69 | "description": "The Resource Type.", 70 | "items": { 71 | "enum": [ 72 | "oic.r.speed" 73 | ], 74 | "type": "string" 75 | }, 76 | "minItems": 1, 77 | "uniqueItems": true, 78 | "readOnly": true, 79 | "type": "array" 80 | }, 81 | "n": { 82 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 83 | }, 84 | "if": { 85 | "description": "The OCF Interface set supported by this Resource.", 86 | "items": { 87 | "enum": [ 88 | "oic.if.s", 89 | "oic.if.baseline" 90 | ], 91 | "type": "string" 92 | }, 93 | "minItems": 1, 94 | "uniqueItems": true, 95 | "readOnly": true, 96 | "type": "array" 97 | }, 98 | "range": { 99 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 100 | }, 101 | "step": { 102 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 103 | } 104 | }, 105 | "type": "object", 106 | "required": [ 107 | "speed" 108 | ] 109 | } 110 | } 111 | } -------------------------------------------------------------------------------- /VehicleConnectorResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Vehicle Connector", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/VehicleConnectorResURI" : { 18 | "get": { 19 | "description": "This Resource describes the attributes associated with an electric vehicle charging connector. The Property \"connected\" is a boolean indicating the status of the connector (False = disconnected, True = connected). The Property \"ratedchargingcapacity\" and \"rateddischargingcapacity\" are in Amps (A).", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.vehicle.connector"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "connected": true, 31 | "ratedchargingcapacity": 20.0, 32 | "rateddischargingcapacity": 5.0 33 | }, 34 | "schema": { "$ref": "#/definitions/VehicleConnector" } 35 | } 36 | } 37 | } 38 | } 39 | }, 40 | "parameters": { 41 | "interface": { 42 | "in": "query", 43 | "name": "if", 44 | "type": "string", 45 | "enum": ["oic.if.s", "oic.if.baseline"] 46 | } 47 | }, 48 | "definitions": { 49 | "VehicleConnector" : { 50 | "properties": { 51 | "rt": { 52 | "description": "The Resource Type.", 53 | "items": { 54 | "enum": ["oic.r.vehicle.connector"], 55 | "maxLength": 64, 56 | "type": "string" 57 | }, 58 | "minItems": 1, 59 | "uniqueItems": true, 60 | "readOnly": true, 61 | "type": "array" 62 | }, 63 | "connected": { 64 | "description": "The connection state.", 65 | "readOnly": true, 66 | "type": "boolean" 67 | }, 68 | "ratedchargingcapacity": { 69 | "description": "The rated charging capacity in Amps (A).", 70 | "readOnly": true, 71 | "type": "number" 72 | }, 73 | "rateddischargingcapacity": { 74 | "description": "The rated discharging capacity in Amps (A).", 75 | "readOnly": true, 76 | "type": "number" 77 | }, 78 | "n": { 79 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 80 | }, 81 | "id": { 82 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 83 | }, 84 | "if": { 85 | "description": "The OCF Interface set supported by this Resource.", 86 | "items": { 87 | "enum": [ 88 | "oic.if.s", 89 | "oic.if.baseline" 90 | ], 91 | "type": "string" 92 | }, 93 | "minItems": 2, 94 | "uniqueItems": true, 95 | "readOnly": true, 96 | "type": "array" 97 | } 98 | }, 99 | "type": "object", 100 | "required": ["connected"] 101 | } 102 | } 103 | } 104 | -------------------------------------------------------------------------------- /AccelerationResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Acceleration Sensor", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/AccelerationResURI" : { 18 | "get": { 19 | "description": "This Resource provides a measure of proper acceleration (g force) as opposed to co-ordinate acceleration (which is dependent on the co-ordinate system and the observer).\nThe Property \"value\" is a float which describes the acceleration experienced by the object in \"g\".", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.acceleration"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "acceleration": 0.5 31 | }, 32 | "schema": { "$ref": "#/definitions/acceleration" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "acceleration" : { 48 | "properties": { 49 | "rt": { 50 | "description": "Resource Type", 51 | "items": { 52 | "maxLength": 64, 53 | "type": "string", 54 | "enum": ["oic.r.sensor.acceleration"] 55 | }, 56 | "minItems": 1, 57 | "uniqueItems" : true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "acceleration": { 62 | "description": "The sensed acceleration experienced in 'g'.", 63 | "readOnly": true, 64 | "type": "number" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "range": { 73 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 74 | }, 75 | "step": { 76 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 77 | }, 78 | "precision": { 79 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 80 | }, 81 | "if": { 82 | "description": "The OCF Interface set supported by this Resource.", 83 | "items": { 84 | "enum": [ 85 | "oic.if.s", 86 | "oic.if.baseline" 87 | ], 88 | "type": "string" 89 | }, 90 | "minItems": 2, 91 | "readOnly": true, 92 | "uniqueItems": true, 93 | "type": "array" 94 | } 95 | }, 96 | "type": "object", 97 | "required": ["acceleration"] 98 | } 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /NightModeResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Night Mode", 5 | "version": "2019-02-15", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/NightModeResURI" : { 18 | "get": { 19 | "description": "This Resource describes a night mode on/off feature.\nA nightMode value of 'true' means that the feature is on.\nA nightMode value of 'false' means that the feature is off.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.nightmode"], 29 | "if": ["oic.if.a", "oic.if.baseline"], 30 | "nightMode": false 31 | }, 32 | "schema": { "$ref": "#/definitions/NightMode" } 33 | } 34 | } 35 | }, 36 | "post": { 37 | "description": "", 38 | "parameters": [ 39 | {"$ref": "#/parameters/interface"}, 40 | { 41 | "name": "body", 42 | "in": "body", 43 | "required": true, 44 | "schema": { "$ref": "#/definitions/NightMode" }, 45 | "x-example": 46 | { 47 | "nightMode": true 48 | } 49 | } 50 | ], 51 | "responses": { 52 | "200": { 53 | "description" : "", 54 | "x-example": 55 | { 56 | "nightMode": true 57 | }, 58 | "schema": { "$ref": "#/definitions/NightMode" } 59 | } 60 | } 61 | } 62 | } 63 | }, 64 | "parameters": { 65 | "interface": { 66 | "in": "query", 67 | "name": "if", 68 | "type": "string", 69 | "enum": ["oic.if.a", "oic.if.baseline"] 70 | } 71 | }, 72 | "definitions": { 73 | "NightMode" : { 74 | "properties": { 75 | "rt": { 76 | "description": "The Resource Type.", 77 | "items": { 78 | "enum": ["oic.r.nightmode"], 79 | "maxLength": 64, 80 | "type": "string" 81 | }, 82 | "minItems": 1, 83 | "uniqueItems": true, 84 | "readOnly": true, 85 | "type": "array" 86 | }, 87 | "nightMode": { 88 | "description": "The status of the Night Mode.", 89 | "type": "boolean" 90 | }, 91 | "n": { 92 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 93 | }, 94 | "id": { 95 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 96 | }, 97 | "if": { 98 | "description": "The OCF Interface set supported by this Resource.", 99 | "items": { 100 | "enum": [ 101 | "oic.if.a", 102 | "oic.if.baseline" 103 | ], 104 | "type": "string" 105 | }, 106 | "minItems": 2, 107 | "uniqueItems": true, 108 | "readOnly": true, 109 | "type": "array" 110 | } 111 | }, 112 | "type": "object", 113 | "required": ["nightMode"] 114 | } 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /AltimeterResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Altimeter", 5 | "version": "2019-02-25", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/AltimeterResURI" : { 18 | "get": { 19 | "description": "This Resource describes the properties associated with altimeter.\nThe Property \"alt\" is the distance (metres) above or below 'local' sea-level.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "RETRIEVES the current the distance (metres) above or below 'local' sea-level.", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.altimeter"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "alt": 1500.0 31 | }, 32 | "schema": { "$ref": "#/definitions/Altimeter" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "Altimeter" : { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.altimeter"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "alt" : 62 | { 63 | "description": "The current distance (metres) above or below 'local' sea-level.", 64 | "readOnly": true, 65 | "type": "number" 66 | }, 67 | "n": { 68 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 69 | }, 70 | "id": { 71 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 72 | }, 73 | "precision": { 74 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 75 | }, 76 | "range": { 77 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 78 | }, 79 | "step": { 80 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 81 | }, 82 | "if": { 83 | "description": "The OCF Interface set supported by this Resource.", 84 | "items": { 85 | "enum": [ 86 | "oic.if.s", 87 | "oic.if.baseline" 88 | ], 89 | "type": "string" 90 | }, 91 | "minItems": 2, 92 | "uniqueItems": true, 93 | "readOnly": true, 94 | "type": "array" 95 | } 96 | }, 97 | "type": "object", 98 | "required": ["alt"] 99 | } 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /BinarySwitchResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Binary Switch", 5 | "version": "2019-02-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/BinarySwitchResURI" : { 18 | "get": { 19 | "description": "This Resource describes a binary switch (on/off).\nThe Property \"value\" is a boolean.\nA value of 'true' means that the switch is on.\nA value of 'false' means that the switch is off.\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.switch.binary"], 29 | "if": ["oic.if.a", "oic.if.baseline"], 30 | "value": false 31 | }, 32 | "schema": { "$ref": "#/definitions/BinarySwitch" } 33 | } 34 | } 35 | }, 36 | "post": { 37 | "description": "", 38 | "parameters": [ 39 | {"$ref": "#/parameters/interface"}, 40 | { 41 | "name": "body", 42 | "in": "body", 43 | "required": true, 44 | "schema": { "$ref": "#/definitions/BinarySwitch" }, 45 | "x-example": 46 | { 47 | "value": true 48 | } 49 | } 50 | ], 51 | "responses": { 52 | "200": { 53 | "description" : "", 54 | "x-example": 55 | { 56 | "value": true 57 | }, 58 | "schema": { "$ref": "#/definitions/BinarySwitch" } 59 | } 60 | } 61 | } 62 | } 63 | }, 64 | "parameters": { 65 | "interface" : { 66 | "in": "query", 67 | "name": "if", 68 | "type": "string", 69 | "enum": ["oic.if.a", "oic.if.baseline"] 70 | } 71 | }, 72 | "definitions": { 73 | "BinarySwitch" : { 74 | "properties": { 75 | "rt": { 76 | "description": "The Resource Type.", 77 | "items": { 78 | "enum": ["oic.r.switch.binary"], 79 | "maxLength": 64, 80 | "type": "string" 81 | }, 82 | "minItems": 1, 83 | "uniqueItems": true, 84 | "readOnly": true, 85 | "type": "array" 86 | }, 87 | "value": { 88 | "description": "The status of the switch.", 89 | "type": "boolean" 90 | }, 91 | "n": { 92 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 93 | }, 94 | "id": { 95 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 96 | }, 97 | "if": { 98 | "description": "The OCF Interface set supported by this Resource.", 99 | "items": { 100 | "enum": [ 101 | "oic.if.a", 102 | "oic.if.baseline" 103 | ], 104 | "type": "string" 105 | }, 106 | "minItems": 2, 107 | "uniqueItems": true, 108 | "readOnly": true, 109 | "type": "array" 110 | } 111 | }, 112 | "type": "object", 113 | "required": ["value"] 114 | } 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /BMIResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Body Mass Index(BMI)", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/BMIResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with a person's Body Mass Index (BMI).\nThe unit, which is the default unit, is kg/m^2.\nThe bmi and unit Properties are read-only values that are provided by the server.\nWhen range is omitted the default is 0 to +MAXFLOAT.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.bmi" 37 | ], 38 | "bmi": 20.0 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/BMI" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "BMI": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.bmi" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "bmi": { 77 | "description": "Body Mass Index (BMI) in kg/m^2", 78 | "minimum": 0.0, 79 | "readOnly": true, 80 | "type": "number" 81 | }, 82 | "range": { 83 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 84 | }, 85 | "step": { 86 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 87 | }, 88 | "precision": { 89 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 90 | }, 91 | "n": { 92 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 93 | }, 94 | "id": { 95 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 96 | }, 97 | "if": { 98 | "description": "The OCF Interface set supported by this Resource", 99 | "items": { 100 | "enum": [ 101 | "oic.if.s", 102 | "oic.if.baseline" 103 | ], 104 | "type": "string", 105 | "maxLength": 64 106 | }, 107 | "minItems": 1, 108 | "readOnly": true, 109 | "uniqueItems": true, 110 | "type": "array" 111 | } 112 | }, 113 | "type": "object", 114 | "required": [ 115 | "bmi" 116 | ] 117 | } 118 | } 119 | } 120 | -------------------------------------------------------------------------------- /AtmosphericPressureResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Atmospheric Pressure Sensor", 5 | "version": "2019-02-25", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/AtmosphericPressureResURI" : { 18 | "get": { 19 | "description": "This Resource provides a measurement of Mean Sea Level Pressure experienced at the measuring point expressed in millibars.\nThe Property \"atmosphericPressure\" is a float which describes the atmospheric pressure in hPa (hectoPascals).\nNote that hPa and the also commonly used unit of millibars (mbar) are numerically equivalent.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.atmosphericpressure"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "atmosphericPressure": 1000.4 31 | }, 32 | "schema": { "$ref": "#/definitions/atmosphericPressure" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in": "query", 41 | "name": "if", 42 | "type": "string", 43 | "enum": ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "atmosphericPressure" : { 48 | "properties": { 49 | "rt" : { 50 | "description": "The Resource Type.", 51 | "items": { 52 | "enum": ["oic.r.sensor.atmosphericpressure"], 53 | "maxLength": 64, 54 | "type": "string" 55 | }, 56 | "minItems": 1, 57 | "uniqueItems": true, 58 | "readOnly": true, 59 | "type": "array" 60 | }, 61 | "atmosphericPressure": { 62 | "description": "The current atmospheric pressure in hPa.", 63 | "readOnly": true, 64 | "type": "number" 65 | }, 66 | "n": { 67 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 68 | }, 69 | "id": { 70 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 71 | }, 72 | "precision": { 73 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 74 | }, 75 | "range": { 76 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 77 | }, 78 | "step": { 79 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 80 | }, 81 | "if": { 82 | "description": "The OCF Interface set supported by this Resource.", 83 | "items": { 84 | "enum": [ 85 | "oic.if.s", 86 | "oic.if.baseline" 87 | ], 88 | "type": "string" 89 | }, 90 | "minItems": 2, 91 | "uniqueItems": true, 92 | "readOnly": true, 93 | "type": "array" 94 | } 95 | }, 96 | "type": "object", 97 | "required": ["atmosphericPressure"] 98 | } 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /WaterResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Water Sensor", 5 | "version": "2019-11-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/WaterResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether water has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that water has been sensed.\nA value of 'false' means that water not been sensed.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": { 27 | "rt": ["oic.r.sensor.water"], 28 | "id": "unique_example_id", 29 | "value": true 30 | }, 31 | "schema": { "$ref": "#/definitions/Water" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in" : "query", 40 | "name" : "if", 41 | "type" : "string", 42 | "enum" : ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "Water": { 47 | "properties": { 48 | "rt": { 49 | "description": "The Resource Type", 50 | "items": { 51 | "maxLength": 64, 52 | "type": "string", 53 | "enum": ["oic.r.sensor.water"] 54 | }, 55 | "minItems": 1, 56 | "uniqueItems": true, 57 | "readOnly": true, 58 | "type": "array" 59 | }, 60 | "value": { 61 | "description": "true = sensed, false = not sensed.", 62 | "readOnly": true, 63 | "type": "boolean" 64 | }, 65 | "measurement": { 66 | "type": "number", 67 | "description": "Measured value for this sensor in units of litres/hr", 68 | "readOnly": true 69 | }, 70 | "precision": { 71 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 72 | }, 73 | "n": { 74 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 75 | }, 76 | "range": { 77 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 78 | }, 79 | "step": { 80 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 81 | }, 82 | "id": { 83 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 84 | }, 85 | "if": { 86 | "description": "The OCF Interface set supported by this Resource", 87 | "items": { 88 | "enum": [ 89 | "oic.if.baseline", 90 | "oic.if.s" 91 | ], 92 | "maxLength": 64, 93 | "type": "string" 94 | }, 95 | "minItems": 1, 96 | "uniqueItems": true, 97 | "readOnly": true, 98 | "type": "array" 99 | } 100 | }, 101 | "type" : "object", 102 | "required": ["value"] 103 | } 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /AutomaticDocumentFeederResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Automatic Document Feeder", 5 | "version": "2019-02-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/AutomaticDocumentFeederResURI" : { 18 | "get": { 19 | "description": "This Resource describes the state of an automatic document feeder, typically used with a scanner.\nThe Property \"adfstates\" and \"currentAdfState\" are read only.\nThe Property \"adfStates\" is an array of the possible operational states.\nThe Property \"adfProcessing\" is the OK state, other states are errors or require 'user attention'.\nThe currentAdfState is the current value of the ADF state on the device.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.automaticdocumentfeeder"], 29 | "if": ["oic.if.s", "oic.if.baseline"], 30 | "adfStates": ["adfProcessing", "adfEmpty", "adfJam", "adfLoaded", "adfMispick", "adfHatchOpen", "adfDuplexPageTooShort", "adfDuplexPageTooLong", "adfMultipickDetected", "adfInputTrayFailed", "adfInputTrayOverloaded"], 31 | "currentAdfState": "adfProcessing" 32 | }, 33 | "schema": { "$ref": "#/definitions/AutomaticDocumentFeeder" } 34 | } 35 | } 36 | } 37 | } 38 | }, 39 | "parameters": { 40 | "interface" : { 41 | "in": "query", 42 | "name": "if", 43 | "type": "string", 44 | "enum": ["oic.if.s", "oic.if.baseline"] 45 | } 46 | }, 47 | "definitions": { 48 | "AutomaticDocumentFeeder" : { 49 | "properties": { 50 | "rt": { 51 | "description": "The Resource Type.", 52 | "items": { 53 | "enum": ["oic.r.automaticdocumentfeeder"], 54 | "maxLength": 64, 55 | "type": "string" 56 | }, 57 | "minItems": 1, 58 | "uniqueItems": true, 59 | "readOnly": true, 60 | "type": "array" 61 | }, 62 | "adfStates": { 63 | "description": "The array of the possible adf states.", 64 | "items": { 65 | "type": "string" 66 | }, 67 | "readOnly": true, 68 | "uniqueItems": true, 69 | "type": "array" 70 | }, 71 | "currentAdfState": { 72 | "description": "The current adf state.", 73 | "readOnly": true, 74 | "type": "string" 75 | }, 76 | "n": { 77 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 78 | }, 79 | "id": { 80 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 81 | }, 82 | "if": { 83 | "description": "The OCF Interface set supported by this Resource.", 84 | "items": { 85 | "enum": [ 86 | "oic.if.s", 87 | "oic.if.baseline" 88 | ], 89 | "type": "string" 90 | }, 91 | "minItems": 2, 92 | "uniqueItems": true, 93 | "readOnly": true, 94 | "type": "array" 95 | } 96 | }, 97 | "type": "object", 98 | "required": ["adfStates", "currentAdfState"] 99 | } 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /ExerciseResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Exercise for Glucose Meter", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/ExerciseResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with glucose exercise.\nThe exercise Property has a default unit of percentage.\nThe exercise Property is a read-only value that is provided by the Server.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.glucose.exercise" 37 | ], 38 | "exercise": 30.0 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/Exercise" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "Exercise": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.glucose.exercise" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "exercise": { 77 | "description": "The level of exercise undertaken in percentage", 78 | "maximum": 100.0, 79 | "minimum": 0.0, 80 | "readOnly": true, 81 | "type": "number" 82 | }, 83 | "range": { 84 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 85 | }, 86 | "step": { 87 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 88 | }, 89 | "precision": { 90 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 91 | }, 92 | "n": { 93 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 94 | }, 95 | "id": { 96 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 97 | }, 98 | "if": { 99 | "description": "The OCF Interface set supported by this Resource", 100 | "items": { 101 | "enum": [ 102 | "oic.if.s", 103 | "oic.if.baseline" 104 | ], 105 | "type": "string", 106 | "maxLength": 64 107 | }, 108 | "minItems": 1, 109 | "readOnly": true, 110 | "uniqueItems": true, 111 | "type": "array" 112 | } 113 | }, 114 | "type": "object", 115 | "required": [ 116 | "exercise" 117 | ] 118 | } 119 | } 120 | } 121 | -------------------------------------------------------------------------------- /GlucoseHbA1cResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Hemoglobin Bound to Glucose A1c Form (HbA1c) for Glucose Meter", 5 | "version": "2019-03-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2016-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/GlucoseHbA1cResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with a person's hba1c level.\nThe unit is a single value that is percentage.\nThe hba1c Property is a read-only value that is provided by the Server.", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.glucose.hba1c" 37 | ], 38 | "hba1c": 5.0 39 | }, 40 | "schema": { 41 | "$ref": "#/definitions/HbA1c" 42 | } 43 | } 44 | } 45 | } 46 | } 47 | }, 48 | "parameters": { 49 | "interface": { 50 | "in": "query", 51 | "name": "if", 52 | "type": "string", 53 | "enum": [ 54 | "oic.if.s", 55 | "oic.if.baseline" 56 | ] 57 | } 58 | }, 59 | "definitions": { 60 | "HbA1c": { 61 | "properties": { 62 | "rt": { 63 | "description": "Resource Type", 64 | "items": { 65 | "enum": [ 66 | "oic.r.glucose.hba1c" 67 | ], 68 | "type": "string", 69 | "maxLength": 64 70 | }, 71 | "minItems": 1, 72 | "uniqueItems": true, 73 | "readOnly": true, 74 | "type": "array" 75 | }, 76 | "hba1c": { 77 | "description": "Current HbA1c measurement in percentage", 78 | "maximum": 100.0, 79 | "minimum": 0.0, 80 | "readOnly": true, 81 | "type": "number" 82 | }, 83 | "range": { 84 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 85 | }, 86 | "step": { 87 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 88 | }, 89 | "precision": { 90 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 91 | }, 92 | "n": { 93 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 94 | }, 95 | "id": { 96 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 97 | }, 98 | "if": { 99 | "description": "The OCF Interface set supported by this Resource", 100 | "items": { 101 | "enum": [ 102 | "oic.if.s", 103 | "oic.if.baseline" 104 | ], 105 | "type": "string", 106 | "maxLength": 64 107 | }, 108 | "minItems": 1, 109 | "readOnly": true, 110 | "uniqueItems": true, 111 | "type": "array" 112 | } 113 | }, 114 | "type": "object", 115 | "required": [ 116 | "hba1c" 117 | ] 118 | } 119 | } 120 | } 121 | -------------------------------------------------------------------------------- /SmokeSensorResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Smoke Sensor", 5 | "version": "2019-11-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/SmokeSensorResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether smoke has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that smoke has been sensed.\nA value of 'false' means that smoke not been sensed.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": { 27 | "rt": ["oic.r.sensor.smoke"], 28 | "id": "unique_example_id", 29 | "value": true 30 | }, 31 | "schema": { "$ref": "#/definitions/smoke" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in" : "query", 40 | "name" : "if", 41 | "type" : "string", 42 | "enum" : ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "smoke": { 47 | "properties": { 48 | "rt": { 49 | "description": "The Resource Type", 50 | "items": { 51 | "maxLength": 64, 52 | "type": "string", 53 | "enum": ["oic.r.sensor.smoke"] 54 | }, 55 | "minItems": 1, 56 | "uniqueItems": true, 57 | "readOnly": true, 58 | "type": "array" 59 | }, 60 | "value": { 61 | "description": "The smoke indicator, true = sensed, false = not sensed.", 62 | "readOnly": true, 63 | "type": "boolean" 64 | }, 65 | "measurement": { 66 | "type": "number", 67 | "description": "Measured value for this sensor, this is a percentage", 68 | "readOnly": true 69 | }, 70 | "precision": { 71 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 72 | }, 73 | "n": { 74 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 75 | }, 76 | "range": { 77 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 78 | }, 79 | "step": { 80 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 81 | }, 82 | "id": { 83 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 84 | }, 85 | "if": { 86 | "description": "The OCF Interface set supported by this Resource", 87 | "items": { 88 | "enum": [ 89 | "oic.if.baseline", 90 | "oic.if.s" 91 | ], 92 | "type": "string", 93 | "maxLength": 64 94 | }, 95 | "minItems": 1, 96 | "readOnly": true, 97 | "uniqueItems": true, 98 | "type": "array" 99 | } 100 | }, 101 | "type" : "object", 102 | "required": ["value"] 103 | } 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /ContinuousGlucoseMeterSensor.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Sensor for Continuous Glucose Meter (CGM)", 5 | "version": "2019-03-04", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": [ 14 | "http" 15 | ], 16 | "consumes": [ 17 | "application/json" 18 | ], 19 | "produces": [ 20 | "application/json" 21 | ], 22 | "paths": { 23 | "/ContinuousGlucoseMeterSensorResURI": { 24 | "get": { 25 | "description": "This Resource describes the Properties associated with Sensor for Continuous Glucose Meter (CGM).", 26 | "parameters": [ 27 | { 28 | "$ref": "#/parameters/interface" 29 | } 30 | ], 31 | "responses": { 32 | "200": { 33 | "description": "", 34 | "x-example": { 35 | "rt": [ 36 | "oic.r.cgm.sensor" 37 | ], 38 | "starttime": "2018-06-20T14:30Z", 39 | "runtime": 7.0 40 | }, 41 | "schema": { 42 | "$ref": "#/definitions/ContinuousGlucoseMeterSensor" 43 | } 44 | } 45 | } 46 | } 47 | } 48 | }, 49 | "parameters": { 50 | "interface": { 51 | "in": "query", 52 | "name": "if", 53 | "type": "string", 54 | "enum": [ 55 | "oic.if.s", 56 | "oic.if.baseline" 57 | ] 58 | } 59 | }, 60 | "definitions": { 61 | "ContinuousGlucoseMeterSensor": { 62 | "properties": { 63 | "starttime": { 64 | "description": "This Property describes the Sensor start time using ISO 8601 datetime format (e.g: 2007-04-05T14:30Z, 2007-04-05T14:30+09:00)", 65 | "type": "string", 66 | "readOnly": true 67 | }, 68 | "runtime": { 69 | "description": "This Property describes the recommended runtime days using CGM", 70 | "type": "number", 71 | "minimum": 0.0, 72 | "readOnly": true 73 | }, 74 | "rt": { 75 | "description": "The Resource Type.", 76 | "items": { 77 | "enum": [ 78 | "oic.r.cgm.sensor" 79 | ], 80 | "type": "string" 81 | }, 82 | "minItems": 1, 83 | "uniqueItems": true, 84 | "readOnly": true, 85 | "type": "array" 86 | }, 87 | "n": { 88 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 89 | }, 90 | "if": { 91 | "description": "The OCF Interface set supported by this Resource.", 92 | "items": { 93 | "enum": [ 94 | "oic.if.s", 95 | "oic.if.baseline" 96 | ], 97 | "type": "string" 98 | }, 99 | "minItems": 1, 100 | "uniqueItems": true, 101 | "readOnly": true, 102 | "type": "array" 103 | }, 104 | "range": { 105 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 106 | }, 107 | "step": { 108 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 109 | }, 110 | "precision": { 111 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 112 | } 113 | }, 114 | "type": "object", 115 | "required": [ 116 | "starttime", "runtime" 117 | ] 118 | } 119 | } 120 | } -------------------------------------------------------------------------------- /GenericSensorResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Generic Sensor", 5 | "version": "2019-11-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/GenericSensorResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether some value or property or entity has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that the target has been sensed.\nA value of 'false' means that the target has not been sensed.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": { 27 | "rt": ["oic.r.sensor"], 28 | "id": "unique_example_id", 29 | "value": true 30 | }, 31 | "schema": { "$ref": "#/definitions/Sensor" } 32 | } 33 | } 34 | } 35 | } 36 | }, 37 | "parameters": { 38 | "interface" : { 39 | "in" : "query", 40 | "name" : "if", 41 | "type" : "string", 42 | "enum" : ["oic.if.s", "oic.if.baseline"] 43 | } 44 | }, 45 | "definitions": { 46 | "Sensor": { 47 | "properties": { 48 | "rt": { 49 | "description": "The Resource Type", 50 | "items": { 51 | "maxLength": 64, 52 | "type": "string", 53 | "enum": ["oic.r.sensor"] 54 | }, 55 | "minItems": 1, 56 | "uniqueItems": true, 57 | "readOnly": true, 58 | "type": "array" 59 | }, 60 | "value": { 61 | "description": "true = sensed, false = not sensed.", 62 | "readOnly": true, 63 | "type": "boolean" 64 | }, 65 | "measurement": { 66 | "type": "number", 67 | "description": "Measured value for this sensor, units depend on the specific type of sensor", 68 | "readOnly": true 69 | }, 70 | "precision": { 71 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 72 | }, 73 | "n": { 74 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 75 | }, 76 | "range": { 77 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 78 | }, 79 | "step": { 80 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 81 | }, 82 | "id": { 83 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 84 | }, 85 | "if" : { 86 | "description": "The OCF Interface set supported by this Resource", 87 | "items": { 88 | "enum": [ 89 | "oic.if.baseline", 90 | "oic.if.s" 91 | ], 92 | "maxLength": 64, 93 | "type": "string" 94 | }, 95 | "minItems": 1, 96 | "uniqueItems": true, 97 | "readOnly": true, 98 | "type": "array" 99 | } 100 | }, 101 | "type" : "object", 102 | "required": ["value"] 103 | } 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /AutoFocusResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Auto Focus", 5 | "version": "2019-02-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/AutoFocusResURI" : { 18 | "get": { 19 | "description": "This Resource describes an auto focus on/off feature.\nThe Property \"autoFocus\" is a boolean.\nAn \"autoFocus\" value of 'true' means that the auto focus feature is on.\nAn \"autoFocus\" value of 'false' means that the auto focus feature is off.\nNote that when Pan Tilt Zoom (see 'Pan Tilt Zoom' Resource definition) is used the autofocus works only in the selected area.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.autofocus"], 29 | "if": ["oic.if.a", "oic.if.baseline"], 30 | "autoFocus": false 31 | }, 32 | "schema": { "$ref": "#/definitions/AutoFocus" } 33 | } 34 | } 35 | }, 36 | "post": { 37 | "description": "", 38 | "parameters": [ 39 | {"$ref": "#/parameters/interface"}, 40 | { 41 | "name": "body", 42 | "in": "body", 43 | "required": true, 44 | "schema": { "$ref": "#/definitions/AutoFocus" }, 45 | "x-example": 46 | { 47 | "autoFocus": true 48 | } 49 | } 50 | ], 51 | "responses": { 52 | "200": { 53 | "description" : "", 54 | "x-example": 55 | { 56 | "autoFocus": true 57 | }, 58 | "schema": { "$ref": "#/definitions/AutoFocus" } 59 | } 60 | } 61 | } 62 | } 63 | }, 64 | "parameters": { 65 | "interface" : { 66 | "in": "query", 67 | "name": "if", 68 | "type": "string", 69 | "enum": ["oic.if.a", "oic.if.baseline"] 70 | } 71 | }, 72 | "definitions": { 73 | "AutoFocus" : { 74 | "properties": { 75 | "rt": { 76 | "description": "The Resource Type.", 77 | "items": { 78 | "enum": ["oic.r.autofocus"], 79 | "maxLength": 64, 80 | "type": "string" 81 | }, 82 | "minItems": 1, 83 | "uniqueItems": true, 84 | "readOnly": true, 85 | "type": "array" 86 | }, 87 | "autoFocus": { 88 | "description": "The status of the Auto Focus feature.", 89 | "type": "boolean" 90 | }, 91 | "n": { 92 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 93 | }, 94 | "id": { 95 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 96 | }, 97 | "if": { 98 | "description": "The OCF Interface set supported by this Resource.", 99 | "items": { 100 | "enum": [ 101 | "oic.if.a", 102 | "oic.if.baseline" 103 | ], 104 | "type": "string" 105 | }, 106 | "minItems": 2, 107 | "readOnly": true, 108 | "uniqueItems": true, 109 | "type": "array" 110 | } 111 | }, 112 | "type": "object", 113 | "required": ["autoFocus"] 114 | } 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /AutoWhiteBalanceResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Auto White Balance", 5 | "version": "2019-02-22", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/AutoWhiteBalanceResURI" : { 18 | "get": { 19 | "description": "This Resource describes an auto balance on/off feature.\nThe Property \"autoWhiteBalance\" is a boolean.\nAn AutoWhiteBalance value of 'true' means that the auto white balance feature is on.\nAn AutoWhiteBalance value of 'false' means that the auto white balance feature is off.\n", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.colour.autowhitebalance"], 29 | "if": ["oic.if.a", "oic.if.baseline"], 30 | "autoWhiteBalance": false 31 | }, 32 | "schema": { "$ref": "#/definitions/AutoWhiteBalance" } 33 | } 34 | } 35 | }, 36 | "post": { 37 | "description": "", 38 | "parameters": [ 39 | {"$ref": "#/parameters/interface"}, 40 | { 41 | "name": "body", 42 | "in": "body", 43 | "required": true, 44 | "schema": { "$ref": "#/definitions/AutoWhiteBalance" }, 45 | "x-example": 46 | { 47 | "autoWhiteBalance": true 48 | } 49 | } 50 | ], 51 | "responses": { 52 | "200": { 53 | "description" : "", 54 | "x-example": 55 | { 56 | "autoWhiteBalance": true 57 | }, 58 | "schema": { "$ref": "#/definitions/AutoWhiteBalance" } 59 | } 60 | } 61 | } 62 | } 63 | }, 64 | "parameters": { 65 | "interface" : { 66 | "in": "query", 67 | "name": "if", 68 | "type": "string", 69 | "enum": ["oic.if.a", "oic.if.baseline"] 70 | } 71 | }, 72 | "definitions": { 73 | "AutoWhiteBalance" : { 74 | "properties": { 75 | "rt": { 76 | "description": "The Resource Type.", 77 | "items": { 78 | "enum": ["oic.r.colour.autowhitebalance"], 79 | "maxLength": 64, 80 | "type": "string" 81 | }, 82 | "minItems": 1, 83 | "uniqueItems": true, 84 | "readOnly": true, 85 | "type": "array" 86 | }, 87 | "autoWhiteBalance": { 88 | "description": "The status of the Auto White balance feature.", 89 | "type": "boolean" 90 | }, 91 | "n": { 92 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 93 | }, 94 | "id": { 95 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 96 | }, 97 | "if": { 98 | "description": "The OCF Interface set supported by this Resource.", 99 | "items": { 100 | "enum": [ 101 | "oic.if.a", 102 | "oic.if.baseline" 103 | ], 104 | "type": "string" 105 | }, 106 | "minItems": 2, 107 | "uniqueItems": true, 108 | "readOnly": true, 109 | "type": "array" 110 | } 111 | }, 112 | "type": "object", 113 | "required": ["autoWhiteBalance"] 114 | } 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /CarbonDioxideResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Carbon Dioxide Sensor", 5 | "version": "2019-11-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "Copyright 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/CarbonDioxideResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether carbon dioxide has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that carbon dioxide has been detected.\nA value of 'false' means that carbon dioxide has not been detected.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.carbondioxide"], 29 | "id": "unique_example_id", 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/CO2" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in" : "query", 41 | "name" : "if", 42 | "type" : "string", 43 | "enum" : ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "CO2": { 48 | "properties": { 49 | "rt": { 50 | "description": "The Resource Type", 51 | "items": { 52 | "maxLength": 64, 53 | "type": "string", 54 | "enum": ["oic.r.sensor.carbondioxide"] 55 | }, 56 | "minItems": 1, 57 | "readOnly": true, 58 | "uniqueItems": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The carbon dioxide indicator, true = sensed, false = not sensed.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "measurement": { 67 | "type": "number", 68 | "description": "Measured value for this sensor, units are in ppm", 69 | "readOnly": true 70 | }, 71 | "precision": { 72 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 73 | }, 74 | "n": { 75 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 76 | }, 77 | "range": { 78 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 79 | }, 80 | "step": { 81 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 82 | }, 83 | "id": { 84 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 85 | }, 86 | "if": { 87 | "description": "The OCF Interface set supported by this Resource", 88 | "items": { 89 | "enum": [ 90 | "oic.if.baseline", 91 | "oic.if.s" 92 | ], 93 | "maxLength": 64, 94 | "type": "string" 95 | }, 96 | "minItems": 2, 97 | "readOnly": true, 98 | "uniqueItems": true, 99 | "type": "array" 100 | } 101 | }, 102 | "type" : "object", 103 | "required": ["value"] 104 | } 105 | } 106 | } 107 | -------------------------------------------------------------------------------- /CarbonMonoxideResURI.swagger.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Carbon Monoxide Sensor", 5 | "version": "2019-11-18", 6 | "license": { 7 | "name": "OCF Data Model License", 8 | "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", 9 | "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved." 10 | }, 11 | "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md" 12 | }, 13 | "schemes": ["http"], 14 | "consumes": ["application/json"], 15 | "produces": ["application/json"], 16 | "paths": { 17 | "/CarbonMonoxideResURI" : { 18 | "get": { 19 | "description": "This Resource describes whether carbon monoxide has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that carbon monoxide has been detected.\nA value of 'false' means that carbon monoxide has not been detected.", 20 | "parameters": [ 21 | {"$ref": "#/parameters/interface"} 22 | ], 23 | "responses": { 24 | "200": { 25 | "description" : "", 26 | "x-example": 27 | { 28 | "rt": ["oic.r.sensor.carbonmonoxide"], 29 | "id": "unique_example_id", 30 | "value": true 31 | }, 32 | "schema": { "$ref": "#/definitions/CO" } 33 | } 34 | } 35 | } 36 | } 37 | }, 38 | "parameters": { 39 | "interface" : { 40 | "in" : "query", 41 | "name" : "if", 42 | "type" : "string", 43 | "enum" : ["oic.if.s", "oic.if.baseline"] 44 | } 45 | }, 46 | "definitions": { 47 | "CO": { 48 | "properties": { 49 | "rt": { 50 | "description": "Resource Type", 51 | "items": { 52 | "maxLength": 64, 53 | "type": "string", 54 | "enum": ["oic.r.sensor.carbonmonoxide"] 55 | }, 56 | "minItems": 1, 57 | "readOnly": true, 58 | "uniqueItems": true, 59 | "type": "array" 60 | }, 61 | "value": { 62 | "description": "The carbon monoxide indicator, true = sensed, false = not sensed.", 63 | "readOnly": true, 64 | "type": "boolean" 65 | }, 66 | "measurement": { 67 | "type": "number", 68 | "description": "Measured value for this sensor, units are in ppm", 69 | "readOnly": true 70 | }, 71 | "precision": { 72 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision" 73 | }, 74 | "n": { 75 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n" 76 | }, 77 | "range": { 78 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number" 79 | }, 80 | "step": { 81 | "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number" 82 | }, 83 | "id": { 84 | "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id" 85 | }, 86 | "if": { 87 | "description": "The OCF Interface set supported by this Resource", 88 | "items": { 89 | "enum": [ 90 | "oic.if.baseline", 91 | "oic.if.s" 92 | ], 93 | "maxLength": 64, 94 | "type": "string" 95 | }, 96 | "minItems": 1, 97 | "uniqueItems": true, 98 | "readOnly": true, 99 | "type": "array" 100 | } 101 | }, 102 | "type" : "object", 103 | "required": ["value"] 104 | } 105 | } 106 | } 107 | --------------------------------------------------------------------------------