NetworkAccessManagement/code/API_definitions/Templates/capabilities-template.yaml at 232961411dc84cfc320454a2e942ff4aedf5a11f · camaraproject/NetworkAccessManagement · 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
openapi: 3.0.3
info:
  title: Device Capabilities
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: wip
  description: |
    API to retrieve capability information about operator-supplied or client devices.
    Currently only operator device (CPE) capabilities are implemented.
    Support for client devices is reserved for future use.

servers:
  - url: "{apiRoot}/network-access-management/vwip"
    variables:
      apiRoot:
        default: http://localhost:9091
        description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`

tags:
  - name: Retrieve Device Capabilities
    description: Operations to retrieve information about device capabilities

paths:
  /capabilities/devices/{deviceId}:
    get:
      description: Get capabilities for a device
      tags:
        - Retrieve Device Capabilities
      summary: Get capabilities for a device
      security:
        - openId:
            - network-access-management:device:read
      operationId: getDeviceCapabilities
      parameters:
        - $ref: "../Domain/Capabilities.yaml#/components/parameters/deviceId"
      responses:
        "200":
          description: Capabilities supported by the device
          content:
            application/json:
              schema:
                $ref: "../Domain/Capabilities.yaml#/components/schemas/DeviceCapabilities"
        "404":
          description: Device not found

components:
  securitySchemes:
    openId:
      type: openIdConnect
      description: OpenID Connect
      openIdConnectUrl: https://example.com/.well-known/openid-configuration