nydus-api 0.4.1

APIs for Nydus Image Service
Documentation 
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

openapi: "3.0.2"
info:
  title: Nydus Service and Management APIs, version 2.
  description:
    This is the second version of RESTful Nydus service and management APIs to manage the global daemon and
    individual services.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: "0.1"
servers:
  - url: https://localhost/v2
paths:
  /daemon:
    summary: Returns general information about the nydus daemon
    get:
      operationId: describeDaemon
      responses:
        "200":
          description: Daemon information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DaemonInfo"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMsg"
    put:
      operationId: configureDaemon
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DaemonConf"
      responses:
        "204":
          description: "Successfully configure the daemon!"
        "500":
          description: "Can't configure the daemon!"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMsg"
  /blobs:
    summary: Manage cached blob objects
    ####################################################################
    get:
      operationId: getBlobObject
      responses:
        "200":
          description: Blob objects
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BlobObjectList"
        "404":
          description: "Blob object not found"
        "500":
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMsg"
    put:
      operationId: createBlobObject
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BlobObjectConf"
      responses:
        "204":
          description: "Successfully created the blob object!"
        "500":
          description: "Can't create the blob object!"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMsg"
    delete:
      operationId: deleteBlobObject
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BlobObjectParam"
      responses:
        "204":
          description: "Successfully deleted the blob object!"
        "500":
          description: "Can't delete the blob object!"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMsg"
      operationId: deleteBlobFile
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BlobId"
      responses:
        "204":
          description: "Successfully deleted the blob file!"
        "500":
          description: "Can't delete the blob file!"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMsg"
################################################################
components:
  schemas:
    DaemonInfo:
      type: object
      properties:
        version:
          type: object
          properties:
            package_ver:
              type: string
            git_commit:
              type: string
            build_time:
              type: string
            profile:
              type: string
            rustc:
              type: string
        id:
          type: string
        supervisor:
          type: string
        state:
          type: string
          enum:
            - INIT
            - RUNNING
            - UPGRADING
            - INTERRUPTED
            - STOPPED
            - UNKNOWN
    DaemonConf:
      type: object
      properties:
        log_level:
          type: string
          enum: [trace, debug, info, warn, error]
    ErrorMsg:
      type: object
      properties:
        code:
          description: Nydus defined error code indicating certain error type
          type: string
        message:
          description: Details about the error
          type: string