Files
mstore/swagger.yaml
2026-04-14 18:54:57 +02:00

492 lines
11 KiB
YAML

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
descr.Tags:
properties:
name:
type: string
tags:
items:
type: string
type: array
type: object
mstore_app_imageoper.CheckImagesResult:
properties:
repositories:
items:
type: string
type: array
type: object
mstore_app_imageoper.GetRefererResult:
properties:
reference:
type: string
type: object
mstore_app_imageoper.GetTagsResult:
properties:
tagDescr:
$ref: '#/definitions/descr.Tags'
type: object
mstore_app_imageoper.ListManifestsResult:
properties:
repositories:
items:
type: string
type: array
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:
/v2/_catalog:
get:
description: List manifests
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/mstore_app_imageoper.ListManifestsResult'
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: List manifests
tags:
- manifest
/v2/{name}/manifests/{reference}:
delete:
description: Delete manifest
parameters:
- description: Manifest path
in: path
name: name
required: true
type: string
- description: Manifest tag
in: path
name: reference
required: true
type: string
responses:
"202":
description: Accepted
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: Delete manifest
tags:
- manifest
get:
description: Get manifest
parameters:
- description: Manifest path
in: path
name: name
required: true
type: string
- description: Manifest tag
in: path
name: reference
required: true
type: string
responses:
"200":
description: OK
headers:
Content-Length:
description: Manifest size
type: string
Content-Type:
description: Manifest type
type: string
Docker-Content-Digest:
description: Manigest digest
type: string
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: Get manifest
tags:
- manifest
head:
description: Get manifest info
parameters:
- description: Manifest path
in: path
name: name
required: true
type: string
- description: Manifest tag
in: path
name: reference
required: true
type: string
responses:
"200":
description: OK
headers:
Content-Length:
description: Manifest size
type: string
Content-Type:
description: Manifest type
type: string
Docker-Content-Digest:
description: Manigest digest
type: string
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: Get manifest info
tags:
- manifest
put:
description: Put manifest
parameters:
- description: Manifest path
in: path
name: name
required: true
type: string
- description: Manifest tag
in: path
name: reference
required: true
type: string
- description: Manifest size
in: header
name: Content-Length
required: true
type: string
- description: Manifest type
in: header
name: Content-Type
required: true
type: string
responses:
"200":
description: OK
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: Put manifest
tags:
- manifest
/v2/{name}/referrers/{digest}:
get:
description: Get manifest referer
parameters:
- description: Manifest path
in: path
name: name
required: true
type: string
- description: Manifest digest
in: path
name: digest
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/mstore_app_imageoper.GetRefererResult'
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: Get manifest referer
tags:
- manifest
/v2/{name}/tags/list:
get:
description: List manifest tags
parameters:
- description: Manifest path
in: path
name: name
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/mstore_app_imageoper.GetTagsResult'
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: List manifest tags
tags:
- manifest
/v2/checker/:
post:
description: Check images
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/mstore_app_imageoper.CheckImagesResult'
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: Check images
tags:
- manifest
/v2/checker/{name}:
post:
description: Check images
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/mstore_app_imageoper.CheckImagesResult'
"404":
description: Not Found
"405":
description: Method Not Allowed
"500":
description: Internal Server Error
summary: Check images
tags:
- manifest
/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"