core/oic.wk.con.p.raml at master · WAvdBeek/core · 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
#%RAML 0.8
title: OCF Platform Configuration
version: v1-20160622
documentation:

  - title: OCF Copyright
    content: Copyright (c) 2017 Open Connectivity Foundation, Inc. All rights reserved.
  - title: OCF License
    content: !include LICENSE.md
  - title: OCF Disclaimer
    content: !include DISCLAIMER.md


schemas:
  - Conf_Platform: !include schemas/oic.wk.con.p-schema.json
  - Update_Platform: !include schemas/oic.wk.con.p-Update-schema.json

traits:
  - interface-all:
      queryParameters:
        if:
          enum: ["oic.if.rw", "oic.if.baseline"]
  - interface-rw:
      queryParameters:
        if:
          enum: ["oic.if.rw"]

/examplePlatformConfigurationResURI:
  displayName: Platform Configuration
  description: |
    Resource that allows for platform specific information to be configured.

  get:
    is: ["interface-all"]
    description: |
      Retrieves the current platform configuration settings
    responses:
      200:
        body:
          application/json:
            schema: Conf_Platform
            example: |
              {
                "rt":   ["oic.wk.con.p"],
                "mnpn": [ { "language": "en", "value": "My Friendly Device Name" } ]
              }

  post:
    is: ["interface-rw"]
    description: |
      Update the information about the platform
    body:
      application/json:
        schema: Update_Platform
        example: |
          {
            "n": "Nuevo nombre",
            "mnpn": [ { "language": "es", "value": "Nuevo nombre de Plataforma Amigable" } ]
          }
    responses:
      200:
        body:
          application/json:
            schema: Update_Platform
            example: |
              {
                "n": "Nuevo nombre",
                "mnpn": [ { "language": "es", "value": "Nuevo nombre de Plataforma Amigable" } ]
              }