camara/openapi/camara-openapi.yml at main · api-evangelist/camara · 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
openapi: 3.1.0
info:
  title: CAMARA Quality On Demand API
  version: "1.0"
  description: >-
    Minimal OpenAPI 3.1 description of the CAMARA Quality On Demand (QoD) API
    for requesting bounded-duration network quality sessions on behalf of
    devices. Endpoints derived from the public CAMARA QoD specification.
  x-generated-from: https://github.com/camaraproject/QualityOnDemand
  x-generated-by: claude-crawl-2026-05-08
servers:
  - url: https://api.example.com/quality-on-demand/v0
    description: Reference server (operator-specific in practice)
security:
  - oAuth2ClientCredentials: []
tags:
  - name: Sessions
paths:
  /sessions:
    post:
      tags: [Sessions]
      summary: Create a new QoS session
      operationId: createSession
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: '#/components/schemas/QoDSession' }
      responses:
        '201':
          description: Session created
          content:
            application/json:
              schema: { $ref: '#/components/schemas/QoDSession' }
  /sessions/{sessionId}:
    parameters:
      - $ref: '#/components/parameters/SessionIdParam'
    get:
      tags: [Sessions]
      summary: Get QoS session information
      operationId: getSession
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: { $ref: '#/components/schemas/QoDSession' }
    delete:
      tags: [Sessions]
      summary: Delete a QoS session
      operationId: deleteSession
      responses:
        '204':
          description: Deleted
  /sessions/{sessionId}/extend:
    parameters:
      - $ref: '#/components/parameters/SessionIdParam'
    post:
      tags: [Sessions]
      summary: Extend the duration of an active session
      operationId: extendSession
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: '#/components/schemas/QoDSession' }
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: { $ref: '#/components/schemas/QoDSession' }
  /retrieve-sessions:
    post:
      tags: [Sessions]
      summary: Get QoS session information for a device
      operationId: retrieveSessionsForDevice
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: '#/components/schemas/QoDSession' }
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QoDSession'
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.example.com/oauth2/token
          scopes:
            qod: Quality On Demand session management
  parameters:
    SessionIdParam:
      name: sessionId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    QoDSession:
      type: object
      additionalProperties: true