Improve swagger descriptions (without changing security settings) (#18205)

* Improve swagger definitions.

References #15624
This commit is contained in:
Niko Wenselowski 2023-02-23 12:57:50 +01:00 committed by GitHub
parent a79c0ad496
commit 10c54c0d82
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -22,7 +22,7 @@ paths:
/health: /health:
get: get:
summary: Check the status of Harbor components summary: Check the status of Harbor components
description: Check the status of Harbor components description: Check the status of Harbor components. This path does not require authentication.
tags: tags:
- health - health
operationId: getHealth operationId: getHealth
@ -4710,8 +4710,8 @@ paths:
/ping: /ping:
get: get:
operationId: getPing operationId: getPing
summary: Ping Harbor to check if it's alive. summary: Ping Harbor to check if the API server is alive.
description: This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components. description: This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components. This path does not require any authentication.
tags: tags:
- ping - ping
produces: produces:
@ -7485,7 +7485,7 @@ definitions:
description: The ID of the robot description: The ID of the robot
name: name:
type: string type: string
description: The name of the tag description: The name of the robot
description: description:
type: string type: string
description: The description of the robot description: The description of the robot
@ -7510,7 +7510,7 @@ definitions:
expires_at: expires_at:
type: integer type: integer
format: int64 format: int64
description: The expiration data of the robot description: The expiration date of the robot
permissions: permissions:
type: array type: array
items: items:
@ -7529,7 +7529,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: The name of the tag description: The name of the robot
description: description:
type: string type: string
description: The description of the robot description: The description of the robot
@ -7560,7 +7560,7 @@ definitions:
description: The ID of the robot description: The ID of the robot
name: name:
type: string type: string
description: The name of the tag description: The name of the robot
secret: secret:
type: string type: string
description: The secret of the robot description: The secret of the robot
@ -7571,7 +7571,7 @@ definitions:
expires_at: expires_at:
type: integer type: integer
format: int64 format: int64
description: The expiration data of the robot description: The expiration date of the robot
RobotSec: RobotSec:
type: object type: object
description: The response for refresh/update robot account secret. description: The response for refresh/update robot account secret.
@ -7597,10 +7597,10 @@ definitions:
properties: properties:
resource: resource:
type: string type: string
description: The resource of the access description: The resource of the access. Possible resources are *, artifact, artifact-addition, artifact-label, audit-log, catalog, configuration, distribution, garbage-collection, helm-chart, helm-chart-version, helm-chart-version-label, immutable-tag, label, ldap-user, log, member, metadata, notification-policy, preheat-instance, preheat-policy, project, quota, registry, replication, replication-adapter, replication-policy, repository, robot, scan, scan-all, scanner, system-volumes, tag, tag-retention, user, user-group or "" (for self-reference).
action: action:
type: string type: string
description: The action of the access description: The action of the access. Possible actions are *, pull, push, create, read, update, delete, list, operate, scanner-pull and stop.
effect: effect:
type: string type: string
description: The effect of the access description: The effect of the access
@ -9254,7 +9254,7 @@ definitions:
description: The component name description: The component name
status: status:
type: string type: string
description: The health status of component description: The health status of component. Is either "healthy" or "unhealthy".
error: error:
type: string type: string
description: (optional) The error message when the status is "unhealthy" description: (optional) The error message when the status is "unhealthy"