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/docs.go

1503 lines
53 KiB
Go
Raw Normal View History

fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
// Code generated by swaggo/swag. DO NOT EDIT.
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
swagger: rename 'docs/' to 'swagger/' Use 'docs/' for zot-related documentation. Signed-off-by: Ramkumar Chinchani <rchincha@cisco.com>
2021-10-20 16:01:06 -05:00
package swagger
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
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
import "github.com/swaggo/swag"
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
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
const docTemplate = `{
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
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"description": "{{escape .Description}}",
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
"title": "{{.Title}}",
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"contact": {},
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
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
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
"version": "{{.Version}}"
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
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"/oras/artifacts/v1/{name}/manifests/{digest}/referrers": {
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
"get": {
"description": "Get references for an image given a digest and artifact type",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Get references for an image",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "image digest",
"name": "digest",
"in": "path",
"required": true
},
{
"type": "string",
"description": "artifact type",
"name": "artifactType",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"404": {
"description": "not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"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
"/v2/": {
"get": {
"description": "Check if this API version is supported",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Check API support",
"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"
}
}
}
}
},
"/v2/_catalog": {
"get": {
"description": "List all image repositories",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "List image repositories",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.RepositoryList"
}
},
"500": {
"description": "internal server error",
"schema": {
"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
"/v2/_oci/ext/discover": {
"get": {
"description": "List all extensions present on registry",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "List Registry level extensions",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ExtensionList"
}
}
}
}
},
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"/v2/_zot/ext/cosign": {
"post": {
"description": "Upload cosign public keys for verifying signatures",
"consumes": [
"application/octet-stream"
],
"produces": [
"application/json"
],
"summary": "Upload cosign public keys for verifying signatures",
"parameters": [
{
"description": "Public key content",
"name": "requestBody",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "bad request\".",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error\".",
"schema": {
"type": "string"
}
}
}
}
},
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
"/v2/_zot/ext/mgmt": {
"get": {
"description": "Get current server configuration",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Get current server configuration",
feat: upload certificates and public keys for verifying signatures (#1485) In order to verify signatures, users could upload their certificates and public keys using these routes: -> for public keys: /v2/_zot/ext/mgmt?resource=signatures&tool=cosign -> for certificates: /v2/_zot/ext/mgmt?resource=signatures&tool=notation&truststoreType=ca&truststoreName=name Then the public keys will be stored under $rootdir/_cosign and the certificates will be stored under $rootdir/_notation/truststore/x509/$truststoreType/$truststoreName. Also, for notation case, the "truststores" field of $rootir/_notation/trustpolicy.json file will be updated with a new entry "$truststoreType:$truststoreName". Also based on the uploaded files, the information about the signatures validity will be updated periodically. Signed-off-by: Andreea-Lupu <andreealupu1470@yahoo.com>
2023-07-06 06:57:59 -05:00
"parameters": [
{
"enum": [
"config"
],
"type": "string",
"description": "specify resource",
"name": "resource",
"in": "query"
}
],
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/extensions.StrippedConfig"
}
},
"500": {
"description": "internal server error\".",
"schema": {
"type": "string"
}
}
}
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
}
},
"/v2/_zot/ext/notation": {
feat: upload certificates and public keys for verifying signatures (#1485) In order to verify signatures, users could upload their certificates and public keys using these routes: -> for public keys: /v2/_zot/ext/mgmt?resource=signatures&tool=cosign -> for certificates: /v2/_zot/ext/mgmt?resource=signatures&tool=notation&truststoreType=ca&truststoreName=name Then the public keys will be stored under $rootdir/_cosign and the certificates will be stored under $rootdir/_notation/truststore/x509/$truststoreType/$truststoreName. Also, for notation case, the "truststores" field of $rootir/_notation/trustpolicy.json file will be updated with a new entry "$truststoreType:$truststoreName". Also based on the uploaded files, the information about the signatures validity will be updated periodically. Signed-off-by: Andreea-Lupu <andreealupu1470@yahoo.com>
2023-07-06 06:57:59 -05:00
"post": {
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"description": "Upload notation certificates for verifying signatures",
feat: upload certificates and public keys for verifying signatures (#1485) In order to verify signatures, users could upload their certificates and public keys using these routes: -> for public keys: /v2/_zot/ext/mgmt?resource=signatures&tool=cosign -> for certificates: /v2/_zot/ext/mgmt?resource=signatures&tool=notation&truststoreType=ca&truststoreName=name Then the public keys will be stored under $rootdir/_cosign and the certificates will be stored under $rootdir/_notation/truststore/x509/$truststoreType/$truststoreName. Also, for notation case, the "truststores" field of $rootir/_notation/trustpolicy.json file will be updated with a new entry "$truststoreType:$truststoreName". Also based on the uploaded files, the information about the signatures validity will be updated periodically. Signed-off-by: Andreea-Lupu <andreealupu1470@yahoo.com>
2023-07-06 06:57:59 -05:00
"consumes": [
"application/octet-stream"
],
"produces": [
"application/json"
],
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"summary": "Upload notation certificates for verifying signatures",
feat: upload certificates and public keys for verifying signatures (#1485) In order to verify signatures, users could upload their certificates and public keys using these routes: -> for public keys: /v2/_zot/ext/mgmt?resource=signatures&tool=cosign -> for certificates: /v2/_zot/ext/mgmt?resource=signatures&tool=notation&truststoreType=ca&truststoreName=name Then the public keys will be stored under $rootdir/_cosign and the certificates will be stored under $rootdir/_notation/truststore/x509/$truststoreType/$truststoreName. Also, for notation case, the "truststores" field of $rootir/_notation/trustpolicy.json file will be updated with a new entry "$truststoreType:$truststoreName". Also based on the uploaded files, the information about the signatures validity will be updated periodically. Signed-off-by: Andreea-Lupu <andreealupu1470@yahoo.com>
2023-07-06 06:57:59 -05:00
"parameters": [
{
"type": "string",
"description": "truststore type",
"name": "truststoreType",
"in": "query"
},
{
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"description": "Certificate content",
feat: upload certificates and public keys for verifying signatures (#1485) In order to verify signatures, users could upload their certificates and public keys using these routes: -> for public keys: /v2/_zot/ext/mgmt?resource=signatures&tool=cosign -> for certificates: /v2/_zot/ext/mgmt?resource=signatures&tool=notation&truststoreType=ca&truststoreName=name Then the public keys will be stored under $rootdir/_cosign and the certificates will be stored under $rootdir/_notation/truststore/x509/$truststoreType/$truststoreName. Also, for notation case, the "truststores" field of $rootir/_notation/trustpolicy.json file will be updated with a new entry "$truststoreType:$truststoreName". Also based on the uploaded files, the information about the signatures validity will be updated periodically. Signed-off-by: Andreea-Lupu <andreealupu1470@yahoo.com>
2023-07-06 06:57:59 -05:00
"name": "requestBody",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "bad request\".",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error\".",
"schema": {
"type": "string"
}
}
}
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
}
},
"/v2/_zot/ext/userprefs": {
"put": {
"description": "Add bookmarks/stars info",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Add bookmarks/stars info",
"parameters": [
{
"enum": [
fix: removed quotation marks from enum in swagger docs (#1539) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-20 07:32:19 -05:00
"toggleBookmark",
"toggleStar"
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
],
"type": "string",
"description": "specify action",
"name": "action",
"in": "query",
"required": true
},
{
"type": "string",
"description": "repository name",
"name": "repo",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "bad request\".",
"schema": {
"type": "string"
}
},
"403": {
"description": "forbidden",
"schema": {
"type": "string"
}
},
"404": {
"description": "not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"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
"/v2/{name}/blobs/uploads": {
"post": {
"description": "Create a new image blob/layer upload",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Create image blob/layer upload",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": "accepted",
"schema": {
"type": "string"
},
"headers": {
"Location": {
"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": "/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
},
"Range": {
"type": "string",
Remove from Response header Range the 'bytes' string Conformance spec requires responding to PATCH requests with response header 'Content-Range' and value <range> Signed-off-by: Bogdan BIVOLARU <104334+bogdanbiv@users.noreply.github.com>
2022-06-29 03:12:20 -05:00
"description": "0-0"
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
}
}
},
refactor(authz): use a struct for user access control info operations (#1682) fix(authz): fix isAdmin not using groups to determine if a user is admin. fix(authz): return 401 instead of 403 403 is correct as per HTTP spec However authz is not part of dist-spec and clients know only about 401 So this is a compromise. Signed-off-by: Petu Eusebiu <peusebiu@cisco.com>
2023-09-01 13:13:53 -05:00
"401": {
"description": "unauthorized",
"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"
}
},
"500": {
"description": "internal server error",
"schema": {
"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
"/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
"get": {
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
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Get image blob/layer upload",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"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",
"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
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "no content",
"schema": {
"type": "string"
}
},
"404": {
"description": "not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "Update and finish an image's blob/layer upload given a digest",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Update image blob/layer upload",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"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",
"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
"in": "path",
"required": true
},
{
"type": "string",
"description": "blob/layer digest",
"name": "digest",
"in": "query",
"required": true
}
],
"responses": {
"201": {
"description": "created",
"schema": {
"type": "string"
}
},
"404": {
"description": "not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "Delete an image's blob/layer given a digest",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Delete image blob/layer",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"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",
"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
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"404": {
"description": "not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"schema": {
"type": "string"
}
}
}
},
"patch": {
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
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Resume image blob/layer upload",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"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",
"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
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": "accepted",
"schema": {
"type": "string"
},
"headers": {
"Location": {
"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": "/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
},
"Range": {
"type": "string",
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"description": "0-128"
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
}
}
},
"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"
}
}
}
}
},
"/v2/{name}/blobs/{digest}": {
"get": {
"description": "Get an image's blob/layer given a digest",
"consumes": [
"application/json"
],
"produces": [
"application/vnd.oci.image.layer.v1.tar+gzip"
],
"summary": "Get image blob/layer",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "blob/layer digest",
"name": "digest",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ImageManifest"
}
}
}
},
"delete": {
"description": "Delete an image's blob/layer given a digest",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Delete image blob/layer",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "blob/layer digest",
"name": "digest",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": "accepted",
"schema": {
"type": "string"
}
}
}
},
"head": {
"description": "Check an image's blob/layer given a digest",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Check image blob/layer",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "blob/layer digest",
"name": "digest",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ImageManifest"
},
"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": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"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
}
}
}
}
}
},
"/v2/{name}/manifests/{reference}": {
"get": {
"description": "Get an image's manifest given a reference or a digest",
"consumes": [
"application/json"
],
"produces": [
"application/vnd.oci.image.manifest.v1+json"
],
"summary": "Get image manifest",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "image reference or digest",
"name": "reference",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ImageManifest"
},
"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": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"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
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"schema": {
"type": "string"
}
}
}
},
"put": {
"description": "Update an image's manifest given a reference or a digest",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Update image manifest",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "image reference or digest",
"name": "reference",
"in": "path",
"required": true
}
],
"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"
}
}
}
},
"delete": {
"description": "Delete an image's manifest given a reference or a digest",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Delete image manifest",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "image reference or digest",
"name": "reference",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
}
}
},
"head": {
"description": "Check an image's manifest given a reference or a digest",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Check image manifest",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "image reference or digest",
"name": "reference",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
},
"headers": {
fix: swagger Makefile target broken on darwin (#1701) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-08-15 15:07:56 -05:00
"constants.DistContentDigestKey": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"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
}
}
},
"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"
}
}
}
}
},
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"/v2/{name}/referrers/{digest}": {
"get": {
"description": "Get referrers given a digest",
"consumes": [
"application/json"
],
"produces": [
"application/vnd.oci.image.index.v1+json"
],
"summary": "Get referrers for a given digest",
"parameters": [
{
"type": "string",
"description": "repository name",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "digest",
"name": "digest",
"in": "path",
"required": true
},
{
"type": "string",
"description": "artifact type",
"name": "artifactType",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/api.ImageIndex"
}
},
"404": {
"description": "not found",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"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
"/v2/{name}/tags/list": {
"get": {
"description": "List all image tags in a repository",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "List image tags",
"parameters": [
{
"type": "string",
feat: use the "zot" namespace for the authentication url (#1947) Some other minor fixes for swaggo comments (indentation and a bad description) Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-10-20 07:30:56 -05:00
"description": "repository name",
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
"name": "name",
"in": "path",
"required": true
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
},
{
"type": "integer",
"description": "limit entries for pagination",
"name": "n",
"in": "query",
"required": true
},
{
"type": "string",
"description": "last tag value for pagination",
"name": "last",
"in": "query",
"required": true
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
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
refactor: Reduce zb binary size (#1783) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-09-13 02:28:14 -05:00
"$ref": "#/definitions/common.ImageTags"
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
}
},
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"
}
}
}
}
feat: use the "zot" namespace for the authentication url (#1947) Some other minor fixes for swaggo comments (indentation and a bad description) Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-10-20 07:30:56 -05:00
},
"/zot/auth/apikey": {
"get": {
"description": "Get list of all API keys for a logged in user",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Get list of API keys for the current user",
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"401": {
"description": "unauthorized",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"schema": {
"type": "string"
}
}
}
},
"post": {
"description": "Can create an api key for a logged in user, based on the provided label and scopes.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Create an API key for the current user",
"parameters": [
{
"description": "api token id (UUID)",
"name": "id",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.APIKeyPayload"
}
}
],
"responses": {
"201": {
"description": "created",
"schema": {
"type": "string"
}
},
"400": {
"description": "bad request",
"schema": {
"type": "string"
}
},
"401": {
"description": "unauthorized",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "Revokes one current user API key based on given key ID",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Revokes one current user API key",
"parameters": [
{
"type": "string",
"description": "api token id (UUID)",
"name": "id",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "bad request",
"schema": {
"type": "string"
}
},
"401": {
"description": "unauthorized",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error",
"schema": {
"type": "string"
}
}
}
}
},
"/zot/auth/logout": {
"post": {
"description": "Logout by removing current session",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "Logout by removing current session",
"responses": {
"200": {
"description": "ok\".",
"schema": {
"type": "string"
}
},
"500": {
"description": "internal server error\".",
"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
}
},
"definitions": {
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"api.APIKeyPayload": {
"type": "object",
"properties": {
feat(apikey): added route to list user api keys (#1708) adding api key expiration date Signed-off-by: Petu Eusebiu <peusebiu@cisco.com>
2023-08-29 11:38:38 -05:00
"expirationDate": {
"type": "string"
},
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"label": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"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
"api.ExtensionList": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"type": "object",
"properties": {
"extensions": {
"type": "array",
"items": {
"$ref": "#/definitions/extensions.Extension"
}
}
}
},
"api.ImageIndex": {
"type": "object",
"properties": {
"annotations": {
"description": "Annotations contains arbitrary metadata for the image index.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"artifactType": {
"description": "ArtifactType specifies the IANA media type of artifact when the manifest is used for an artifact.",
"type": "string"
},
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"manifests": {
"description": "Manifests references platform specific manifests.",
"type": "array",
"items": {
"$ref": "#/definitions/github_com_opencontainers_image-spec_specs-go_v1.Descriptor"
}
},
"mediaType": {
"description": "MediaType specifies the type of this document data structure e.g. ` + "`" + `application/vnd.oci.image.index.v1+json` + "`" + `",
"type": "string"
},
"schemaVersion": {
"description": "SchemaVersion is the image manifest schema that this image follows",
"type": "integer"
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
},
"subject": {
"description": "Subject is an optional link from the image manifest to another manifest forming an association between the image manifest and the other manifest.",
"allOf": [
{
"$ref": "#/definitions/github_com_opencontainers_image-spec_specs-go_v1.Descriptor"
}
]
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
}
}
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
},
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": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"type": "object",
"properties": {
"annotations": {
"description": "Annotations contains arbitrary metadata for the image manifest.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"artifactType": {
"description": "ArtifactType specifies the IANA media type of artifact when the manifest is used for an artifact.",
"type": "string"
},
"config": {
"description": "Config references a configuration object for a container, by digest.\nThe referenced configuration object is a JSON blob that the runtime uses to set up the container.",
"allOf": [
{
"$ref": "#/definitions/github_com_opencontainers_image-spec_specs-go_v1.Descriptor"
}
]
},
"layers": {
"description": "Layers is an indexed list of layers referenced by the manifest.",
"type": "array",
"items": {
"$ref": "#/definitions/github_com_opencontainers_image-spec_specs-go_v1.Descriptor"
}
},
"mediaType": {
"description": "MediaType specifies the type of this document data structure e.g. ` + "`" + `application/vnd.oci.image.manifest.v1+json` + "`" + `",
"type": "string"
},
"schemaVersion": {
"description": "SchemaVersion is the image manifest schema that this image follows",
"type": "integer"
},
"subject": {
"description": "Subject is an optional link from the image manifest to another manifest forming an association between the image manifest and the other manifest.",
"allOf": [
{
"$ref": "#/definitions/github_com_opencontainers_image-spec_specs-go_v1.Descriptor"
}
]
}
}
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
},
refactor: Reduce zb binary size (#1783) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-09-13 02:28:14 -05:00
"api.RepositoryList": {
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": "object",
"properties": {
refactor: Reduce zb binary size (#1783) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-09-13 02:28:14 -05:00
"repositories": {
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": "array",
"items": {
"type": "string"
}
}
}
},
refactor: Reduce zb binary size (#1783) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-09-13 02:28:14 -05:00
"common.ImageTags": {
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": "object",
"properties": {
refactor: Reduce zb binary size (#1783) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-09-13 02:28:14 -05:00
"name": {
"type": "string"
},
"tags": {
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": "array",
"items": {
"type": "string"
}
}
}
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
},
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
"extensions.Auth": {
"type": "object",
"properties": {
"bearer": {
"$ref": "#/definitions/extensions.BearerConfig"
},
"htpasswd": {
"$ref": "#/definitions/extensions.HTPasswd"
},
"ldap": {
"type": "object",
"properties": {
"address": {
"type": "string"
}
}
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
},
"openid": {
"$ref": "#/definitions/extensions.OpenIDConfig"
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
}
}
},
"extensions.BearerConfig": {
"type": "object",
"properties": {
"realm": {
"type": "string"
},
"service": {
"type": "string"
}
}
},
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"extensions.Extension": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
"extensions.HTPasswd": {
"type": "object",
"properties": {
"path": {
"type": "string"
}
}
},
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
"extensions.OpenIDConfig": {
"type": "object",
"properties": {
"providers": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/extensions.OpenIDProviderConfig"
}
}
}
},
"extensions.OpenIDProviderConfig": {
feat(authn): add generic oidc and allow customizable name (#1691) Rebased and squashed Signed-off-by: Damien Degois <damien@degois.info>
2023-08-24 04:33:35 -05:00
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
refactor(extensions)!: refactor the extensions URLs and errors (#1636) BREAKING CHANGE: The functionality provided by the mgmt endpoint has beed redesigned - see details below BREAKING CHANGE: The API keys endpoint has been moved - see details below BREAKING CHANGE: The mgmt extension config has been removed - endpoint is now enabled by having both the search and the ui extensions enabled BREAKING CHANGE: The API keys configuration has been moved from extensions to http>auth>apikey mgmt and imagetrust extensions: - separate the _zot/ext/mgmt into 3 separate endpoints: _zot/ext/auth, _zot/ext/notation, _zot/ext/cosign - signature verification logic is in a separate `imagetrust` extension - better hanling or errors in case of signature uploads: logging and error codes (more 400 and less 500 errors) - add authz on signature uploads (and add a new middleware in common for this purpose) - remove the mgmt extension configuration - it is now enabled if the UI and the search extensions are enabled userprefs estension: - userprefs are enabled if both search and ui extensions are enabled (as opposed to just search) apikey extension is removed and logic moved into the api folder - Move apikeys code out of pkg/extensions and into pkg/api - Remove apikey configuration options from the extensions configuration and move it inside the http auth section - remove the build label apikeys other changes: - move most of the logic adding handlers to the extensions endpoints out of routes.go and into the extensions files. - add warnings in case the users are still using configurations with the obsolete settings for mgmt and api keys - add a new function in the extension package which could be a single point of starting backgroud tasks for all extensions - more clear methods for verifying specific extensions are enabled - fix http methods paired with the UI handlers - rebuild swagger docs Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2023-08-02 13:58:34 -05:00
},
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
"extensions.StrippedConfig": {
"type": "object",
"properties": {
"binaryType": {
"type": "string"
},
"distSpecVersion": {
"type": "string"
},
"http": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/definitions/extensions.Auth"
}
}
}
}
},
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"github_com_opencontainers_image-spec_specs-go_v1.Descriptor": {
"type": "object",
"properties": {
"annotations": {
"description": "Annotations contains arbitrary metadata relating to the targeted content.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"artifactType": {
"description": "ArtifactType is the IANA media type of this artifact.",
"type": "string"
},
"data": {
"description": "Data is an embedding of the targeted content. This is encoded as a base64\nstring when marshalled to JSON (automatically, by encoding/json). If\npresent, Data can be used directly to avoid fetching the targeted content.",
"type": "array",
"items": {
"type": "integer"
}
},
"digest": {
"description": "Digest is the digest of the targeted content.",
"type": "string"
},
"mediaType": {
"description": "MediaType is the media type of the object this schema refers to.",
"type": "string"
},
"platform": {
"description": "Platform describes the platform which the image in the manifest runs on.\n\nThis should only be used when referring to a manifest.",
"allOf": [
{
fix(ci/cd): detect uncommited swagger docs (#1724) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-08-23 11:21:43 -05:00
"$ref": "#/definitions/v1.Platform"
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
}
]
},
"size": {
"description": "Size specifies the size in bytes of the blob.",
"type": "integer"
},
"urls": {
"description": "URLs specifies a list of URLs from which this object MAY be downloaded",
"type": "array",
"items": {
"type": "string"
}
}
}
},
fix(ci/cd): detect uncommited swagger docs (#1724) Signed-off-by: Alexei Dodon <adodon@cisco.com>
2023-08-23 11:21:43 -05:00
"v1.Platform": {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"type": "object",
"properties": {
"architecture": {
fix: added swagger doc generation for mgmt and userprefs (#1530) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-19 12:43:25 -05:00
"description": "Architecture field specifies the CPU architecture, for example\n` + "`" + `amd64` + "`" + ` or ` + "`" + `ppc64le` + "`" + `.",
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
"type": "string"
},
"os": {
"description": "OS specifies the operating system, for example ` + "`" + `linux` + "`" + ` or ` + "`" + `windows` + "`" + `.",
"type": "string"
},
"os.features": {
"description": "OSFeatures is an optional field specifying an array of strings,\neach listing a required OS feature (for example on Windows ` + "`" + `win32k` + "`" + `).",
"type": "array",
"items": {
"type": "string"
}
},
"os.version": {
"description": "OSVersion is an optional field specifying the operating system\nversion, for example on Windows ` + "`" + `10.0.14393.1066` + "`" + `.",
"type": "string"
},
"variant": {
"description": "Variant is an optional field specifying a variant of the CPU, for\nexample ` + "`" + `v7` + "`" + ` to specify ARMv7 when architecture is ` + "`" + `arm` + "`" + `.",
"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
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
var SwaggerInfo = &swag.Spec{
Version: "v1.1.0-dev",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "Open Container Initiative Distribution Specification",
Description: "APIs for Open Container Initiative Distribution Specification",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
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
}
func init() {
fix: referrers now appears in swagger generated docs (#1488) Signed-off-by: Lisca Ana-Roberta <ana.kagome@yahoo.com>
2023-06-12 12:32:11 -05:00
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
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
}
Reference in a new issue Copy permalink