updatet license, added file api docs

2026-03-29 18:36:42 +02:00
parent 4484d762c2
commit 8afe71d925
1 changed files with 215 additions and 0 deletions
@@ -0,0 +1,215 @@
+basePath: /
+definitions:
+  descr.File:
+    properties:
+      checksum:
+        type: string
+      collection:
+        type: string
+      createdAt:
+        type: string
+      createdBy:
+        type: string
+      helmHash:
+        type: string
+      helmMeta:
+        type: string
+      id:
+        type: string
+      name:
+        type: string
+      size:
+        type: integer
+      type:
+        type: string
+      updatedAt:
+        type: string
+      updatedBy:
+        type: string
+    type: object
+host: localhost
+info:
+  contact:
+    email: support@swagger.io
+    name: API Support
+    url: http://www.swagger.io/support
+  description: API documentation
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+  title: Service API
+  version: "1.0"
+paths:
+  /v3/collection/{path}:
+    delete:
+      description: Delete collections
+      parameters:
+      - description: Collection path
+        in: path
+        name: path
+        required: true
+        type: string
+      responses:
+        "200":
+          description: OK
+        "404":
+          description: Not Found
+        "405":
+          description: Method Not Allowed
+      summary: Delete collections
+      tags:
+      - file
+  /v3/collections/{path}:
+    get:
+      description: List collections
+      parameters:
+      - description: Collection path
+        in: path
+        name: path
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              type: string
+            type: array
+        "404":
+          description: Not Found
+        "405":
+          description: Method Not Allowed
+      summary: List collections
+      tags:
+      - file
+  /v3/file/{filepath}:
+    delete:
+      description: Delete file
+      parameters:
+      - description: File path
+        in: path
+        name: filepath
+        required: true
+        type: string
+      responses:
+        "200":
+          description: OK
+        "404":
+          description: Not Found
+        "405":
+          description: Method Not Allowed
+      summary: Delete file
+      tags:
+      - file
+    get:
+      description: Get file
+      parameters:
+      - description: File path
+        in: path
+        name: filepath
+        required: true
+        type: string
+      produces:
+      - application/octet-stream
+      - application/vnd.cncf.helm.chart.content.v1.tar+gzip
+      responses:
+        "200":
+          description: OK
+        "404":
+          description: Not Found
+        "405":
+          description: Method Not Allowed
+      summary: Get file
+      tags:
+      - file
+    head:
+      description: Get file info
+      parameters:
+      - description: File path
+        in: path
+        name: filepath
+        required: true
+        type: string
+      responses:
+        "200":
+          description: OK
+          headers:
+            Content-Collection:
+              description: File collection
+              type: string
+            Content-Digest:
+              description: File digest
+              type: string
+            Content-Name:
+              description: File name
+              type: string
+            Content-Size:
+              description: File size
+              type: int64
+        "404":
+          description: Not Found
+        "405":
+          description: Method Not Allowed
+      summary: Get file info
+      tags:
+      - file
+    put:
+      description: Store file
+      parameters:
+      - description: File size
+        format: int64
+        in: header
+        name: Content-Size
+        required: true
+        type: integer
+      - description: File type
+        in: header
+        name: Content-Type
+        required: true
+        type: string
+      - description: File path
+        in: path
+        name: filepath
+        required: true
+        type: string
+      responses:
+        "200":
+          description: OK
+        "404":
+          description: Not Found
+        "405":
+          description: Method Not Allowed
+      summary: Store file
+      tags:
+      - file
+  /v3/files/{path}:
+    get:
+      description: List files
+      parameters:
+      - description: File path
+        in: path
+        name: path
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              $ref: '#/definitions/descr.File'
+            type: array
+        "404":
+          description: Not Found
+        "405":
+          description: Method Not Allowed
+      summary: List files
+      tags:
+      - file
+schemes:
+- http
+- https
+swagger: "2.0"