Infrastructure/zot
0
Fork 0
mirror of https://github.com/project-zot/zot.git synced 2024-12-16 21:56:37 -05:00
Code Issues Activity
zot/swagger/swagger.yaml

534 lines
13 KiB
YAML
Raw Normal View History

docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
definitions:
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
api.ExtensionList:
type: object
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
api.ImageManifest:
type: object
api.ImageTags:
properties:
name:
type: string
tags:
items:
type: string
type: array
type: object
api.RepositoryList:
properties:
repositories:
items:
type: string
type: array
type: object
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: APIs for Open Container Initiative Distribution Specification
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: Open Container Initiative Distribution Specification
version: v0.1.0-dev
paths:
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
/oras/artifacts/v1/{name:
get:
consumes:
- application/json
description: Get references for an image given a digest and artifact type
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: image digest
in: path
name: digest
required: true
type: string
- description: artifact type
in: query
name: artifactType
required: true
type: string
produces:
- application/json
responses:
"200":
description: ok
schema:
type: string
"404":
description: not found
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Get references for an image
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
/v2/:
get:
consumes:
- application/json
description: Check if this API version is supported
produces:
- application/json
responses:
"200":
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
description: ok".
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
schema:
type: string
summary: Check API support
/v2/_catalog:
get:
consumes:
- application/json
description: List all image repositories
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/api.RepositoryList'
"500":
description: internal server error
schema:
type: string
summary: List image repositories
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
/v2/_oci/ext/discover:
get:
consumes:
- application/json
description: List all extensions present on registry
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/api.ExtensionList'
summary: List Registry level extensions
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
/v2/{name}/blobs/{digest}:
delete:
consumes:
- application/json
description: Delete an image's blob/layer given a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: blob/layer digest
in: path
name: digest
required: true
type: string
produces:
- application/json
responses:
"202":
description: accepted
schema:
type: string
summary: Delete image blob/layer
get:
consumes:
- application/json
description: Get an image's blob/layer given a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: blob/layer digest
in: path
name: digest
required: true
type: string
produces:
- application/vnd.oci.image.layer.v1.tar+gzip
responses:
"200":
description: OK
schema:
$ref: '#/definitions/api.ImageManifest'
summary: Get image blob/layer
head:
consumes:
- application/json
description: Check an image's blob/layer given a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: blob/layer digest
in: path
name: digest
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
headers:
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
constants.DistContentDigestKey:
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
description: OK
type: object
schema:
$ref: '#/definitions/api.ImageManifest'
summary: Check image blob/layer
/v2/{name}/blobs/uploads:
post:
consumes:
- application/json
description: Create a new image blob/layer upload
parameters:
- description: repository name
in: path
name: name
required: true
type: string
produces:
- application/json
responses:
"202":
description: accepted
headers:
Location:
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
description: /v2/{name}/blobs/uploads/{session_id}
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
type: string
Range:
description: bytes=0-0
type: string
schema:
type: string
"404":
description: not found
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Create image blob/layer upload
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
/v2/{name}/blobs/uploads/{session_id}:
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
delete:
consumes:
- application/json
description: Delete an image's blob/layer given a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
- description: upload session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
in: path
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
name: session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
required: true
type: string
produces:
- application/json
responses:
"200":
description: ok
schema:
type: string
"404":
description: not found
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Delete image blob/layer
get:
consumes:
- application/json
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
description: Get an image's blob/layer upload given a session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
parameters:
- description: repository name
in: path
name: name
required: true
type: string
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
- description: upload session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
in: path
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
name: session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
required: true
type: string
produces:
- application/json
responses:
"204":
description: no content
schema:
type: string
"404":
description: not found
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Get image blob/layer upload
patch:
consumes:
- application/json
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
description: Resume an image's blob/layer upload given an session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
parameters:
- description: repository name
in: path
name: name
required: true
type: string
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
- description: upload session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
in: path
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
name: session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
required: true
type: string
produces:
- application/json
responses:
"202":
description: accepted
headers:
Location:
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
description: /v2/{name}/blobs/uploads/{session_id}
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
type: string
Range:
description: bytes=0-128
type: string
schema:
type: string
"400":
description: bad request
schema:
type: string
"404":
description: not found
schema:
type: string
"416":
description: range not satisfiable
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Resume image blob/layer upload
put:
consumes:
- application/json
description: Update and finish an image's blob/layer upload given a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
- description: upload session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
in: path
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
name: session_id
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
required: true
type: string
- description: blob/layer digest
in: query
name: digest
required: true
type: string
produces:
- application/json
responses:
"201":
description: created
schema:
type: string
"404":
description: not found
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Update image blob/layer upload
/v2/{name}/manifests/{reference}:
delete:
consumes:
- application/json
description: Delete an image's manifest given a reference or a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: image reference or digest
in: path
name: reference
required: true
type: string
produces:
- application/json
responses:
"200":
description: ok
schema:
type: string
summary: Delete image manifest
get:
consumes:
- application/json
description: Get an image's manifest given a reference or a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: image reference or digest
in: path
name: reference
required: true
type: string
produces:
- application/vnd.oci.image.manifest.v1+json
responses:
"200":
description: OK
headers:
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
constants.DistContentDigestKey:
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
description: OK
type: object
schema:
$ref: '#/definitions/api.ImageManifest'
"404":
description: not found
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Get image manifest
head:
consumes:
- application/json
description: Check an image's manifest given a reference or a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: image reference or digest
in: path
name: reference
required: true
type: string
produces:
- application/json
responses:
"200":
description: ok
headers:
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
cosntants.DistContentDigestKey:
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
description: OK
type: object
schema:
type: string
"404":
description: not found
schema:
type: string
"500":
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
description: internal server error".
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
schema:
type: string
summary: Check image manifest
put:
consumes:
- application/json
description: Update an image's manifest given a reference or a digest
parameters:
- description: repository name
in: path
name: name
required: true
type: string
- description: image reference or digest
in: path
name: reference
required: true
type: string
produces:
- application/json
responses:
"201":
description: created
schema:
type: string
"400":
description: bad request
schema:
type: string
"404":
description: not found
schema:
type: string
"500":
description: internal server error
schema:
type: string
summary: Update image manifest
/v2/{name}/tags/list:
get:
consumes:
- application/json
description: List all image tags in a repository
parameters:
- description: test
in: path
name: name
required: true
type: string
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
- description: limit entries for pagination
in: query
name: "n"
required: true
type: integer
- description: last tag value for pagination
in: query
name: last
required: true
type: string
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/api.ImageTags'
ext: use distribution spec route prefix for extension api Following the spec defined here https://github.com/opencontainers/distribution-spec/tree/main/extensions Signed-off-by: Shivam Mishra <shimish2@cisco.com>
2022-02-24 15:31:36 -05:00
"400":
description: bad request".
schema:
type: string
docs: commit docs so that zot binary build becomes easier swagger-based docs have been autogenerated from annotations and required a separate step and then the binary could be built along with these doc artifacts. Since we don't expect docs to change only when the dist-spec gets updated, we are committing them.
2019-12-11 17:07:24 -05:00
"404":
description: not found
schema:
type: string
summary: List image tags
swagger: "2.0"
Reference in a new issue Copy permalink