Skip to content

Commit

Permalink
proposal: Update excample and description of Authorization property i…
Browse files Browse the repository at this point in the history
…n ScanRequest

Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
  • Loading branch information
danielpacak committed Oct 16, 2019
1 parent 40ac6cd commit 61475b6
Showing 1 changed file with 13 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -262,25 +262,31 @@ components:
properties:
url:
type: string
description: A base URL or the Docker Registry v2 API exposed by Harbor.
description: A base URL or the Docker Registry v2 API.
format: url
example: https://harbor-harbor-registry:5000
example: https://core.harbor.domain
authorization:
type: string
description: |
An optional value of the HTTP Authorization header sent with each request to the Docker Registry v2 API.
example: "Bearer JWTTOKENGOESHERE"
It's used to exchange Base64 encoded robot account credentials to a short lived JWT access token which
allows the underlying scanner to pull the artifact from the Docker Registry.
example: "Basic BASE64_ENCODED_CREDENTIALS"
Artifact:
type: object
properties:
repository:
type: string
description: A name of the Harbor repository containing the artifact.
example: library/oracle/nosql
description: The name of the Docker Registry repository containing the artifact.
example: library/mongo
digest:
type: string
description: The artifact's digest, consisting of an algorithm and hex portion.
example: "sha256:6c3c624b58dbbcd3c0dd82b4c53f04194d1247c6eebdaab7c610cf7d66709b3b"
mime_type:
type: string
description: The MIME type of the artifact.
example: "application/vnd.docker.distribution.manifest.v2+json"
HarborVulnerabilityReport:
type: object
properties:
Expand All @@ -307,7 +313,7 @@ components:
package:
type: string
description: |
An operating system or software dependency package containing the vulnerability.
An operating system package containing the vulnerability.
example: dpkg
version:
type: string
Expand Down Expand Up @@ -336,7 +342,7 @@ components:
type: string
format: uri
description: |
The list of link to the upstream database with the full description of the vulnerability.
The list of links to the upstream databases with the full description of the vulnerability.
format: uri
example:
- https://security-tracker.debian.org/tracker/CVE-2017-8283
Expand Down

0 comments on commit 61475b6

Please sign in to comment.