IoTDataModels/BatteryMaterialResURI.swagger.json at master · OpenInterConnect/IoTDataModels · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
  "swagger": "2.0",
  "info": {
    "title": "Battery Material",
    "version": "2019-02-22",
    "license": {
        "name": "OCF Data Model License",
        "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
        "x-copyright": "Copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/BatteryMaterialResURI" : {
      "get": {
        "description": "This Resource describes the battery material represented as an enumerated set of strings.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                    "rt": ["oic.r.batterymaterial"],
                    "if": ["oic.if.s", "oic.if.baseline"],
                    "material": "Alkaline"
                },
              "schema": { "$ref": "#/definitions/BatteryMaterial" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "BatteryMaterial" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.batterymaterial"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "material": {
          "description": "The battery construction material (type).",
          "enum": [
            "Alkaline",
            "Aluminium Air",
            "Aluminium Ion",
            "Atomic Betavoltaics",
            "Atomic Optoelectric Nuclear",
            "Atomic Nuclear",
            "Bunsen Cell",
            "Chromic Acid Cell",
            "Poggendorff Cell",
            "Clark Cell",
            "Daniell Cell",
            "Dry Cell",
            "Earth",
            "Flow",
            "Flow Vanadium Redox",
            "Flow Zinc Bromine",
            "Flow Zinc Cerium",
            "Frog",
            "Fuel",
            "Galvanic Cell",
            "Glass",
            "Grove Cell",
            "Lead Acid",
            "Lead Acid Deep Cycle",
            "Lead Acid VRLA",
            "Lead Acid AGM",
            "Lead Acid Gel",
            "Leclanche Cell",
            "Lemon Potato",
            "Lithium",
            "Lithium Air",
            "Lithium Ion",
            "Lithium Ion Cobalt Oxide (ICR)",
            "Lithium Ion Manganese Oxide (IMR)",
            "Lithium Ion Polymer",
            "Lithium Iron Phosphate",
            "Lithium Sulfur",
            "Lithium Titanate",
            "Lithium Ion Thin Film",
            "Magnesium",
            "Magnesium Ion",
            "Mercury",
            "Molten Salt",
            "Nickel Cadmium",
            "Nickel Cadmium Vented Cell",
            "Nickel Hydrogen",
            "Nickel Iron ",
            "Nickel Metal Hydride",
            "Nickel Metal Hydride Low Self-Discharge",
            "Nickel Oxyhydroxide",
            "Nickel Oxyride",
            "Nickel Zinc",
            "Organic Radical",
            "Paper",
            "Polymer Based",
            "Polysulfide Bromide",
            "Potassium Ion",
            "Pulvermachers Chain",
            "Silicon Air",
            "Silver Calcium",
            "Silver Oxide",
            "Silver Zinc",
            "Sodium Ion",
            "Sodium Sulfur",
            "Solid State",
            "Sugar",
            "Super Iron",
            "UltraBattery",
            "Voltaic Pile",
            "Voltaic Pile Penny",
            "Voltaic Pile Trough",
            "Water Activated",
            "Weston Cell",
            "Zinc Air",
            "Zinc Carbon",
            "Zinc Chloride",
            "Zinc Ion",
            "Unknown"
          ],
          "readOnly": true,
          "type": "string"
        },
        "n": {
            "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "id": {
            "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["material"]
    }
  }
}