Created
December 20, 2022 10:17
-
-
Save t-huyeng/3c23a439437df47aa7314652308d30e8 to your computer and use it in GitHub Desktop.
vaccuum #214
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.1 | |
info: | |
title: Harbor API | |
description: These APIs provide services for manipulating Harbor project. | |
version: "2.0" | |
servers: | |
- url: https://{env}-[URL] | |
description: 'Harbor Server' | |
variables: | |
env: | |
enum: | |
- 'preprod' | |
- 'prod' | |
default: 'preprod' | |
security: | |
- basic: [] | |
paths: | |
/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags: | |
get: | |
tags: | |
- artifact | |
summary: List tags | |
description: List tags of the specific artifact | |
operationId: listTags | |
parameters: | |
- name: X-Request-Id | |
in: header | |
description: An unique ID for the request | |
schema: | |
minLength: 1 | |
type: string | |
- name: project_name | |
in: path | |
description: The name of the project | |
required: true | |
schema: | |
type: string | |
- name: repository_name | |
in: path | |
description: The name of the repository. If it contains slash, encode it with | |
URL encoding. e.g. a/b -> a%252Fb | |
required: true | |
schema: | |
type: string | |
- name: reference | |
in: path | |
description: The reference of the artifact, can be digest or tag | |
required: true | |
schema: | |
type: string | |
- name: q | |
in: query | |
description: Query string to query resources. Supported query patterns are | |
"exact match(k=v)", "fuzzy match(k=~v)", "range(k=[min~max])", "list with | |
union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 | |
v2 v3))". The value of range and list can be string(enclosed by " or '), | |
integer or time(in format "2020-04-09 02:36:00"). All of these query patterns | |
should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=~v2,k3=[min~max] | |
schema: | |
type: string | |
- name: sort | |
in: query | |
description: Sort the resource list in ascending or descending order. e.g. | |
sort by field1 in ascending orderr and field2 in descending order with "sort=field1,-field2" | |
schema: | |
type: string | |
- name: page | |
in: query | |
description: The page number | |
schema: | |
type: integer | |
format: int64 | |
default: 1 | |
- name: page_size | |
in: query | |
description: The size of per page | |
schema: | |
maximum: 100 | |
type: integer | |
format: int64 | |
default: 10 | |
- name: with_signature | |
in: query | |
description: Specify whether the signature is included inside the returning | |
tags | |
schema: | |
type: boolean | |
default: false | |
- name: with_immutable_status | |
in: query | |
description: Specify whether the immutable status is included inside the returning | |
tags | |
schema: | |
type: boolean | |
default: false | |
responses: | |
"200": | |
description: Success | |
headers: | |
X-Total-Count: | |
description: The total count of tags | |
schema: | |
type: integer | |
Link: | |
description: Link refers to the previous page and next page | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
type: array | |
items: | |
$ref: '#/components/schemas/Tag' | |
"400": | |
description: Bad request | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"401": | |
description: Unauthorized | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"403": | |
description: Forbidden | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"404": | |
description: Not found | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"500": | |
description: Internal server error | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
post: | |
tags: | |
- artifact | |
summary: Create tag | |
description: Create a tag for the specified artifact | |
operationId: createTag | |
parameters: | |
- name: X-Request-Id | |
in: header | |
description: An unique ID for the request | |
schema: | |
minLength: 1 | |
type: string | |
- name: project_name | |
in: path | |
description: The name of the project | |
required: true | |
schema: | |
type: string | |
- name: repository_name | |
in: path | |
description: The name of the repository. If it contains slash, encode it with | |
URL encoding. e.g. a/b -> a%252Fb | |
required: true | |
schema: | |
type: string | |
- name: reference | |
in: path | |
description: The reference of the artifact, can be digest or tag | |
required: true | |
schema: | |
type: string | |
requestBody: | |
description: The JSON object of tag. | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Tag' | |
required: true | |
responses: | |
"201": | |
description: Created | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
Location: | |
description: The location of the resource | |
schema: | |
type: string | |
"400": | |
description: Bad request | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"401": | |
description: Unauthorized | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"403": | |
description: Forbidden | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"404": | |
description: Not found | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"405": | |
description: Method not allowed | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"409": | |
description: Conflict | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
"500": | |
description: Internal server error | |
headers: | |
X-Request-Id: | |
description: The ID of the corresponding request for the response | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Errors' | |
x-codegen-request-body-name: tag | |
components: | |
securitySchemes: | |
basic: | |
type: http | |
scheme: basic | |
schemas: | |
Errors: | |
type: object | |
properties: | |
errors: | |
type: array | |
items: | |
$ref: '#/components/schemas/Error' | |
description: The error array that describe the errors got during the handling | |
of request | |
Error: | |
type: object | |
properties: | |
code: | |
type: string | |
description: The error code | |
message: | |
type: string | |
description: The error message | |
description: a model for all the error response coming from harbor | |
Tag: | |
type: object | |
properties: | |
id: | |
type: integer | |
description: The ID of the tag | |
format: int64 | |
repository_id: | |
type: integer | |
description: The ID of the repository that the tag belongs to | |
format: int64 | |
artifact_id: | |
type: integer | |
description: The ID of the artifact that the tag attached to | |
format: int64 | |
name: | |
type: string | |
description: The name of the tag | |
push_time: | |
type: string | |
description: The push time of the tag | |
format: date-time | |
pull_time: | |
type: string | |
description: The latest pull time of the tag | |
format: date-time | |
immutable: | |
type: boolean | |
description: The immutable status of the tag | |
x-omitempty: false | |
signed: | |
type: boolean | |
description: The attribute indicates whether the tag is signed or not | |
x-omitempty: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<!DOCTYPE html> | |
<html lang="en" class="sl-theme-dark"> | |
<head> | |
<title>vacuum HTML Report</title> | |
<!-- this file has been autogenerated by vacuum https://quobix.com/vacuum --> | |
<meta charset="UTF-8"> | |
<meta name="description" content="report generated by vacuum"> | |
<meta name="viewport" content="width=device-width, initial-scale=1.0"><script> | |
/*! For license information please see vacuumReport.js.LICENSE.txt */ | |
(()=>{"use strict";var e={408:(e,t,o)=>{o.d(t,{Z:()=>l});var r=o(81),i=o.n(r),a=o(645),n=o.n(a)()(i());n.push([e.id,':root{--global-font-size:15px;--global-line-height:1.4em;--global-space:10px;--font-stack:Menlo,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono,Courier New,monospace,serif;--mono-font-stack:Menlo,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono,Courier New,monospace,serif;--background-color:#fff;--page-width:60em;--font-color:#151515;--invert-font-color:#fff;--primary-color:#1a95e0;--secondary-color:#727578;--error-color:#d20962;--progress-bar-background:#727578;--progress-bar-fill:#151515;--code-bg-color:#e8eff2;--input-style:solid;--display-h1-decoration:none}*{box-sizing:border-box;text-rendering:geometricPrecision}::-moz-selection{background:var(--primary-color);color:var(--invert-font-color)}::selection{background:var(--primary-color);color:var(--invert-font-color)}body{font-size:var(--global-font-size);color:var(--font-color);line-height:var(--global-line-height);margin:0;font-family:var(--font-stack);word-wrap:break-word;background-color:var(--background-color)}.logo,h1,h2,h3,h4,h5,h6{line-height:var(--global-line-height)}a{cursor:pointer;color:var(--primary-color);text-decoration:none}a:hover{background-color:var(--primary-color);color:var(--invert-font-color)}em{font-size:var(--global-font-size);font-style:italic;font-family:var(--font-stack);color:var(--font-color)}blockquote,code,em,strong{line-height:var(--global-line-height)}.logo,blockquote,code,footer,h1,h2,h3,h4,h5,h6,header,li,ol,p,section,ul{float:none;margin:0;padding:0}.logo,blockquote,h1,ol,p,ul{margin-top:calc(var(--global-space) * 2);margin-bottom:calc(var(--global-space) * 2)}.logo,h1{position:relative;display:inline-block;display:table-cell;padding:calc(var(--global-space) * 2) 0 calc(var(--global-space) * 2);margin:0;overflow:hidden;font-weight:600}h1::after{content:"====================================================================================================";position:absolute;bottom:5px;left:0;display:var(--display-h1-decoration)}.logo+*,h1+*{margin-top:0}h2,h3,h4,h5,h6{position:relative;margin-bottom:var(--global-line-height);font-weight:600}blockquote{position:relative;padding-left:calc(var(--global-space) * 2);padding-left:2ch;overflow:hidden}blockquote::after{content:">\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>\\A>";white-space:pre;position:absolute;top:0;left:0;line-height:var(--global-line-height);color:#9ca2ab}code{font-weight:inherit;background-color:var(--code-bg-color);font-family:var(--mono-font-stack)}code::after,code::before{content:"`";display:inline}pre code::after,pre code::before{content:""}pre{display:block;word-break:break-all;word-wrap:break-word;color:var(--secondary-color);background-color:var(--background-color);border:1px solid var(--secondary-color);padding:var(--global-space);white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap}pre code{overflow-x:scroll;padding:0;margin:0;display:inline-block;min-width:100%;font-family:var(--mono-font-stack)}.terminal .logo,.terminal blockquote,.terminal code,.terminal h1,.terminal h2,.terminal h3,.terminal h4,.terminal h5,.terminal h6,.terminal strong{font-size:var(--global-font-size);font-style:normal;font-family:var(--font-stack);color:var(--font-color)}.terminal-prompt{position:relative;white-space:nowrap}.terminal-prompt::before{content:"> "}.terminal-prompt::after{content:"";-webkit-animation:cursor .8s infinite;animation:cursor .8s infinite;background:var(--primary-color);border-radius:0;display:inline-block;height:1em;margin-left:.2em;width:3px;bottom:-2px;position:relative}@-webkit-keyframes cursor{0%{opacity:0}50%{opacity:1}to{opacity:0}}@keyframes cursor{0%{opacity:0}50%{opacity:1}to{opacity:0}}li,li>ul>li{position:relative;display:block;padding-left:calc(var(--global-space) * 2)}nav>ul>li{padding-left:0}li::after{position:absolute;top:0;left:0}ul>li::after{content:"-"}nav ul>li::after{content:""}ol li::before{content:counters(item, ".") ". ";counter-increment:item}ol ol li::before{content:counters(item, ".") " ";counter-increment:item}.terminal-menu li::after,.terminal-menu li::before{display:none}ol{counter-reset:item}ol li:nth-child(n+10)::after{left:-7px}ol ol{margin-top:0;margin-bottom:0}.terminal-menu{width:100%}.terminal-nav{display:flex;flex-direction:column;align-items:flex-start}ul ul{margin-top:0;margin-bottom:0}.terminal-menu ul{list-style-type:none;padding:0!important;display:flex;flex-direction:column;width:100%;flex-grow:1;font-size:var(--global-font-size);margin-top:0}.terminal-menu li{display:flex;margin:0 0 .5em 0;padding:0}ol.terminal-toc li{border-bottom:1px dotted var(--secondary-color);padding:0;margin-bottom:15px}.terminal-menu li:last-child{margin-bottom:0}ol.terminal-toc li a{margin:4px 4px 4px 0;background:var(--background-color);position:relative;top:6px;text-align:left;padding-right:4px}.terminal-menu li a:not(.btn){text-decoration:none;display:block;width:100%;border:none;color:var(--secondary-color)}.terminal-menu li a.active{color:var(--font-color)}.terminal-menu li a:hover{background:0 0;color:inherit}ol.terminal-toc li::before{content:counters(item, ".") ". ";counter-increment:item;position:absolute;right:0;background:var(--background-color);padding:4px 0 4px 4px;bottom:-8px}ol.terminal-toc li a:hover{background:var(--primary-color);color:var(--invert-font-color)}hr{position:relative;overflow:hidden;margin:calc(var(--global-space) * 4) 0;border:0;border-bottom:1px dashed var(--secondary-color)}p{margin:0 0 var(--global-line-height);color:var(--global-font-color)}.container{max-width:var(--page-width)}.container,.container-fluid{margin:0 auto;padding:0 calc(var(--global-space) * 2)}img{width:100%}.progress-bar{height:8px;background-color:var(--progress-bar-background);margin:12px 0}.progress-bar.progress-bar-show-percent{margin-top:38px}.progress-bar-filled{background-color:var(--progress-bar-fill);height:100%;transition:width .3s ease;position:relative;width:0}.progress-bar-filled::before{content:"";border:6px solid transparent;border-top-color:var(--progress-bar-fill);position:absolute;top:-12px;right:-6px}.progress-bar-filled::after{color:var(--progress-bar-fill);content:attr(data-filled);display:block;font-size:12px;white-space:nowrap;position:absolute;border:6px solid transparent;top:-38px;right:0;transform:translateX(50%)}.progress-bar-no-arrow>.progress-bar-filled::after,.progress-bar-no-arrow>.progress-bar-filled::before{content:"";display:none;visibility:hidden;opacity:0}table{width:100%;border-collapse:collapse;margin:var(--global-line-height) 0;color:var(--font-color);font-size:var(--global-font-size)}table td,table th{vertical-align:top;border:1px solid var(--font-color);line-height:var(--global-line-height);padding:calc(var(--global-space)/ 2);font-size:1em}table thead th{font-size:1em}table tfoot tr th{font-weight:500}table caption{font-size:1em;margin:0 0 1em 0}table tbody td:first-child{font-weight:700;color:var(--secondary-color)}.form{width:100%}fieldset{border:1px solid var(--font-color);padding:1em}label{font-size:1em;color:var(--font-color)}input[type=email],input[type=number],input[type=password],input[type=search],input[type=text]{border:1px var(--input-style) var(--font-color);width:100%;padding:.7em .5em;font-size:1em;font-family:var(--font-stack);-webkit-appearance:none;border-radius:0}input[type=email]:active,input[type=email]:focus,input[type=number]:active,input[type=number]:focus,input[type=password]:active,input[type=password]:focus,input[type=search]:active,input[type=search]:focus,input[type=text]:active,input[type=text]:focus{outline:0;-webkit-appearance:none;border:1px solid var(--font-color)}input[type=email]:not(:placeholder-shown):invalid,input[type=number]:not(:placeholder-shown):invalid,input[type=password]:not(:placeholder-shown):invalid,input[type=search]:not(:placeholder-shown):invalid,input[type=text]:not(:placeholder-shown):invalid{border-color:var(--error-color)}input,textarea{color:var(--font-color);background-color:var(--background-color)}input::-webkit-input-placeholder,textarea::-webkit-input-placeholder{color:var(--secondary-color)!important;opacity:1}input::-moz-placeholder,textarea::-moz-placeholder{color:var(--secondary-color)!important;opacity:1}input:-ms-input-placeholder,textarea:-ms-input-placeholder{color:var(--secondary-color)!important;opacity:1}input::-ms-input-placeholder,textarea::-ms-input-placeholder{color:var(--secondary-color)!important;opacity:1}input::placeholder,textarea::placeholder{color:var(--secondary-color)!important;opacity:1}textarea{height:auto;width:100%;resize:none;border:1px var(--input-style) var(--font-color);padding:.5em;font-size:1em;font-family:var(--font-stack);-webkit-appearance:none;border-radius:0}textarea:focus{outline:0;-webkit-appearance:none;border:1px solid var(--font-color)}textarea:not(:placeholder-shown):invalid{border-color:var(--error-color)}input:-webkit-autofill,input:-webkit-autofill:focus textarea:-webkit-autofill,input:-webkit-autofill:hover,select:-webkit-autofill,select:-webkit-autofill:focus,select:-webkit-autofill:hover,textarea:-webkit-autofill:hover textarea:-webkit-autofill:focus{border:1px solid var(--font-color);-webkit-text-fill-color:var(--font-color);box-shadow:0 0 0 1000px var(--invert-font-color) inset;-webkit-box-shadow:0 0 0 1000px var(--invert-font-color) inset;transition:background-color 5000s ease-in-out 0s}.form-group{margin-bottom:var(--global-line-height);overflow:auto}.btn{border-style:solid;border-width:1px;display:inline-flex;align-items:center;justify-content:center;cursor:pointer;outline:0;padding:.65em 2em;font-size:1em;font-family:inherit;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;position:relative;z-index:1}.btn:active{box-shadow:none}.btn.btn-ghost{border-color:var(--font-color);color:var(--font-color);background-color:transparent}.btn.btn-ghost:focus,.btn.btn-ghost:hover{border-color:var(--tertiary-color);color:var(--tertiary-color);z-index:2}.btn.btn-ghost:hover{background-color:transparent}.btn-block{width:100%;display:flex}.btn-default{background-color:var(--font-color);border-color:var(--invert-font-color);color:var(--invert-font-color)}.btn-default:focus:not(.btn-ghost),.btn-default:hover{background-color:var(--secondary-color);color:var(--invert-font-color)}.btn-default.btn-ghost:focus,.btn-default.btn-ghost:hover{border-color:var(--secondary-color);color:var(--secondary-color);z-index:2}.btn-error{color:var(--invert-font-color);background-color:var(--error-color);border:1px solid var(--error-color)}.btn-error:focus:not(.btn-ghost),.btn-error:hover{background-color:var(--error-color);border-color:var(--error-color)}.btn-error.btn-ghost{border-color:var(--error-color);color:var(--error-color)}.btn-error.btn-ghost:focus,.btn-error.btn-ghost:hover{border-color:var(--error-color);color:var(--error-color);z-index:2}.btn-primary{color:var(--invert-font-color);background-color:var(--primary-color);border:1px solid var(--primary-color)}.btn-primary:focus:not(.btn-ghost),.btn-primary:hover{background-color:var(--primary-color);border-color:var(--primary-color)}.btn-primary.btn-ghost{border-color:var(--primary-color);color:var(--primary-color)}.btn-primary.btn-ghost:focus,.btn-primary.btn-ghost:hover{border-color:var(--primary-color);color:var(--primary-color);z-index:2}.btn-small{padding:.5em 1.3em!important;font-size:.9em!important}.btn-group{overflow:auto}.btn-group .btn{float:left}.btn-group .btn-ghost:not(:first-child){margin-left:-1px}.terminal-card{border:1px solid var(--secondary-color)}.terminal-card>header{color:var(--invert-font-color);text-align:center;background-color:var(--secondary-color);padding:.5em 0}.terminal-card>div:first-of-type{padding:var(--global-space)}.terminal-timeline{position:relative;padding-left:70px}.terminal-timeline::before{content:\' \';background:var(--secondary-color);display:inline-block;position:absolute;left:35px;width:2px;height:100%;z-index:400}.terminal-timeline .terminal-card{margin-bottom:25px}.terminal-timeline .terminal-card::before{content:\' \';background:var(--invert-font-color);border:2px solid var(--secondary-color);display:inline-block;position:absolute;margin-top:25px;left:26px;width:15px;height:15px;z-index:400}.terminal-alert{color:var(--font-color);padding:1em;border:1px solid var(--font-color);margin-bottom:var(--global-space)}.terminal-alert-error{color:var(--error-color);border-color:var(--error-color)}.terminal-alert-primary{color:var(--primary-color);border-color:var(--primary-color)}@media screen and (max-width:960px){label{display:block;width:100%}pre::-webkit-scrollbar{height:3px}}@media screen and (max-width:480px){form{width:100%}}@media only screen and (min-width:30em){.terminal-nav{flex-direction:row;align-items:center}.terminal-menu ul{flex-direction:row;justify-items:flex-end;align-items:center;justify-content:flex-end;margin-top:calc(var(--global-space) * 2)}.terminal-menu li{margin:0;margin-right:2em}.terminal-menu li:last-child{margin-right:0}}.terminal-media:not(:last-child){margin-bottom:1.25rem}.terminal-media-left{padding-right:var(--global-space)}.terminal-media-left,.terminal-media-right{display:table-cell;vertical-align:top}.terminal-media-right{padding-left:var(--global-space)}.terminal-media-body{display:table-cell;vertical-align:top}.terminal-media-heading{font-size:1em;font-weight:700}.terminal-media-content{margin-top:.3rem}.terminal-placeholder{background-color:var(--secondary-color);text-align:center;color:var(--font-color);font-size:1rem;border:1px solid var(--secondary-color)}figure>img{padding:0}.terminal-avatarholder{width:calc(var(--global-space) * 5);height:calc(var(--global-space) * 5)}.terminal-avatarholder img{padding:0}figure{margin:0}figure>figcaption{color:var(--secondary-color);text-align:center}.hljs{display:block;overflow-x:auto;padding:.5em;background:var(--block-background-color);color:var(--font-color)}.hljs-comment,.hljs-quote{color:var(--secondary-color)}.hljs-variable{color:var(--font-color)}.hljs-built_in,.hljs-keyword,.hljs-name,.hljs-selector-tag,.hljs-tag{color:var(--primary-color)}.hljs-addition,.hljs-attribute,.hljs-literal,.hljs-section,.hljs-string,.hljs-template-tag,.hljs-template-variable,.hljs-title,.hljs-type{color:var(--secondary-color)}.hljs-string{color:var(--secondary-color)}.hljs-deletion,.hljs-meta,.hljs-selector-attr,.hljs-selector-pseudo{color:var(--primary-color)}.hljs-doctag{color:var(--secondary-color)}.hljs-attr{color:var(--primary-color)}.hljs-bullet,.hljs-link,.hljs-symbol{color:var(--primary-color)}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}',""]);const l=n},645:e=>{e.exports=function(e){var t=[];return t.toString=function(){return this.map((function(t){var o="",r=void 0!==t[5];return t[4]&&(o+="@supports (".concat(t[4],") {")),t[2]&&(o+="@media ".concat(t[2]," {")),r&&(o+="@layer".concat(t[5].length>0?" ".concat(t[5]):""," {")),o+=e(t),r&&(o+="}"),t[2]&&(o+="}"),t[4]&&(o+="}"),o})).join("")},t.i=function(e,o,r,i,a){"string"==typeof e&&(e=[[null,e,void 0]]);var n={};if(r)for(var l=0;l<this.length;l++){var s=this[l][0];null!=s&&(n[s]=!0)}for(var c=0;c<e.length;c++){var d=[].concat(e[c]);r&&n[d[0]]||(void 0!==a&&(void 0===d[5]||(d[1]="@layer".concat(d[5].length>0?" ".concat(d[5]):""," {").concat(d[1],"}")),d[5]=a),o&&(d[2]?(d[1]="@media ".concat(d[2]," {").concat(d[1],"}"),d[2]=o):d[2]=o),i&&(d[4]?(d[1]="@supports (".concat(d[4],") {").concat(d[1],"}"),d[4]=i):d[4]="".concat(i)),t.push(d))}},t}},81:e=>{e.exports=function(e){return e[1]}},379:e=>{var t=[];function o(e){for(var o=-1,r=0;r<t.length;r++)if(t[r].identifier===e){o=r;break}return o}function r(e,r){for(var a={},n=[],l=0;l<e.length;l++){var s=e[l],c=r.base?s[0]+r.base:s[0],d=a[c]||0,p="".concat(c," ").concat(d);a[c]=d+1;var h=o(p),u={css:s[1],media:s[2],sourceMap:s[3],supports:s[4],layer:s[5]};if(-1!==h)t[h].references++,t[h].updater(u);else{var v=i(u,r);r.byIndex=l,t.splice(l,0,{identifier:p,updater:v,references:1})}n.push(p)}return n}function i(e,t){var o=t.domAPI(t);return o.update(e),function(t){if(t){if(t.css===e.css&&t.media===e.media&&t.sourceMap===e.sourceMap&&t.supports===e.supports&&t.layer===e.layer)return;o.update(e=t)}else o.remove()}}e.exports=function(e,i){var a=r(e=e||[],i=i||{});return function(e){e=e||[];for(var n=0;n<a.length;n++){var l=o(a[n]);t[l].references--}for(var s=r(e,i),c=0;c<a.length;c++){var d=o(a[c]);0===t[d].references&&(t[d].updater(),t.splice(d,1))}a=s}}},569:e=>{var t={};e.exports=function(e,o){var r=function(e){if(void 0===t[e]){var o=document.querySelector(e);if(window.HTMLIFrameElement&&o instanceof window.HTMLIFrameElement)try{o=o.contentDocument.head}catch(e){o=null}t[e]=o}return t[e]}(e);if(!r)throw new Error("Couldn't find a style target. This probably means that the value for the 'insert' parameter is invalid.");r.appendChild(o)}},216:e=>{e.exports=function(e){var t=document.createElement("style");return e.setAttributes(t,e.attributes),e.insert(t,e.options),t}},565:(e,t,o)=>{e.exports=function(e){var t=o.nc;t&&e.setAttribute("nonce",t)}},795:e=>{e.exports=function(e){var t=e.insertStyleElement(e);return{update:function(o){!function(e,t,o){var r="";o.supports&&(r+="@supports (".concat(o.supports,") {")),o.media&&(r+="@media ".concat(o.media," {"));var i=void 0!==o.layer;i&&(r+="@layer".concat(o.layer.length>0?" ".concat(o.layer):""," {")),r+=o.css,i&&(r+="}"),o.media&&(r+="}"),o.supports&&(r+="}");var a=o.sourceMap;a&&"undefined"!=typeof btoa&&(r+="\n/*# sourceMappingURL=data:application/json;base64,".concat(btoa(unescape(encodeURIComponent(JSON.stringify(a))))," */")),t.styleTagTransform(r,e,t.options)}(t,e,o)},remove:function(){!function(e){if(null===e.parentNode)return!1;e.parentNode.removeChild(e)}(t)}}}},589:e=>{e.exports=function(e,t){if(t.styleSheet)t.styleSheet.cssText=e;else{for(;t.firstChild;)t.removeChild(t.firstChild);t.appendChild(document.createTextNode(e))}}}},t={};function o(r){var i=t[r];if(void 0!==i)return i.exports;var a=t[r]={id:r,exports:{}};return e[r](a,a.exports,o),a.exports}o.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return o.d(t,{a:t}),t},o.d=(e,t)=>{for(var r in t)o.o(t,r)&&!o.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o.nc=void 0,(()=>{var e=o(379),t=o.n(e),r=o(795),i=o.n(r),a=o(569),n=o.n(a),l=o(565),s=o.n(l),c=o(216),d=o.n(c),p=o(589),h=o.n(p),u=o(408),v={};v.styleTagTransform=h(),v.setAttributes=s(),v.insert=n().bind(null,"head"),v.domAPI=i(),v.insertStyleElement=d(),t()(u.Z,v),u.Z&&u.Z.locals&&u.Z.locals;const m=window,f=m.ShadowRoot&&(void 0===m.ShadyCSS||m.ShadyCSS.nativeShadow)&&"adoptedStyleSheets"in Document.prototype&&"replace"in CSSStyleSheet.prototype,g=Symbol(),b=new WeakMap;class y{constructor(e,t,o){if(this._$cssResult$=!0,o!==g)throw Error("CSSResult is not constructable. Use `unsafeCSS` or `css` instead.");this.cssText=e,this.t=t}get styleSheet(){let e=this.o;const t=this.t;if(f&&void 0===e){const o=void 0!==t&&1===t.length;o&&(e=b.get(t)),void 0===e&&((this.o=e=new CSSStyleSheet).replaceSync(this.cssText),o&&b.set(t,e))}return e}toString(){return this.cssText}}const w=(e,...t)=>{const o=1===e.length?e[0]:t.reduce(((t,o,r)=>t+(e=>{if(!0===e._$cssResult$)return e.cssText;if("number"==typeof e)return e;throw Error("Value passed to 'css' function must be a 'css' function result: "+e+". Use 'unsafeCSS' to pass non-literal values, but take care to ensure page security.")})(o)+e[r+1]),e[0]);return new y(o,e,g)},x=f?e=>e:e=>e instanceof CSSStyleSheet?(e=>{let t="";for(const o of e.cssRules)t+=o.cssText;return(e=>new y("string"==typeof e?e:e+"",void 0,g))(t)})(e):e;var A;const k=window,$=k.trustedTypes,_=$?$.emptyScript:"",S=k.reactiveElementPolyfillSupport,E={toAttribute(e,t){switch(t){case Boolean:e=e?_:null;break;case Object:case Array:e=null==e?e:JSON.stringify(e)}return e},fromAttribute(e,t){let o=e;switch(t){case Boolean:o=null!==e;break;case Number:o=null===e?null:Number(e);break;case Object:case Array:try{o=JSON.parse(e)}catch(e){o=null}}return o}},C=(e,t)=>t!==e&&(t==t||e==e),z={attribute:!0,type:String,converter:E,reflect:!1,hasChanged:C};class j extends HTMLElement{constructor(){super(),this._$Ei=new Map,this.isUpdatePending=!1,this.hasUpdated=!1,this._$El=null,this.u()}static addInitializer(e){var t;this.finalize(),(null!==(t=this.h)&&void 0!==t?t:this.h=[]).push(e)}static get observedAttributes(){this.finalize();const e=[];return this.elementProperties.forEach(((t,o)=>{const r=this._$Ep(o,t);void 0!==r&&(this._$Ev.set(r,o),e.push(r))})),e}static createProperty(e,t=z){if(t.state&&(t.attribute=!1),this.finalize(),this.elementProperties.set(e,t),!t.noAccessor&&!this.prototype.hasOwnProperty(e)){const o="symbol"==typeof e?Symbol():"__"+e,r=this.getPropertyDescriptor(e,o,t);void 0!==r&&Object.defineProperty(this.prototype,e,r)}}static getPropertyDescriptor(e,t,o){return{get(){return this[t]},set(r){const i=this[e];this[t]=r,this.requestUpdate(e,i,o)},configurable:!0,enumerable:!0}}static getPropertyOptions(e){return this.elementProperties.get(e)||z}static finalize(){if(this.hasOwnProperty("finalized"))return!1;this.finalized=!0;const e=Object.getPrototypeOf(this);if(e.finalize(),void 0!==e.h&&(this.h=[...e.h]),this.elementProperties=new Map(e.elementProperties),this._$Ev=new Map,this.hasOwnProperty("properties")){const e=this.properties,t=[...Object.getOwnPropertyNames(e),...Object.getOwnPropertySymbols(e)];for(const o of t)this.createProperty(o,e[o])}return this.elementStyles=this.finalizeStyles(this.styles),!0}static finalizeStyles(e){const t=[];if(Array.isArray(e)){const o=new Set(e.flat(1/0).reverse());for(const e of o)t.unshift(x(e))}else void 0!==e&&t.push(x(e));return t}static _$Ep(e,t){const o=t.attribute;return!1===o?void 0:"string"==typeof o?o:"string"==typeof e?e.toLowerCase():void 0}u(){var e;this._$E_=new Promise((e=>this.enableUpdating=e)),this._$AL=new Map,this._$Eg(),this.requestUpdate(),null===(e=this.constructor.h)||void 0===e||e.forEach((e=>e(this)))}addController(e){var t,o;(null!==(t=this._$ES)&&void 0!==t?t:this._$ES=[]).push(e),void 0!==this.renderRoot&&this.isConnected&&(null===(o=e.hostConnected)||void 0===o||o.call(e))}removeController(e){var t;null===(t=this._$ES)||void 0===t||t.splice(this._$ES.indexOf(e)>>>0,1)}_$Eg(){this.constructor.elementProperties.forEach(((e,t)=>{this.hasOwnProperty(t)&&(this._$Ei.set(t,this[t]),delete this[t])}))}createRenderRoot(){var e;const t=null!==(e=this.shadowRoot)&&void 0!==e?e:this.attachShadow(this.constructor.shadowRootOptions);return((e,t)=>{f?e.adoptedStyleSheets=t.map((e=>e instanceof CSSStyleSheet?e:e.styleSheet)):t.forEach((t=>{const o=document.createElement("style"),r=m.litNonce;void 0!==r&&o.setAttribute("nonce",r),o.textContent=t.cssText,e.appendChild(o)}))})(t,this.constructor.elementStyles),t}connectedCallback(){var e;void 0===this.renderRoot&&(this.renderRoot=this.createRenderRoot()),this.enableUpdating(!0),null===(e=this._$ES)||void 0===e||e.forEach((e=>{var t;return null===(t=e.hostConnected)||void 0===t?void 0:t.call(e)}))}enableUpdating(e){}disconnectedCallback(){var e;null===(e=this._$ES)||void 0===e||e.forEach((e=>{var t;return null===(t=e.hostDisconnected)||void 0===t?void 0:t.call(e)}))}attributeChangedCallback(e,t,o){this._$AK(e,o)}_$EO(e,t,o=z){var r;const i=this.constructor._$Ep(e,o);if(void 0!==i&&!0===o.reflect){const a=(void 0!==(null===(r=o.converter)||void 0===r?void 0:r.toAttribute)?o.converter:E).toAttribute(t,o.type);this._$El=e,null==a?this.removeAttribute(i):this.setAttribute(i,a),this._$El=null}}_$AK(e,t){var o;const r=this.constructor,i=r._$Ev.get(e);if(void 0!==i&&this._$El!==i){const e=r.getPropertyOptions(i),a="function"==typeof e.converter?{fromAttribute:e.converter}:void 0!==(null===(o=e.converter)||void 0===o?void 0:o.fromAttribute)?e.converter:E;this._$El=i,this[i]=a.fromAttribute(t,e.type),this._$El=null}}requestUpdate(e,t,o){let r=!0;void 0!==e&&(((o=o||this.constructor.getPropertyOptions(e)).hasChanged||C)(this[e],t)?(this._$AL.has(e)||this._$AL.set(e,t),!0===o.reflect&&this._$El!==e&&(void 0===this._$EC&&(this._$EC=new Map),this._$EC.set(e,o))):r=!1),!this.isUpdatePending&&r&&(this._$E_=this._$Ej())}async _$Ej(){this.isUpdatePending=!0;try{await this._$E_}catch(e){Promise.reject(e)}const e=this.scheduleUpdate();return null!=e&&await e,!this.isUpdatePending}scheduleUpdate(){return this.performUpdate()}performUpdate(){var e;if(!this.isUpdatePending)return;this.hasUpdated,this._$Ei&&(this._$Ei.forEach(((e,t)=>this[t]=e)),this._$Ei=void 0);let t=!1;const o=this._$AL;try{t=this.shouldUpdate(o),t?(this.willUpdate(o),null===(e=this._$ES)||void 0===e||e.forEach((e=>{var t;return null===(t=e.hostUpdate)||void 0===t?void 0:t.call(e)})),this.update(o)):this._$Ek()}catch(e){throw t=!1,this._$Ek(),e}t&&this._$AE(o)}willUpdate(e){}_$AE(e){var t;null===(t=this._$ES)||void 0===t||t.forEach((e=>{var t;return null===(t=e.hostUpdated)||void 0===t?void 0:t.call(e)})),this.hasUpdated||(this.hasUpdated=!0,this.firstUpdated(e)),this.updated(e)}_$Ek(){this._$AL=new Map,this.isUpdatePending=!1}get updateComplete(){return this.getUpdateComplete()}getUpdateComplete(){return this._$E_}shouldUpdate(e){return!0}update(e){void 0!==this._$EC&&(this._$EC.forEach(((e,t)=>this._$EO(t,this[t],e))),this._$EC=void 0),this._$Ek()}updated(e){}firstUpdated(e){}}var R;j.finalized=!0,j.elementProperties=new Map,j.elementStyles=[],j.shadowRootOptions={mode:"open"},null==S||S({ReactiveElement:j}),(null!==(A=k.reactiveElementVersions)&&void 0!==A?A:k.reactiveElementVersions=[]).push("1.4.2");const N=window,O=N.trustedTypes,P=O?O.createPolicy("lit-html",{createHTML:e=>e}):void 0,L=`lit$${(Math.random()+"").slice(9)}$`,T="?"+L,M=`<${T}>`,H=document,U=(e="")=>H.createComment(e),I=e=>null===e||"object"!=typeof e&&"function"!=typeof e,q=Array.isArray,D=/<(?:(!--|\/[^a-zA-Z])|(\/?[a-zA-Z][^>\s]*)|(\/?$))/g,V=/-->/g,B=/>/g,F=RegExp(">|[ \t\n\f\r](?:([^\\s\"'>=/]+)([ \t\n\f\r]*=[ \t\n\f\r]*(?:[^ \t\n\f\r\"'`<>=]|(\"|')|))|$)","g"),G=/'/g,K=/"/g,W=/^(?:script|style|textarea|title)$/i,Z=e=>(t,...o)=>({_$litType$:e,strings:t,values:o}),J=Z(1),X=(Z(2),Symbol.for("lit-noChange")),Q=Symbol.for("lit-nothing"),Y=new WeakMap,ee=H.createTreeWalker(H,129,null,!1),te=(e,t)=>{const o=e.length-1,r=[];let i,a=2===t?"<svg>":"",n=D;for(let t=0;t<o;t++){const o=e[t];let l,s,c=-1,d=0;for(;d<o.length&&(n.lastIndex=d,s=n.exec(o),null!==s);)d=n.lastIndex,n===D?"!--"===s[1]?n=V:void 0!==s[1]?n=B:void 0!==s[2]?(W.test(s[2])&&(i=RegExp("</"+s[2],"g")),n=F):void 0!==s[3]&&(n=F):n===F?">"===s[0]?(n=null!=i?i:D,c=-1):void 0===s[1]?c=-2:(c=n.lastIndex-s[2].length,l=s[1],n=void 0===s[3]?F:'"'===s[3]?K:G):n===K||n===G?n=F:n===V||n===B?n=D:(n=F,i=void 0);const p=n===F&&e[t+1].startsWith("/>")?" ":"";a+=n===D?o+M:c>=0?(r.push(l),o.slice(0,c)+"$lit$"+o.slice(c)+L+p):o+L+(-2===c?(r.push(void 0),t):p)}const l=a+(e[o]||"<?>")+(2===t?"</svg>":"");if(!Array.isArray(e)||!e.hasOwnProperty("raw"))throw Error("invalid template strings array");return[void 0!==P?P.createHTML(l):l,r]};class oe{constructor({strings:e,_$litType$:t},o){let r;this.parts=[];let i=0,a=0;const n=e.length-1,l=this.parts,[s,c]=te(e,t);if(this.el=oe.createElement(s,o),ee.currentNode=this.el.content,2===t){const e=this.el.content,t=e.firstChild;t.remove(),e.append(...t.childNodes)}for(;null!==(r=ee.nextNode())&&l.length<n;){if(1===r.nodeType){if(r.hasAttributes()){const e=[];for(const t of r.getAttributeNames())if(t.endsWith("$lit$")||t.startsWith(L)){const o=c[a++];if(e.push(t),void 0!==o){const e=r.getAttribute(o.toLowerCase()+"$lit$").split(L),t=/([.?@])?(.*)/.exec(o);l.push({type:1,index:i,name:t[2],strings:e,ctor:"."===t[1]?le:"?"===t[1]?ce:"@"===t[1]?de:ne})}else l.push({type:6,index:i})}for(const t of e)r.removeAttribute(t)}if(W.test(r.tagName)){const e=r.textContent.split(L),t=e.length-1;if(t>0){r.textContent=O?O.emptyScript:"";for(let o=0;o<t;o++)r.append(e[o],U()),ee.nextNode(),l.push({type:2,index:++i});r.append(e[t],U())}}}else if(8===r.nodeType)if(r.data===T)l.push({type:2,index:i});else{let e=-1;for(;-1!==(e=r.data.indexOf(L,e+1));)l.push({type:7,index:i}),e+=L.length-1}i++}}static createElement(e,t){const o=H.createElement("template");return o.innerHTML=e,o}}function re(e,t,o=e,r){var i,a,n,l;if(t===X)return t;let s=void 0!==r?null===(i=o._$Co)||void 0===i?void 0:i[r]:o._$Cl;const c=I(t)?void 0:t._$litDirective$;return(null==s?void 0:s.constructor)!==c&&(null===(a=null==s?void 0:s._$AO)||void 0===a||a.call(s,!1),void 0===c?s=void 0:(s=new c(e),s._$AT(e,o,r)),void 0!==r?(null!==(n=(l=o)._$Co)&&void 0!==n?n:l._$Co=[])[r]=s:o._$Cl=s),void 0!==s&&(t=re(e,s._$AS(e,t.values),s,r)),t}class ie{constructor(e,t){this.u=[],this._$AN=void 0,this._$AD=e,this._$AM=t}get parentNode(){return this._$AM.parentNode}get _$AU(){return this._$AM._$AU}v(e){var t;const{el:{content:o},parts:r}=this._$AD,i=(null!==(t=null==e?void 0:e.creationScope)&&void 0!==t?t:H).importNode(o,!0);ee.currentNode=i;let a=ee.nextNode(),n=0,l=0,s=r[0];for(;void 0!==s;){if(n===s.index){let t;2===s.type?t=new ae(a,a.nextSibling,this,e):1===s.type?t=new s.ctor(a,s.name,s.strings,this,e):6===s.type&&(t=new pe(a,this,e)),this.u.push(t),s=r[++l]}n!==(null==s?void 0:s.index)&&(a=ee.nextNode(),n++)}return i}p(e){let t=0;for(const o of this.u)void 0!==o&&(void 0!==o.strings?(o._$AI(e,o,t),t+=o.strings.length-2):o._$AI(e[t])),t++}}class ae{constructor(e,t,o,r){var i;this.type=2,this._$AH=Q,this._$AN=void 0,this._$AA=e,this._$AB=t,this._$AM=o,this.options=r,this._$Cm=null===(i=null==r?void 0:r.isConnected)||void 0===i||i}get _$AU(){var e,t;return null!==(t=null===(e=this._$AM)||void 0===e?void 0:e._$AU)&&void 0!==t?t:this._$Cm}get parentNode(){let e=this._$AA.parentNode;const t=this._$AM;return void 0!==t&&11===e.nodeType&&(e=t.parentNode),e}get startNode(){return this._$AA}get endNode(){return this._$AB}_$AI(e,t=this){e=re(this,e,t),I(e)?e===Q||null==e||""===e?(this._$AH!==Q&&this._$AR(),this._$AH=Q):e!==this._$AH&&e!==X&&this.g(e):void 0!==e._$litType$?this.$(e):void 0!==e.nodeType?this.T(e):(e=>q(e)||"function"==typeof(null==e?void 0:e[Symbol.iterator]))(e)?this.k(e):this.g(e)}O(e,t=this._$AB){return this._$AA.parentNode.insertBefore(e,t)}T(e){this._$AH!==e&&(this._$AR(),this._$AH=this.O(e))}g(e){this._$AH!==Q&&I(this._$AH)?this._$AA.nextSibling.data=e:this.T(H.createTextNode(e)),this._$AH=e}$(e){var t;const{values:o,_$litType$:r}=e,i="number"==typeof r?this._$AC(e):(void 0===r.el&&(r.el=oe.createElement(r.h,this.options)),r);if((null===(t=this._$AH)||void 0===t?void 0:t._$AD)===i)this._$AH.p(o);else{const e=new ie(i,this),t=e.v(this.options);e.p(o),this.T(t),this._$AH=e}}_$AC(e){let t=Y.get(e.strings);return void 0===t&&Y.set(e.strings,t=new oe(e)),t}k(e){q(this._$AH)||(this._$AH=[],this._$AR());const t=this._$AH;let o,r=0;for(const i of e)r===t.length?t.push(o=new ae(this.O(U()),this.O(U()),this,this.options)):o=t[r],o._$AI(i),r++;r<t.length&&(this._$AR(o&&o._$AB.nextSibling,r),t.length=r)}_$AR(e=this._$AA.nextSibling,t){var o;for(null===(o=this._$AP)||void 0===o||o.call(this,!1,!0,t);e&&e!==this._$AB;){const t=e.nextSibling;e.remove(),e=t}}setConnected(e){var t;void 0===this._$AM&&(this._$Cm=e,null===(t=this._$AP)||void 0===t||t.call(this,e))}}class ne{constructor(e,t,o,r,i){this.type=1,this._$AH=Q,this._$AN=void 0,this.element=e,this.name=t,this._$AM=r,this.options=i,o.length>2||""!==o[0]||""!==o[1]?(this._$AH=Array(o.length-1).fill(new String),this.strings=o):this._$AH=Q}get tagName(){return this.element.tagName}get _$AU(){return this._$AM._$AU}_$AI(e,t=this,o,r){const i=this.strings;let a=!1;if(void 0===i)e=re(this,e,t,0),a=!I(e)||e!==this._$AH&&e!==X,a&&(this._$AH=e);else{const r=e;let n,l;for(e=i[0],n=0;n<i.length-1;n++)l=re(this,r[o+n],t,n),l===X&&(l=this._$AH[n]),a||(a=!I(l)||l!==this._$AH[n]),l===Q?e=Q:e!==Q&&(e+=(null!=l?l:"")+i[n+1]),this._$AH[n]=l}a&&!r&&this.j(e)}j(e){e===Q?this.element.removeAttribute(this.name):this.element.setAttribute(this.name,null!=e?e:"")}}class le extends ne{constructor(){super(...arguments),this.type=3}j(e){this.element[this.name]=e===Q?void 0:e}}const se=O?O.emptyScript:"";class ce extends ne{constructor(){super(...arguments),this.type=4}j(e){e&&e!==Q?this.element.setAttribute(this.name,se):this.element.removeAttribute(this.name)}}class de extends ne{constructor(e,t,o,r,i){super(e,t,o,r,i),this.type=5}_$AI(e,t=this){var o;if((e=null!==(o=re(this,e,t,0))&&void 0!==o?o:Q)===X)return;const r=this._$AH,i=e===Q&&r!==Q||e.capture!==r.capture||e.once!==r.once||e.passive!==r.passive,a=e!==Q&&(r===Q||i);i&&this.element.removeEventListener(this.name,this,r),a&&this.element.addEventListener(this.name,this,e),this._$AH=e}handleEvent(e){var t,o;"function"==typeof this._$AH?this._$AH.call(null!==(o=null===(t=this.options)||void 0===t?void 0:t.host)&&void 0!==o?o:this.element,e):this._$AH.handleEvent(e)}}class pe{constructor(e,t,o){this.element=e,this.type=6,this._$AN=void 0,this._$AM=t,this.options=o}get _$AU(){return this._$AM._$AU}_$AI(e){re(this,e)}}const he=N.litHtmlPolyfillSupport;var ue,ve;null==he||he(oe,ae),(null!==(R=N.litHtmlVersions)&&void 0!==R?R:N.litHtmlVersions=[]).push("2.4.0");class me extends j{constructor(){super(...arguments),this.renderOptions={host:this},this._$Do=void 0}createRenderRoot(){var e,t;const o=super.createRenderRoot();return null!==(e=(t=this.renderOptions).renderBefore)&&void 0!==e||(t.renderBefore=o.firstChild),o}update(e){const t=this.render();this.hasUpdated||(this.renderOptions.isConnected=this.isConnected),super.update(e),this._$Do=((e,t,o)=>{var r,i;const a=null!==(r=null==o?void 0:o.renderBefore)&&void 0!==r?r:t;let n=a._$litPart$;if(void 0===n){const e=null!==(i=null==o?void 0:o.renderBefore)&&void 0!==i?i:null;a._$litPart$=n=new ae(t.insertBefore(U(),e),e,void 0,null!=o?o:{})}return n._$AI(e),n})(t,this.renderRoot,this.renderOptions)}connectedCallback(){var e;super.connectedCallback(),null===(e=this._$Do)||void 0===e||e.setConnected(!0)}disconnectedCallback(){var e;super.disconnectedCallback(),null===(e=this._$Do)||void 0===e||e.setConnected(!1)}render(){return X}}me.finalized=!0,me._$litElement$=!0,null===(ue=globalThis.litElementHydrateSupport)||void 0===ue||ue.call(globalThis,{LitElement:me});const fe=globalThis.litElementPolyfillSupport;null==fe||fe({LitElement:me}),(null!==(ve=globalThis.litElementVersions)&&void 0!==ve?ve:globalThis.litElementVersions=[]).push("3.2.2");const ge=e=>t=>"function"==typeof t?((e,t)=>(customElements.define(e,t),t))(e,t):((e,t)=>{const{kind:o,elements:r}=t;return{kind:o,elements:r,finisher(t){customElements.define(e,t)}}})(e,t),be=(e,t)=>"method"===t.kind&&t.descriptor&&!("value"in t.descriptor)?{...t,finisher(o){o.createProperty(t.key,e)}}:{kind:"field",key:Symbol(),placement:"own",descriptor:{},originalKey:t.key,initializer(){"function"==typeof t.initializer&&(this[t.key]=t.initializer.call(this))},finisher(o){o.createProperty(t.key,e)}};function ye(e){return(t,o)=>void 0!==o?((e,t,o)=>{t.constructor.createProperty(o,e)})(e,t,o):be(e,t)}var we;null===(we=window.HTMLSlotElement)||void 0===we||we.prototype.assignedElements;class xe extends me{get _slottedChildren(){const e=this.shadowRoot.querySelector("slot");if(e)return e.assignedElements({flatten:!0})}}const Ae="categoryActivated",ke=w` | |
ul { | |
margin: 0; | |
padding: 0; | |
list-style: none; | |
} | |
li { | |
padding-left: 0; | |
} | |
@media only screen and (max-width: 600px) { | |
ul { | |
margin-block-start: 0; | |
margin-block-end: 0; | |
margin-inline-start: 0; | |
margin-inline-end: 0; | |
padding-inline-start: 0; | |
} | |
} | |
`;var $e=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let _e=class extends xe{render(){return J` | |
<ul @categoryActivated=${this._categoryActivatedListener}> | |
<slot></slot> | |
</ul> | |
`}firstUpdated(){setTimeout((()=>{const e=new CustomEvent(Ae,{bubbles:!0,composed:!0,detail:{id:this.default,description:"All the categories, for those who like a party."}});this.dispatchEvent(e),this._categoryActivatedListener(e)}))}_categoryActivatedListener(e){for(let t=0;t<this._slottedChildren.length;t++){const o=this._slottedChildren[t];o.name!=e.detail.id?o.disableCategory():o.active||o.enableCategory()}}};_e.styles=ke,$e([ye()],_e.prototype,"default",void 0),_e=$e([ge("rule-category-navigation")],_e);const Se=w` | |
li { | |
padding-left: 0; | |
} | |
.active { | |
background-color: var(--primary-color); | |
color: var(--invert-font-color); | |
font-weight: bold; | |
} | |
a { | |
color: var(--primary-color); | |
text-decoration: none; | |
} | |
a:hover { | |
background-color: var(--primary-color); | |
color: var(--invert-font-color); | |
} | |
@media only screen and (max-width: 600px) { | |
a { | |
font-size: 0.7rem; | |
} | |
li { | |
padding-bottom: 0; | |
margin-bottom: 0; | |
} | |
} | |
`;var Ee=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let Ce=class extends xe{disableCategory(){this.active=!1,this.requestUpdate()}enableCategory(){this.active=!0,this.requestUpdate()}toggleCategory(e=!0){if(this.active=!this.active,e){const e={detail:{id:this.name,description:this.description},bubbles:!0,composed:!0};this.dispatchEvent(new CustomEvent(Ae,e))}this.requestUpdate()}render(){return J` | |
<li> | |
<a | |
href="#" | |
class="${this.active?"active":""}" | |
@click=${this.toggleCategory} | |
> | |
<slot></slot> | |
</a> | |
</li> | |
`}};Ce.styles=Se,Ee([ye({type:String})],Ce.prototype,"name",void 0),Ee([ye({type:Boolean})],Ce.prototype,"default",void 0),Ee([ye({type:String})],Ce.prototype,"description",void 0),Ce=Ee([ge("rule-category-link")],Ce);let ze=class extends xe{static get styles(){return[w` | |
.html-report { | |
height: 100%; | |
} | |
`]}render(){return J` | |
<div | |
class="html-report" | |
@categoryActivated=${this._categoryActivatedListener} | |
@violationSelected=${this._violationSelectedListener} | |
> | |
<slot name="navigation"></slot> | |
<slot name="reports"></slot> | |
</div> | |
`}_categoryActivatedListener(e){const t=document.querySelectorAll("category-report"),o=document.querySelectorAll("category-rule"),r=document.querySelectorAll("category-rules"),i=document.querySelector("violation-drawer"),a=this.shadowRoot.querySelector("slot").assignedElements({flatten:!0})[0].querySelector("nav").querySelector("#category-description");a&&(a.innerHTML=e.detail.description),t.forEach((t=>{t.id==e.detail.id?t.style.display="block":t.style.display="none"})),o.forEach((e=>{e.otherRuleSelected()})),r.forEach((t=>{t.id==e.detail.id&&t.rules&&t.rules.length<=0&&(t.isEmpty=!0)})),i&&i.hide()}_violationSelectedListener(){document.querySelector("violation-drawer").show()}};ze=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n}([ge("html-report")],ze);var je=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let Re=class extends xe{get results(){return this.shadowRoot.querySelector("slot").assignedElements({flatten:!0})}render(){return J`<slot></slot>`}};je([ye()],Re.prototype,"id",void 0),Re=je([ge("category-report")],Re);const Ne=w` | |
ul { | |
margin-top: 0; | |
} | |
.line { | |
text-align: center; | |
border-radius: 5px; | |
min-width: 35px; | |
max-width: 35px; | |
background-color: var(--card-bgcolor); | |
color: var(--tertiary-color); | |
font-size: var(--sl-font-size-xx-small); | |
} | |
.violation { | |
display: flex; | |
border-top: 1px solid var(--card-bgcolor); | |
border-bottom: 1px solid var(--card-bgcolor); | |
font-size: var(--sl-font-size-x-small); | |
color: var(--font-color); | |
} | |
.violation:hover { | |
background-color: var(--secondary-color-x-lowalpha); | |
cursor: pointer; | |
} | |
.violation.selected:hover { | |
background-color: var(--secondary-color-lowalpha); | |
} | |
.code-render { | |
display: none; | |
} | |
.message { | |
margin-left: 5px; | |
} | |
.selected { | |
background-color: var(--secondary-color-lowalpha); | |
} | |
.selected .line { | |
color: var(--font-color); | |
} | |
.selected .message { | |
font-weight: bold; | |
} | |
`;var Oe=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let Pe=class extends xe{connectedCallback(){super.connectedCallback(),this._violationId=Math.random().toString(20).substring(2)}get violationId(){return this._violationId}render(){return J` <nav | |
aria-label="Violation Navigation" | |
class="violation ${this.selected?"selected":""}" | |
@click=${this._violationClicked} | |
> | |
<div class="line">${this.startLine}</div> | |
<div class="message">${this.path}</div> | |
</nav> | |
<div class="code-render"> | |
<slot></slot> | |
</div>`}_violationClicked(){let e;this._renderedCode?e=this._renderedCode:(e=this._slottedChildren[0],this._renderedCode=e);const t={detail:{message:this.message,id:this.ruleId,startLine:this.startLine,startCol:this.startCol,endLine:this.endLine,endCol:this.endCol,path:this.path,category:this.category,howToFix:this.howToFix,violationId:this.violationId,renderedCode:e},bubbles:!0,composed:!0};this.dispatchEvent(new CustomEvent("violationSelected",t))}};Pe.styles=Ne,Oe([ye({type:String})],Pe.prototype,"message",void 0),Oe([ye({type:String})],Pe.prototype,"category",void 0),Oe([ye({type:String})],Pe.prototype,"ruleId",void 0),Oe([ye({type:Number})],Pe.prototype,"startLine",void 0),Oe([ye({type:Number})],Pe.prototype,"startCol",void 0),Oe([ye({type:Number})],Pe.prototype,"endLine",void 0),Oe([ye({type:Number})],Pe.prototype,"endCol",void 0),Oe([ye({type:String})],Pe.prototype,"path",void 0),Oe([ye({type:String})],Pe.prototype,"howToFix",void 0),Oe([ye({type:Boolean})],Pe.prototype,"selected",void 0),Pe=Oe([ge("category-rule-result")],Pe);const Le=w` | |
.rule-icon { | |
font-family: 'Arial'; | |
font-size: var(--sl-font-size-small); | |
width: 20px; | |
display: inline-block; | |
} | |
li { | |
margin: 0; | |
padding-left: 0; | |
} | |
li::after { | |
content: ''; | |
} | |
.details { | |
margin-bottom: calc(var(--global-margin) / 2); | |
} | |
.details > .summary { | |
background-color: var(--card-bgcolor); | |
border: 1px solid var(--card-bordercolor); | |
padding: 5px; | |
border-radius: 3px; | |
} | |
.rule-violation-count { | |
font-size: var(--sl-font-size-x-small); | |
border: 1px solid var(--card-bordercolor); | |
color: var(--tertiary-color); | |
padding: 2px; | |
border-radius: 2px; | |
} | |
.details.open .summary { | |
background-color: var(--primary-color); | |
color: var(--invert-font-color); | |
font-weight: bold; | |
} | |
.details.open .rule-violation-count { | |
background-color: var(--primary-color); | |
color: var(--invert-font-color); | |
border: 1px solid var(--invert-font-color); | |
font-weight: normal; | |
} | |
.details.open .expand-state { | |
color: var(--invert-font-color); | |
} | |
.details > div.violations { | |
font-size: var(--sl-font-size-x-small); | |
overflow-y: auto; | |
overflow-x: hidden; | |
border: 1px solid var(--card-bordercolor); | |
} | |
@media only screen and (max-width: 1200px) { | |
.details > div.violations { | |
max-height: 230px; | |
} | |
} | |
.details > .summary::marker { | |
color: var(--secondary-color); | |
} | |
.rule-description { | |
font-size: var(--rule-font-size); | |
} | |
.summary:hover { | |
cursor: pointer; | |
background-color: var(--primary-color-lowalpha); | |
color: var(--invert-font-color); | |
} | |
.summary:hover .expand-state { | |
color: var(--invert-font-color); | |
} | |
.summary:hover .rule-violation-count { | |
color: var(--invert-font-color); | |
border: 1px solid var(--invert-font-color); | |
} | |
.violations { | |
display: none; | |
scrollbar-width: thin; | |
} | |
.violations::-webkit-scrollbar { | |
width: 8px; | |
} | |
.violations::-webkit-scrollbar-track { | |
background-color: var(--card-bgcolor); | |
} | |
.violations::-webkit-scrollbar-thumb { | |
box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3); | |
background: var(--primary-color-lowalpha); | |
} | |
.expand-state { | |
color: var(--font-color); | |
vertical-align: sub; | |
height: 20px; | |
width: 20px; | |
display: inline-block; | |
} | |
.expand-state:hover { | |
cursor: pointer; | |
color: var(--primary-color); | |
} | |
.truncated { | |
text-align: center; | |
color: var(--error-color); | |
border: 1px solid var(--error-color); | |
padding: var(--global-padding); | |
margin-bottom: 1px; | |
margin-right: 1px; | |
} | |
@media only screen and (max-width: 600px) { | |
.details { | |
max-height: 300px; | |
overflow-y: hidden; | |
} | |
} | |
`,Te=J` | |
<svg | |
xmlns="http://www.w3.org/2000/svg" | |
width="20" | |
height="20" | |
fill="currentColor" | |
class="bi bi-plus-square" | |
viewBox="0 0 16 16" | |
> | |
<path | |
d="M14 1a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1V2a1 1 0 0 1 1-1h12zM2 0a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V2a2 2 0 0 0-2-2H2z" | |
/> | |
<path | |
d="M8 4a.5.5 0 0 1 .5.5v3h3a.5.5 0 0 1 0 1h-3v3a.5.5 0 0 1-1 0v-3h-3a.5.5 0 0 1 0-1h3v-3A.5.5 0 0 1 8 4z" | |
/> | |
</svg> | |
`,Me=J` | |
<svg | |
xmlns="http://www.w3.org/2000/svg" | |
width="20" | |
height="20" | |
fill="currentColor" | |
class="bi bi-dash-square" | |
viewBox="0 0 16 16" | |
> | |
<path | |
d="M14 1a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1V2a1 1 0 0 1 1-1h12zM2 0a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V2a2 2 0 0 0-2-2H2z" | |
/> | |
<path d="M4 8a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7A.5.5 0 0 1 4 8z" /> | |
</svg> | |
`;var He=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let Ue=class extends xe{otherRuleSelected(){this.open=!1,this.violations=this.renderRoot.querySelector(".violations"),this.violations.style.display="none",this._expandState=!1,this._slottedChildren.forEach((e=>{e.selected=!1})),this.requestUpdate()}render(){let e;this.violations=this.renderRoot.querySelector(".violations"),this.truncated&&(e=J` | |
<div class="truncated"> | |
<strong>${this.numResults-this.maxViolations}</strong> more | |
violations not rendered, There are just too many! | |
</div> | |
`);const t=this._expandState?Me:Te;return J` | |
<nav | |
aria-label="Rules and Violations" | |
class="details ${this._expandState?"open":""}" | |
> | |
<div class="summary" @click=${this._ruleSelected}> | |
<span class="expand-state">${t}</span> | |
<span class="rule-icon">${this.ruleIcon}</span> | |
<span class="rule-description">${this.description}</span> | |
<span class="rule-violation-count">${this.numResults}</span> | |
</div> | |
<div class="violations" @violationSelected=${this._violationSelected}> | |
<slot name="results"></slot> | |
${e} | |
</div> | |
</nav> | |
`}_ruleSelected(){if(this.open)this.violations.style.display="none",this._expandState=!1;else{this.violations.style.display="block";const e=this.parentElement.parentElement.offsetHeight-60*this.totalRulesViolated;this.violations.style.maxHeight=e+"px",this._expandState=!0}this.open=!this.open,this.dispatchEvent(new CustomEvent("ruleSelected",{bubbles:!0,composed:!0,detail:{id:this.ruleId}})),this.requestUpdate()}_violationSelected(e){this._slottedChildren.forEach((t=>{t.selected=e.detail.violationId==t.violationId}))}};Ue.styles=Le,He([ye()],Ue.prototype,"totalRulesViolated",void 0),He([ye()],Ue.prototype,"maxViolations",void 0),He([ye()],Ue.prototype,"truncated",void 0),He([ye()],Ue.prototype,"ruleId",void 0),He([ye()],Ue.prototype,"description",void 0),He([ye()],Ue.prototype,"numResults",void 0),He([ye()],Ue.prototype,"ruleIcon",void 0),He([ye()],Ue.prototype,"open",void 0),Ue=He([ge("category-rule")],Ue);const Ie=w` | |
ul.rule { | |
margin: 0; | |
padding: 0; | |
} | |
section { | |
//max-height: 35vh; | |
overflow-y: hidden; | |
} | |
p { | |
font-size: var(--sl-font-size-small); | |
margin: 0; | |
} | |
.symbol { | |
font-family: Arial; | |
} | |
section.no-violations { | |
border: 1px solid var(--terminal-green); | |
padding: 20px; | |
color: var(--terminal-green); | |
text-align: center; | |
} | |
`;var qe=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let De=class extends xe{render(){return this.isEmpty?J` | |
<section class="no-violations"> | |
<p>All good in here, no rules broken!</p> | |
</section> | |
`:J` | |
<section @ruleSelected=${this._ruleSelected}> | |
<ul class="rule"> | |
<slot></slot> | |
</ul> | |
</section> | |
`}get rules(){const e=this.shadowRoot.querySelector("slot");if(e)return e.assignedElements({flatten:!0})}_ruleSelected(e){this.rules.forEach((t=>{t.ruleId!=e.detail.id&&t.otherRuleSelected()}))}};De.styles=Ie,qe([ye()],De.prototype,"id",void 0),qe([ye()],De.prototype,"isEmpty",void 0),De=qe([ge("category-rules")],De);const Ve=w` | |
/* Background */ | |
.chroma { | |
color: #f8f8f2; | |
background-color: var(--code-bg-color); | |
} | |
/* Other */ | |
.chroma .x { | |
} | |
/* Error */ | |
.chroma .err { | |
} | |
/* LineTableTD */ | |
.chroma .lntd { | |
vertical-align: top; | |
padding: 0; | |
margin: 0; | |
border: 0; | |
} | |
/* LineTable */ | |
.chroma .lntable { | |
border-spacing: 0; | |
padding: 0; | |
margin: 0; | |
border: 0; | |
width: auto; | |
overflow: auto; | |
display: block; | |
} | |
/* LineHighlight */ | |
.chroma .hl { | |
display: block; | |
width: 100%; | |
background-color: rgba(98, 196, 255, 0.12); | |
} | |
.hl > span.ln { | |
color: white; | |
} | |
/* LineNumbersTable */ | |
.chroma .lnt { | |
margin-right: 0.4em; | |
padding: 0 0.4em 0 0.4em; | |
color: #7f7f7f; | |
} | |
/* LineNumbers */ | |
.chroma .ln { | |
margin-right: 0.4em; | |
padding: 0 0.4em 0 0.4em; | |
color: #7f7f7f; | |
} | |
/* Keyword */ | |
.chroma .k { | |
color: #b584fd; | |
} | |
/* KeywordConstant */ | |
.chroma .kc { | |
color: #c8a1fd; | |
} | |
/* KeywordDeclaration */ | |
.chroma .kd { | |
color: #8be9fd; | |
font-style: italic; | |
} | |
/* KeywordNamespace */ | |
.chroma .kn { | |
color: #ff79c6; | |
} | |
/* KeywordPseudo */ | |
.chroma .kp { | |
color: #ff79c6; | |
} | |
/* KeywordReserved */ | |
.chroma .kr { | |
color: #ff79c6; | |
} | |
/* KeywordType */ | |
.chroma .kt { | |
color: #8be9fd; | |
} | |
/* Name */ | |
.chroma .n { | |
} | |
/* NameAttribute */ | |
.chroma .na { | |
color: #50fa7b; | |
} | |
/* NameBuiltin */ | |
.chroma .nb { | |
color: #8be9fd; | |
font-style: italic; | |
} | |
/* NameBuiltinPseudo */ | |
.chroma .bp { | |
} | |
/* NameClass */ | |
.chroma .nc { | |
color: #50fa7b; | |
} | |
/* NameConstant */ | |
.chroma .no { | |
} | |
/* NameDecorator */ | |
.chroma .nd { | |
} | |
/* NameEntity */ | |
.chroma .ni { | |
} | |
/* NameException */ | |
.chroma .ne { | |
} | |
/* NameFunction */ | |
.chroma .nf { | |
color: #50fa7b; | |
} | |
/* NameFunctionMagic */ | |
.chroma .fm { | |
} | |
/* NameLabel */ | |
.chroma .nl { | |
color: #8be9fd; | |
font-style: italic; | |
} | |
/* NameNamespace */ | |
.chroma .nn { | |
} | |
/* NameOther */ | |
.chroma .nx { | |
} | |
/* NameProperty */ | |
.chroma .py { | |
} | |
/* NameTag */ | |
.chroma .nt { | |
color: #b584fd; | |
} | |
/* NameVariable */ | |
.chroma .nv { | |
color: #8be9fd; | |
font-style: italic; | |
} | |
/* NameVariableClass */ | |
.chroma .vc { | |
color: #8be9fd; | |
font-style: italic; | |
} | |
/* NameVariableGlobal */ | |
.chroma .vg { | |
color: #8be9fd; | |
font-style: italic; | |
} | |
/* NameVariableInstance */ | |
.chroma .vi { | |
color: #8be9fd; | |
font-style: italic; | |
} | |
/* NameVariableMagic */ | |
.chroma .vm { | |
} | |
/* Literal */ | |
.chroma .l { | |
color: var(--primary-color); | |
} | |
} | |
/* LiteralDate */ | |
.chroma .ld { | |
} | |
/* LiteralString */ | |
.chroma .s { | |
color: #717684; | |
} | |
/* LiteralStringAffix */ | |
.chroma .sa { | |
color: #717684; | |
} | |
/* LiteralStringBacktick */ | |
.chroma .sb { | |
color: #717684; | |
} | |
/* LiteralStringChar */ | |
.chroma .sc { | |
color: #717684; | |
} | |
/* LiteralStringDelimiter */ | |
.chroma .dl { | |
color: #717684; | |
} | |
/* LiteralStringDoc */ | |
.chroma .sd { | |
color: #717684; | |
} | |
/* LiteralStringDouble */ | |
.chroma .s2 { | |
color: var(--primary-color); | |
} | |
/* LiteralStringEscape */ | |
.chroma .se { | |
color: #717684; | |
} | |
/* LiteralStringHeredoc */ | |
.chroma .sh { | |
color: #717684; | |
} | |
/* LiteralStringInterpol */ | |
.chroma .si { | |
color: #717684; | |
} | |
/* LiteralStringOther */ | |
.chroma .sx { | |
color: #717684; | |
} | |
/* LiteralStringRegex */ | |
.chroma .sr { | |
color: #717684; | |
/* LiteralStringSingle */ | |
.chroma .s1 { | |
color: var(--primary-color); | |
} | |
/* LiteralStringSymbol */ | |
.chroma .ss { | |
color: #717684; | |
} | |
/* LiteralNumber */ | |
.chroma .m { | |
color: #bd93f9; | |
} | |
/* LiteralNumberBin */ | |
.chroma .mb { | |
color: #bd93f9; | |
} | |
/* LiteralNumberFloat */ | |
.chroma .mf { | |
color: #bd93f9; | |
} | |
/* LiteralNumberHex */ | |
.chroma .mh { | |
color: #bd93f9; | |
} | |
/* LiteralNumberInteger */ | |
.chroma .mi { | |
color: #bd93f9; | |
} | |
/* LiteralNumberIntegerLong */ | |
.chroma .il { | |
color: #bd93f9; | |
} | |
/* LiteralNumberOct */ | |
.chroma .mo { | |
color: #bd93f9; | |
} | |
/* Operator */ | |
.chroma .o { | |
color: #ff79c6; | |
} | |
/* OperatorWord */ | |
.chroma .ow { | |
color: #ff79c6; | |
} | |
/* Punctuation */ | |
.chroma .p { | |
} | |
/* Comment */ | |
.chroma .c { | |
color: #6272a4; | |
} | |
/* CommentHashbang */ | |
.chroma .ch { | |
color: #6272a4; | |
} | |
/* CommentMultiline */ | |
.chroma .cm { | |
color: #6272a4; | |
} | |
/* CommentSingle */ | |
.chroma .c1 { | |
color: #6272a4; | |
} | |
/* CommentSpecial */ | |
.chroma .cs { | |
color: #6272a4; | |
} | |
/* CommentPreproc */ | |
.chroma .cp { | |
color: #ff79c6; | |
} | |
/* CommentPreprocFile */ | |
.chroma .cpf { | |
color: #ff79c6; | |
} | |
/* Generic */ | |
.chroma .g { | |
} | |
/* GenericDeleted */ | |
.chroma .gd { | |
color: #ff5555; | |
} | |
/* GenericEmph */ | |
.chroma .ge { | |
text-decoration: underline; | |
} | |
/* GenericError */ | |
.chroma .gr { | |
} | |
/* GenericHeading */ | |
.chroma .gh { | |
font-weight: bold; | |
} | |
/* GenericInserted */ | |
.chroma .gi { | |
color: #50fa7b; | |
font-weight: bold; | |
} | |
/* GenericOutput */ | |
.chroma .go { | |
color: #44475a; | |
} | |
/* GenericPrompt */ | |
.chroma .gp { | |
} | |
/* GenericStrong */ | |
.chroma .gs { | |
} | |
/* GenericSubheading */ | |
.chroma .gu { | |
font-weight: bold; | |
} | |
/* GenericTraceback */ | |
.chroma .gt { | |
} | |
/* GenericUnderline */ | |
.chroma .gl { | |
text-decoration: underline; | |
} | |
/* TextWhitespace */ | |
.chroma .w { | |
} | |
`;let Be=class extends xe{static get styles(){const e=w``;return[Ve,e]}render(){return J` | |
<slot | |
@violationSelected=${this._violationSelectedListener} | |
name="violation" | |
></slot> | |
<slot name="details"></slot> | |
`}_violationSelectedListener(e){const t=this.shadowRoot.querySelectorAll("slot")[1].assignedElements({flatten:!0})[0];t.ruleId=e.detail.id,t.message=e.detail.message,t.code=e.detail.renderedCode,t.howToFix=e.detail.howToFix,t.category=e.detail.category,t.path=e.detail.path}};Be=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n}([ge("result-grid")],Be);const Fe=[Ve,w` | |
hr { | |
border: 0; | |
border-top: 1px dashed var(--secondary-color-lowalpha); | |
margin-top: var(--global-margin); | |
margin-bottom: var(--global-margin); | |
} | |
pre { | |
overflow-x: auto; | |
} | |
pre::-webkit-scrollbar { | |
height: 8px; | |
} | |
pre::-webkit-scrollbar-track { | |
background-color: var(--card-bgcolor); | |
} | |
pre::-webkit-scrollbar-thumb { | |
box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3); | |
background: var(--primary-color-lowalpha); | |
} | |
p.violated { | |
font-size: var(--sl-font-size-small); | |
} | |
pre { | |
font-size: var(--sl-font-size-x-small); | |
} | |
a { | |
font-size: var(--sl-font-size-small); | |
color: var(--primary-color); | |
} | |
a:hover { | |
background-color: var(--secondary-color); | |
cursor: pointer; | |
color: var(--invert-font-color); | |
} | |
h2 { | |
margin-top: 0; | |
line-height: 2.3rem; | |
font-size: 1.4rem; | |
} | |
.backtick-element { | |
background-color: black; | |
color: var(--secondary-color); | |
border: 1px solid var(--secondary-color-lowalpha); | |
border-radius: 5px; | |
padding: 2px; | |
} | |
section.select-violation { | |
width: 100%; | |
text-align: center; | |
} | |
section.select-violation p { | |
color: var(--secondary-color-lowalpha); | |
font-size: var(--sl-font-size-x-small); | |
} | |
section.how-to-fix p { | |
font-size: var(--sl-font-size-x-small); | |
} | |
p.path { | |
color: var(--secondary-color); | |
} | |
@media only screen and (max-width: 600px) { | |
h2 { | |
font-size: 1rem; | |
} | |
} | |
`];var Ge,Ke=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let We=Ge=class extends xe{static replaceTicks(e){const t=/(`[^`]*`)/g,o=e.split(t),r=new Array;return o.forEach((e=>{if(e.match(t)){const t=e.replace(/`/g,""),o=J`<span class="backtick-element">${t}</span>`;r.push(o)}else""!=e&&r.push(J`${e}`)})),r}render(){return this._visible?J` | |
<h2>${Ge.replaceTicks(this.message)}</h2> | |
${this.code} | |
<h3>JSON Path</h3> | |
<p class="path">${this.path}</p> | |
<hr /> | |
<section class="how-to-fix"> | |
<h3>How to fix violation</h3> | |
<p>${this.howToFix}</p> | |
</section> | |
<hr /> | |
<p class="violated"> | |
Learn more about: | |
<a | |
href="https://quobix.com/vacuum/rules/${this.category}/${this.ruleId}" | |
>${this.ruleId}</a | |
> | |
</p> | |
`:J` | |
<section class="select-violation"> | |
<p>Please select a rule violation from a category.</p> | |
</section> | |
`}get drawer(){return document.querySelector("violation-drawer")}show(){this._visible=!0,this.drawer.classList.add("drawer-active"),this.requestUpdate()}hide(){this._visible=!1,this.drawer.classList.remove("drawer-active"),this.requestUpdate()}};We.styles=Fe,Ke([ye({type:Element})],We.prototype,"code",void 0),Ke([ye({type:String})],We.prototype,"message",void 0),Ke([ye({type:String})],We.prototype,"path",void 0),Ke([ye({type:String})],We.prototype,"category",void 0),Ke([ye({type:String})],We.prototype,"ruleId",void 0),Ke([ye({type:String})],We.prototype,"howToFix",void 0),We=Ge=Ke([ge("violation-drawer")],We);var Ze=function(e,t,o,r){var i,a=arguments.length,n=a<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,o):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,o,r);else for(var l=e.length-1;l>=0;l--)(i=e[l])&&(n=(a<3?i(n):a>3?i(t,o,n):i(t,o))||n);return a>3&&n&&Object.defineProperty(t,o,n),n};let Je=class extends xe{static get styles(){return[w` | |
span { | |
display: block; | |
} | |
div { | |
padding: 5px; | |
min-width: 80px; | |
} | |
span.grade { | |
font-size: 1.3rem; | |
font-weight: bold; | |
} | |
span.label { | |
font-size: var(--sl-font-size-xx-small); | |
color: var(--font-color); | |
} | |
.error { | |
background-color: var(--error-color-lowalpha); | |
border: 1px solid var(--error-color); | |
color: var(--error-color); | |
} | |
.warn-400 { | |
background-color: var(--warn-400-lowalpha); | |
border: 1px solid var(--warn-400); | |
color: var(--warn-400); | |
} | |
.warn-300 { | |
background-color: var(--warn-300-lowalpha); | |
border: 1px solid var(--warn-300); | |
color: var(--warn-300); | |
} | |
.warn-200 { | |
background-color: var(--warn-200-lowalpha); | |
border: 1px solid var(--warn-200); | |
color: var(--warn-200); | |
} | |
.warn { | |
background-color: var(--warn-color-lowalpha); | |
border: 1px solid var(--warn-color); | |
color: var(--warn-color); | |
} | |
.ok-400 { | |
background-color: var(--ok-400-lowalpha); | |
border: 1px solid var(--ok-400); | |
color: var(--ok-400); | |
} | |
.ok-300 { | |
background-color: var(--ok-300-lowalpha); | |
border: 1px solid var(--ok-300); | |
color: var(--ok-300); | |
} | |
.ok-200 { | |
background-color: var(--ok-200-lowalpha); | |
border: 1px solid var(--ok-200); | |
color: var(--ok-200); | |
} | |
.ok { | |
background-color: var(--ok-color-lowalpha); | |
border: 1px solid var(--ok-color); | |
color: var(--ok-color); | |
} | |
.warning-count { | |
background: none; | |
color: var(--primary-color); | |
} | |
.error-count { | |
background: none; | |
color: var(--primary-color); | |
} | |
.info-count { | |
background: none; | |
color: var(--primary-color); | |
} | |
@media only screen and (max-width: 600px) { | |
div { | |
padding: 5px; | |
min-width: 60px; | |
} | |
} | |
`]}render(){return J` | |
<div class=${this.colorForScore()}> | |
<span class="grade" | |
>${this.value.toLocaleString()}${this.percentage?"%":""}</span | |
> | |
<span class="label"> ${this.label} </span> | |
</div> | |
`}colorForScore(){if(this.preset)return this.preset;switch(!0){case this.value<=10:return"error";case this.value>10&&this.value<20:return"warn-400";case this.value>=20&&this.value<30:return"warn-300";case this.value>=30&&this.value<40:return"warn-200";case this.value>=40&&this.value<50:return"warn";case this.value>=50&&this.value<65:return"ok-400";case this.value>=65&&this.value<75:return"ok-300";case this.value>=75&&this.value<95:return"ok-200";case this.value>=95:default:return"ok"}}};Ze([ye({type:Number})],Je.prototype,"value",void 0),Ze([ye()],Je.prototype,"preset",void 0),Ze([ye()],Je.prototype,"percentage",void 0),Ze([ye()],Je.prototype,"label",void 0),Je=Ze([ge("header-statistic")],Je)})()})(); | |
</script><style> | |
:root { | |
--global-font-size: 17px; | |
--global-line-height: 1.4em; | |
--global-space: 10px; | |
--font-stack: Menlo, Monaco, Lucida Console, Liberation Mono, | |
DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace, | |
serif; | |
--mono-font-stack: Menlo, Monaco, Lucida Console, Liberation Mono, | |
DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace, | |
serif; | |
--background-color: #0d1117; | |
--background-color-with-opacity: rgba(13, 17, 23, 0.85); | |
--page-width: 100vw; | |
--font-color: #e8e9ed; | |
--invert-font-color: #222225; | |
--secondary-color: #b685ff; | |
--secondary-color-lowalpha: rgba(182, 133, 255, 0.55); | |
--secondary-color-x-lowalpha: rgba(182, 133, 255, 0.2); | |
--tertiary-color: #a3abba; | |
--primary-color: #62c4ff; | |
--primary-color-lowalpha: rgba(98, 196, 255, 0.76); | |
--error-color: #ff3c74; | |
--error-color-lowalpha: rgba(255, 60, 116, 0.14); | |
--warn-400: #ff6a00; | |
--warn-400-lowalpha: rgba(255, 106, 0, 0.15); | |
--warn-300: #ff9900; | |
--warn-300-lowalpha: rgba(255, 153, 0, 0.05); | |
--warn-200: #ffb700; | |
--warn-200-lowalpha: rgba(255, 183, 0, 0.15); | |
--warn-color: #ffd500; | |
--warn-color-lowalpha: rgba(255, 213, 0, 0.15); | |
--ok-400: #f7ff00; | |
--ok-400-lowalpha: rgba(230, 255, 0, 0.15); | |
--ok-300: #d0ff00; | |
--ok-300-lowalpha: rgba(208, 255, 0, 0.15); | |
--ok-200: #aaff00; | |
--ok-200-lowalpha: rgba(170, 255, 0, 0.15); | |
--ok-color: #1aff00; | |
--ok-color-lowalpha: rgba(170, 255, 0, 0.15); | |
--progress-bar-background: #3f3f44; | |
--progress-bar-fill: #62c4ff; | |
--code-bg-color: rgb(28 33 40); | |
--input-style: solid; | |
--display-h1-decoration: none; | |
--bold-text: #e397fa; | |
--terminal-green: #00FF00FF; | |
--hrcolor: #3d3d3d; | |
--code-border: #525252; | |
--card-bgcolor: rgba(83, 83, 83, 0.1); | |
--card-bordercolor: rgba(83, 83, 83, 0.3); | |
--sl-font-sans: var(--font-stack); | |
--sl-font-mono: var(--font-stack); | |
--sl-font-size-small: 16px; | |
--sl-font-size-xx-small: 10px; | |
--sl-font-size-x-small: 12px; | |
--rule-font-size: 0.8rem; | |
--sl-color-primary-50: rgb(243 251 255); | |
--sl-color-primary-100: rgb(215 240 255); | |
--sl-color-primary-200: rgb(184 228 255); | |
--sl-color-primary-300: rgb(148 215 255); | |
--sl-color-primary-400: rgb(98 195 254); | |
--sl-color-primary-500: rgb(98 195 254); | |
--sl-color-primary-600: rgb(98 195 254); | |
--sl-color-primary-700: rgb(57 114 148); | |
--sl-color-primary-800: rgb(47 94 122); | |
--sl-color-primary-900: rgb(33 67 87); | |
--sl-color-primary-950: rgb(20 41 53); | |
--global-padding: 20px; | |
--global-margin: 20px; | |
} | |
body { | |
background-color: #0d1117; | |
} | |
body::-webkit-scrollbar { | |
width: 8px; | |
} | |
body::-webkit-scrollbar-track { | |
background-color: var(--card-bgcolor); | |
} | |
body::-webkit-scrollbar-thumb { | |
box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3); | |
background: var(--primary-color-lowalpha); | |
}html { | |
scroll-behavior: smooth; | |
height: 100%; | |
margin: 0; | |
} | |
body { | |
height: 100%; | |
word-spacing: -0.1rem; | |
} | |
.generated { | |
padding: var(--global-padding); | |
font-size: 0.80rem; | |
color: var(--secondary-color); | |
border-right: 1px dashed var(--secondary-color-lowalpha); | |
margin-bottom: calc(var(--global-margin)*-1); | |
} | |
.vacuum-container { | |
padding-bottom: 0; | |
height: calc(100% - 100px); | |
} | |
header-statistic { | |
display: inline-block; | |
margin: 0 0 calc(var(--global-margin)*-1) var(--global-margin); | |
} | |
hr.header { | |
margin: var(--global-margin) px 0 0; | |
} | |
.terminal .logo { | |
font-size: 1.5rem; | |
} | |
.standard-margin-bt { | |
margin-bottom: var(--global-margin); | |
} | |
.logo { | |
padding: var(--global-padding) 0 0 0; | |
} | |
.rule-details::part(base) { | |
background: var(--sl-color-neutral-0); | |
border: solid 1px tomato; | |
max-height: 200px; | |
} | |
.report-grid { | |
display: grid; | |
grid-template-columns: 1.5fr 10.5fr; | |
grid-template-rows: 1fr; | |
height: 100%; | |
} | |
result-grid { | |
border-left: dashed 1px var(--secondary-color); | |
margin-left: var(--global-margin); | |
padding-left: var(--global-padding); | |
display: grid; | |
grid-template-columns: minmax(0, 2fr) 3fr; | |
grid-template-rows: 1fr; | |
min-height: 0; | |
min-width: 0; | |
} | |
category-report { | |
display: none; | |
grid-area: 1 / 1 / 2 / 2; | |
gap: 10px; | |
min-height: 0; | |
min-width: 0; | |
} | |
category-report::-webkit-scrollbar { | |
width: 8px; | |
} | |
category-report::-webkit-scrollbar-track { | |
background-color: var(--card-bgcolor); | |
} | |
category-report::-webkit-scrollbar-thumb { | |
box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3); | |
background: var(--primary-color-lowalpha); | |
} | |
.wrapper { | |
display: grid; | |
grid-template-columns: 1fr; | |
gap: 10px; | |
grid-auto-rows: minmax(100px, auto); | |
} | |
#category-description { | |
border-top: dashed 1px var(--secondary-color); | |
margin-top: 20px; | |
padding-top: 20px; | |
font-size: var(--sl-font-size-x-small); | |
} | |
sl-tab-group { | |
min-height: 100px; | |
} | |
category-piechart { | |
margin-right: 20px; | |
} | |
.report-statistics { | |
display: flex; | |
flex-direction: row; | |
flex-wrap: wrap; | |
margin-top: 40px; | |
justify-content: space-between; | |
} | |
.report-statistics sl-card { | |
max-width: 300px; | |
} | |
.report-statistics table td, table th { | |
vertical-align: top; | |
border: none; | |
line-height: var(--global-line-height); | |
padding: calc(var(--global-space)/ 2); | |
font-size: 0.9em; | |
} | |
.report-statistics table { | |
display: table; | |
border-collapse: collapse !important; | |
box-sizing: border-box; | |
text-indent: initial; | |
border-spacing: 0; | |
border-color: transparent!important; | |
max-width: 200px; | |
width: fit-content; | |
margin: 0 0 0 10px; | |
font-size: var(--sl-font-size-small); | |
} | |
.report-statistics table,tbody,td,tr { | |
} | |
.report-statistics table td { | |
font-size: var(--sl-font-size-x-small); | |
} | |
.report-statistics table tbody td:first-child { | |
text-align: right; | |
} | |
.quality { | |
color: var(--sl-color-success-500); | |
font-size: var(--sl-font-size-2x-large); | |
text-align: center; | |
padding: var(--global-padding); | |
} | |
violation-drawer { | |
border-left: dashed 1px var(--secondary-color-x-lowalpha); | |
margin-left: var(--global-margin); | |
padding-left: var(--global-padding); | |
grid-area: 1 / 2 / 2 / 3; | |
min-height: 0; | |
min-width: 0; | |
} | |
.drawer-active { | |
border-left: dashed 1px var(--secondary-color); | |
} | |
category-report { | |
overflow-y: auto; | |
} | |
.header-divider { | |
margin-top: var(--global-margin); | |
margin-bottom: var(--global-margin); | |
} | |
/* cater to smaller screens */ | |
@media only screen and (max-width: 1200px) { | |
result-grid { | |
border-left: dashed 1px var(--secondary-color); | |
margin-left: var(--global-margin); | |
padding-left: var(--global-padding); | |
grid-template-rows: minmax(0, 1fr) 1fr; | |
grid-template-columns: 1fr; | |
} | |
violation-drawer { | |
border-top: dashed 1px var(--secondary-color); | |
border-left: none; | |
margin-left: 0; | |
padding-left: 0; | |
grid-area: 2 / 1 / 3 / 2; | |
padding-top: var(--global-padding); | |
} | |
.drawer-active { | |
border-left: none; | |
} | |
} | |
.mobile-warning { | |
display: none; | |
} | |
.header-statistics { | |
margin-top: 10px; | |
} | |
@media only screen and (max-width: 600px) { | |
.generated { | |
padding: 3px; | |
border: none; | |
margin-bottom: initial; | |
} | |
.header-statistics { | |
display: flex; | |
} | |
header-statistic { | |
display: block; | |
margin: initial; | |
} | |
.report-grid { | |
display: block; | |
height: 100%; | |
} | |
result-grid { | |
display: block; | |
border-left:none; | |
margin-left: 0; | |
padding-left: 0; | |
} | |
.mobile-warning{ | |
display: block; | |
font-size: 0.7rem; | |
border: 1px solid var(--warn-200); | |
padding: 3px; | |
color: var(--warn-200); | |
margin-top: 10px; | |
margin-bottom: 10px; | |
} | |
#category-description { | |
margin-bottom: 20px; | |
} | |
} | |
</style> | |
</head> | |
<body class="terminal"> | |
<div class="container vacuum-container"> | |
<section class="terminal-nav"> | |
<header class="terminal-logo"> | |
<div class="logo"> | |
<a href="https://quobix.com/vacuum" class="no-style">vacuum report</a> | |
</div> | |
</header> | |
<div class="generated">Generated: 20 Dec 2022 11:15:34 CET</div> | |
<div class="mobile-warning"> | |
The mobile experience is still being developed. This may look/feel a bit odd for now. | |
</div> | |
<div class="header-statistics"><header-statistic value='2' label='Errors' preset='error-count'></header-statistic><header-statistic value='37' label='Warnings' preset='warning-count'></header-statistic><header-statistic value='21' label='Informs' preset='info-count'></header-statistic><header-statistic value='53' percentage=true label='Quality Grade'></header-statistic> | |
</div> | |
</section> | |
<hr class="header-divider"/> | |
<html-report> | |
<section class="report-grid" slot="navigation"> | |
<nav> | |
<rule-category-navigation default="all"> | |
<rule-category-link name="all" description="All the categories, for those who like a party."> | |
All Categories | |
</rule-category-link> | |
<rule-category-link name="information" description="The info object contains licencing, contact, authorship details and more. Checks to confirm required details have been completed."> | |
Contract Information | |
</rule-category-link> | |
<rule-category-link name="operations" description="Operations are the core of the contract, they define paths and HTTP methods. These rules check operations have been well constructed, looks for operationId, parameter, schema and return types in depth."> | |
Operations | |
</rule-category-link> | |
<rule-category-link name="tags" description="Tags are used as meta-data for operations. They are mainly used by tooling as a taxonomy mechanism to build navigation, search and more. Tags are important as they help consumers navigate the contract when using documentation, testing, code generation or analysis tools."> | |
Tags | |
</rule-category-link> | |
<rule-category-link name="schemas" description="Schemas are how request bodies and response payloads are defined. They define the data going in and the data flowing out of an operation. These rules check for structural validity, checking types, checkingrequired fields and validating correct use of structures."> | |
Schemas | |
</rule-category-link> | |
<rule-category-link name="validation" description="Validation rules make sure that certain characters or patterns have not been used that may causeissues when rendering in different types of applications."> | |
Validation | |
</rule-category-link> | |
<rule-category-link name="descriptions" description="Documentation is really important, in OpenAPI, just about everything can and should have a description. This set of rules checks for absent descriptions, poor quality descriptions (copy/paste), or short descriptions."> | |
Descriptions | |
</rule-category-link> | |
<rule-category-link name="security" description="Security plays a central role in RESTful APIs. These rules make sure that the correct definitionshave been used and put in the right places."> | |
Security | |
</rule-category-link> | |
<rule-category-link name="examples" description="Examples help consumers understand how API calls should look. They are really important forautomated tooling for mocking and testing. These rules check examples have been added to component schemas, parameters and operations. These rules also check that examples match the schema and types provided."> | |
Examples | |
</rule-category-link> | |
</rule-category-navigation> | |
<section id="category-description"> | |
</section> | |
</nav> | |
<result-grid slot="reports"> | |
<category-report slot="violation" id="all"><category-rules id="all"><category-rule maxViolations="100" | |
totalRulesViolated="3" | |
ruleIcon="🔵" ruleId="description-duplication" | |
description="Description duplication check" numResults=21 > | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `279` is a duplicate of line `118`" ruleId="description-duplication" startLine='279' startCol='28' endLine='279' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.409.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">277</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">278</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">279</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">280</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">281</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">282</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `162` is a duplicate of line `118`" ruleId="description-duplication" startLine='162' startCol='28' endLine='162' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.500.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">160</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">161</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">162</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">163</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">164</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">165</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `290` is a duplicate of line `118`" ruleId="description-duplication" startLine='290' startCol='28' endLine='290' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.500.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">288</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">289</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">290</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">291</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">292</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">293</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `224` is a duplicate of line `118`" ruleId="description-duplication" startLine='224' startCol='28' endLine='224' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.400.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">222</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">223</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">224</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">225</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">226</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">227</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `232` is a duplicate of line `126`" ruleId="description-duplication" startLine='232' startCol='24' endLine='232' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.401"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">230</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">231</span><span class="cl"><span class="w"> </span><span class="s2">"401"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">232</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Unauthorized</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">233</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">234</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">235</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `268` is a duplicate of line `118`" ruleId="description-duplication" startLine='268' startCol='28' endLine='268' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.405.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">266</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">267</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">268</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">269</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">270</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">271</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `246` is a duplicate of line `118`" ruleId="description-duplication" startLine='246' startCol='28' endLine='246' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.403.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">244</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">245</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">246</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">247</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">248</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">249</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `178` is a duplicate of line `28`" ruleId="description-duplication" startLine='178' startCol='22' endLine='178' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">176</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">X-Request-Id</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">177</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">header</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">178</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">An unique ID for the request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">179</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">180</span><span class="cl"><span class="w"> </span><span class="nt">minLength</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">181</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `197` is a duplicate of line `47`" ruleId="description-duplication" startLine='197' startCol='22' endLine='197' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">195</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">reference</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">196</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">197</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The reference of the artifact, can be digest or tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">198</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">199</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">200</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `190` is a duplicate of line `40`" ruleId="description-duplication" startLine='190' startCol='22' endLine='190' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">188</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">repository_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">189</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">190</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the repository. If it contains slash, encode it with</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">191</span><span class="cl"><span class="w"> </span><span class="l">URL encoding. e.g. a/b -> a%252Fb</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">192</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">193</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `184` is a duplicate of line `34`" ruleId="description-duplication" startLine='184' startCol='22' endLine='184' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">182</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">project_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">183</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">184</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the project</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">185</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">186</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">187</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `243` is a duplicate of line `137`" ruleId="description-duplication" startLine='243' startCol='24' endLine='243' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.403"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">241</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">242</span><span class="cl"><span class="w"> </span><span class="s2">"403"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">243</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Forbidden</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">244</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">245</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">246</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `221` is a duplicate of line `115`" ruleId="description-duplication" startLine='221' startCol='24' endLine='221' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.400"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">219</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">220</span><span class="cl"><span class="w"> </span><span class="s2">"400"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">221</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Bad request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">222</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">223</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">224</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `287` is a duplicate of line `159`" ruleId="description-duplication" startLine='287' startCol='24' endLine='287' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.500"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">285</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">286</span><span class="cl"><span class="w"> </span><span class="s2">"500"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">287</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Internal server error</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">288</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">289</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">290</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `213` is a duplicate of line `118`" ruleId="description-duplication" startLine='213' startCol='28' endLine='213' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.201.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">211</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">212</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">213</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">214</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">215</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">216</span><span class="cl"><span class="w"> </span><span class="nt">Location</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `235` is a duplicate of line `118`" ruleId="description-duplication" startLine='235' startCol='28' endLine='235' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.401.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">233</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">234</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">235</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">236</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">237</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">238</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `140` is a duplicate of line `118`" ruleId="description-duplication" startLine='140' startCol='28' endLine='140' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.403.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">138</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">139</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">140</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">141</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">142</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">143</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `151` is a duplicate of line `118`" ruleId="description-duplication" startLine='151' startCol='28' endLine='151' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.404.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">149</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">150</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">151</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">152</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">153</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">154</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `254` is a duplicate of line `148`" ruleId="description-duplication" startLine='254' startCol='24' endLine='254' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.404"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">252</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">253</span><span class="cl"><span class="w"> </span><span class="s2">"404"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">254</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Not found</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">255</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">256</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">257</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `257` is a duplicate of line `118`" ruleId="description-duplication" startLine='257' startCol='28' endLine='257' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.404.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">255</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">256</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">257</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">258</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">259</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">260</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `129` is a duplicate of line `118`" ruleId="description-duplication" startLine='129' startCol='28' endLine='129' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.401.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">127</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">128</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">129</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">130</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">131</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">132</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result></category-rule><category-rule maxViolations="100" | |
totalRulesViolated="3" | |
ruleIcon="⚠️" ruleId="oas3-valid-schema-example" | |
description="Examples must be present and valid for operations and components" numResults=37 > | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `errors` on component `Errors`" ruleId="oas3-valid-schema-example" startLine='307' startCol='9' endLine='310' endCol='13' path="$.components.schemas.Errors.errors"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">305</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">object</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">306</span><span class="cl"><span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">307</span><span class="cl"><span class="w"> </span><span class="nt">errors</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">308</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">array</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">309</span><span class="cl"><span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">310</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Error'</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `repository_id` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='330' startCol='9' endLine='333' endCol='19' path="$.components.schemas.Tag.repository_id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">328</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">329</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">330</span><span class="cl"><span class="w"> </span><span class="nt">repository_id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">331</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">integer</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">332</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the repository that the tag belongs to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">333</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `code` on component `Error`" ruleId="oas3-valid-schema-example" startLine='316' startCol='9' endLine='318' endCol='24' path="$.components.schemas.Error.code"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">314</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">object</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">315</span><span class="cl"><span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">316</span><span class="cl"><span class="w"> </span><span class="nt">code</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">317</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">318</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The error code</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">319</span><span class="cl"><span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `id` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='326' startCol='9' endLine='329' endCol='19' path="$.components.schemas.Tag.id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">324</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">object</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">325</span><span class="cl"><span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">326</span><span class="cl"><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">327</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">integer</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">328</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">329</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `page_size` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='74' startCol='9' endLine='78' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[7]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">72</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">73</span><span class="cl"><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">74</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">page_size</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">75</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">76</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The size of per page</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">77</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='240' startCol='15' endLine='241' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.401"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">238</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">239</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">240</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">241</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">242</span><span class="cl"><span class="w"> </span><span class="s2">"403"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">243</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Forbidden</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `sort` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='61' startCol='9' endLine='66' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[5]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">59</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">60</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">61</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">sort</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">62</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">63</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Sort the resource list in ascending or descending order. e.g.</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">64</span><span class="cl"><span class="w"> </span><span class="l">sort by field1 in ascending orderr and field2 in descending order with "sort=field1,-field2"</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='134' startCol='15' endLine='135' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.401"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">132</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">133</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">134</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">135</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">136</span><span class="cl"><span class="w"> </span><span class="s2">"403"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">137</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Forbidden</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `reference` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='45' startCol='9' endLine='50' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[3]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">43</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">44</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">45</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">reference</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">46</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">47</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The reference of the artifact, can be digest or tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">48</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `X-Request-Id` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='26' startCol='9' endLine='30' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">24</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">listTags</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">25</span><span class="cl"><span class="w"> </span><span class="nt">parameters</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">26</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">X-Request-Id</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">27</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">header</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">28</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">An unique ID for the request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">29</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='251' startCol='15' endLine='252' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.403"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">249</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">250</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">251</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">252</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">253</span><span class="cl"><span class="w"> </span><span class="s2">"404"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">254</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Not found</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `page` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='67' startCol='9' endLine='71' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[6]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">65</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">66</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">67</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">page</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">68</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">69</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The page number</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">70</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='229' startCol='15' endLine='230' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.400"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">227</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">228</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">229</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">230</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">231</span><span class="cl"><span class="w"> </span><span class="s2">"401"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">232</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Unauthorized</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `message` on component `Error`" ruleId="oas3-valid-schema-example" startLine='319' startCol='9' endLine='321' endCol='24' path="$.components.schemas.Error.message"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">317</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">318</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The error code</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">319</span><span class="cl"><span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">320</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">321</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The error message</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">322</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">a model for all the error response coming from harbor</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='295' startCol='15' endLine='296' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.500"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">293</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">294</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">295</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">296</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">297</span><span class="cl"><span class="w"> </span><span class="nt">x-codegen-request-body-name</span><span class="p">:</span><span class="w"> </span><span class="l">tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">298</span><span class="cl"><span class="w"></span><span class="nt">components</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='110' startCol='15' endLine='111' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.200"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">108</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">109</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">110</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">111</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">array</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">112</span><span class="cl"><span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">113</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Tag'</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `repository_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='38' startCol='9' endLine='44' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[2]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">36</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">37</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">38</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">repository_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">39</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">40</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the repository. If it contains slash, encode it with</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">41</span><span class="cl"><span class="w"> </span><span class="l">URL encoding. e.g. a/b -> a%252Fb</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `X-Request-Id` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='176' startCol='9' endLine='180' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">174</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">createTag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">175</span><span class="cl"><span class="w"> </span><span class="nt">parameters</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">176</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">X-Request-Id</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">177</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">header</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">178</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">An unique ID for the request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">179</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='284' startCol='15' endLine='285' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.409"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">282</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">283</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">284</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">285</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">286</span><span class="cl"><span class="w"> </span><span class="s2">"500"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">287</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Internal server error</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='205' startCol='13' endLine='206' endCol='15' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.requestBody"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">203</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">204</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">205</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">206</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Tag'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">207</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">208</span><span class="cl"><span class="w"> </span><span class="nt">responses</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `q` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='51' startCol='9' endLine='60' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[4]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">49</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">50</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">51</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">q</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">52</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">53</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Query string to query resources. Supported query patterns are</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">54</span><span class="cl"><span class="w"> </span><span class="s2">"exact match(k=v)"</span><span class="p">,</span><span class="w"> </span><span class="s2">"fuzzy match(k=~v)"</span><span class="p">,</span><span class="w"> </span><span class="s2">"range(k=[min~max])"</span><span class="p">,</span><span class="w"> </span><span class="l">"list with</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='145' startCol='15' endLine='146' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.403"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">143</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">144</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">145</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">146</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">147</span><span class="cl"><span class="w"> </span><span class="s2">"404"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">148</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Not found</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='273' startCol='15' endLine='274' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.405"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">271</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">272</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">273</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">274</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">275</span><span class="cl"><span class="w"> </span><span class="s2">"409"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">276</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Conflict</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='156' startCol='15' endLine='157' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.404"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">154</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">155</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">156</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">157</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">158</span><span class="cl"><span class="w"> </span><span class="s2">"500"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">159</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Internal server error</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `repository_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='188' startCol='9' endLine='194' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[2]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">186</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">187</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">188</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">repository_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">189</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">190</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the repository. If it contains slash, encode it with</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">191</span><span class="cl"><span class="w"> </span><span class="l">URL encoding. e.g. a/b -> a%252Fb</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `push_time` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='341' startCol='9' endLine='344' endCol='19' path="$.components.schemas.Tag.push_time"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">339</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">340</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the tag</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">341</span><span class="cl"><span class="w"> </span><span class="nt">push_time</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">342</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">343</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The push time of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">344</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">date-time</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `reference` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='195' startCol='9' endLine='200' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[3]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">193</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">194</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">195</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">reference</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">196</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">197</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The reference of the artifact, can be digest or tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">198</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `artifact_id` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='334' startCol='9' endLine='337' endCol='19' path="$.components.schemas.Tag.artifact_id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">332</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the repository that the tag belongs to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">333</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">334</span><span class="cl"><span class="w"> </span><span class="nt">artifact_id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">335</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">integer</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">336</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the artifact that the tag attached to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">337</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `name` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='338' startCol='9' endLine='340' endCol='24' path="$.components.schemas.Tag.name"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">336</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the artifact that the tag attached to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">337</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">338</span><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">339</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">340</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">341</span><span class="cl"><span class="w"> </span><span class="nt">push_time</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `pull_time` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='345' startCol='9' endLine='348' endCol='19' path="$.components.schemas.Tag.pull_time"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">343</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The push time of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">344</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">date-time</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">345</span><span class="cl"><span class="w"> </span><span class="nt">pull_time</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">346</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">347</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The latest pull time of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">348</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">date-time</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `project_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='32' startCol='9' endLine='37' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[1]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">30</span><span class="cl"><span class="w"> </span><span class="nt">minLength</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">31</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">32</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">project_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">33</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">34</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the project</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">35</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `project_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='182' startCol='9' endLine='187' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[1]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">180</span><span class="cl"><span class="w"> </span><span class="nt">minLength</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">181</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">182</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">project_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">183</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">184</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the project</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">185</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `with_signature` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='82' startCol='9' endLine='87' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[8]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">80</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">81</span><span class="cl"><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="m">10</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">82</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">with_signature</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">83</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">84</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Specify whether the signature is included inside the returning</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">85</span><span class="cl"><span class="w"> </span><span class="l">tags</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='167' startCol='15' endLine='168' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.500"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">165</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">166</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">167</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">168</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">169</span><span class="cl"><span class="w"> </span><span class="nt">post</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">170</span><span class="cl"><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='262' startCol='15' endLine='263' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.404"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">260</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">261</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">262</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">263</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">264</span><span class="cl"><span class="w"> </span><span class="s2">"405"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">265</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Method not allowed</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `with_immutable_status` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='89' startCol='9' endLine='94' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[9]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">87</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">boolean</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">88</span><span class="cl"><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">89</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">with_immutable_status</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">90</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">91</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Specify whether the immutable status is included inside the returning</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">92</span><span class="cl"><span class="w"> </span><span class="l">tags</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='123' startCol='15' endLine='124' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.400"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">121</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">122</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">123</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">124</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">125</span><span class="cl"><span class="w"> </span><span class="s2">"401"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">126</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Unauthorized</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result></category-rule><category-rule maxViolations="100" | |
totalRulesViolated="3" | |
ruleIcon="❌" ruleId="operation-tag-defined" | |
description="Operation tags must be defined in global tags." numResults=2 > | |
<category-rule-result category="tags" howToFix="This tag has not been defined in the global scope, you should always ensure that any tags used in operations, are defined globally in the root 'tags' definition." slot="results" message="the `post` operation at path `/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags` contains a tag `artifact`, that is not defined in the global document tags" ruleId="operation-tag-defined" startLine='171' startCol='9' endLine='171' endCol='9' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.tags[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">169</span><span class="cl"><span class="w"> </span><span class="nt">post</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">170</span><span class="cl"><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">171</span><span class="cl"><span class="w"> </span>- <span class="l">artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">172</span><span class="cl"><span class="w"> </span><span class="nt">summary</span><span class="p">:</span><span class="w"> </span><span class="l">Create tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">173</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Create a tag for the specified artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">174</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">createTag</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="tags" howToFix="This tag has not been defined in the global scope, you should always ensure that any tags used in operations, are defined globally in the root 'tags' definition." slot="results" message="the `get` operation at path `/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags` contains a tag `artifact`, that is not defined in the global document tags" ruleId="operation-tag-defined" startLine='21' startCol='9' endLine='21' endCol='9' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.tags[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">19</span><span class="cl"><span class="w"> </span><span class="nt">get</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">20</span><span class="cl"><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">21</span><span class="cl"><span class="w"> </span>- <span class="l">artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">22</span><span class="cl"><span class="w"> </span><span class="nt">summary</span><span class="p">:</span><span class="w"> </span><span class="l">List tags</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">23</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">List tags of the specific artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">24</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">listTags</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result></category-rule></category-rules> | |
</category-report> | |
<category-report slot="violation" id="information"><category-rules id="information"></category-rules> | |
</category-report> | |
<category-report slot="violation" id="operations"><category-rules id="operations"></category-rules> | |
</category-report> | |
<category-report slot="violation" id="tags"><category-rules id="tags"><category-rule maxViolations="100" | |
totalRulesViolated="1" | |
ruleIcon="❌" ruleId="operation-tag-defined" | |
description="Operation tags must be defined in global tags." numResults=2 > | |
<category-rule-result category="tags" howToFix="This tag has not been defined in the global scope, you should always ensure that any tags used in operations, are defined globally in the root 'tags' definition." slot="results" message="the `post` operation at path `/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags` contains a tag `artifact`, that is not defined in the global document tags" ruleId="operation-tag-defined" startLine='171' startCol='9' endLine='171' endCol='9' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.tags[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">169</span><span class="cl"><span class="w"> </span><span class="nt">post</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">170</span><span class="cl"><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">171</span><span class="cl"><span class="w"> </span>- <span class="l">artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">172</span><span class="cl"><span class="w"> </span><span class="nt">summary</span><span class="p">:</span><span class="w"> </span><span class="l">Create tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">173</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Create a tag for the specified artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">174</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">createTag</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="tags" howToFix="This tag has not been defined in the global scope, you should always ensure that any tags used in operations, are defined globally in the root 'tags' definition." slot="results" message="the `get` operation at path `/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags` contains a tag `artifact`, that is not defined in the global document tags" ruleId="operation-tag-defined" startLine='21' startCol='9' endLine='21' endCol='9' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.tags[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">19</span><span class="cl"><span class="w"> </span><span class="nt">get</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">20</span><span class="cl"><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">21</span><span class="cl"><span class="w"> </span>- <span class="l">artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">22</span><span class="cl"><span class="w"> </span><span class="nt">summary</span><span class="p">:</span><span class="w"> </span><span class="l">List tags</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">23</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">List tags of the specific artifact</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">24</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">listTags</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result></category-rule></category-rules> | |
</category-report> | |
<category-report slot="violation" id="schemas"><category-rules id="schemas"></category-rules> | |
</category-report> | |
<category-report slot="violation" id="validation"><category-rules id="validation"></category-rules> | |
</category-report> | |
<category-report slot="violation" id="descriptions"><category-rules id="descriptions"><category-rule maxViolations="100" | |
totalRulesViolated="1" | |
ruleIcon="🔵" ruleId="description-duplication" | |
description="Description duplication check" numResults=21 > | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `279` is a duplicate of line `118`" ruleId="description-duplication" startLine='279' startCol='28' endLine='279' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.409.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">277</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">278</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">279</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">280</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">281</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">282</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `162` is a duplicate of line `118`" ruleId="description-duplication" startLine='162' startCol='28' endLine='162' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.500.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">160</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">161</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">162</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">163</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">164</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">165</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `290` is a duplicate of line `118`" ruleId="description-duplication" startLine='290' startCol='28' endLine='290' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.500.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">288</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">289</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">290</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">291</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">292</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">293</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `224` is a duplicate of line `118`" ruleId="description-duplication" startLine='224' startCol='28' endLine='224' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.400.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">222</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">223</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">224</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">225</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">226</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">227</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `232` is a duplicate of line `126`" ruleId="description-duplication" startLine='232' startCol='24' endLine='232' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.401"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">230</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">231</span><span class="cl"><span class="w"> </span><span class="s2">"401"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">232</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Unauthorized</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">233</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">234</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">235</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `268` is a duplicate of line `118`" ruleId="description-duplication" startLine='268' startCol='28' endLine='268' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.405.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">266</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">267</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">268</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">269</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">270</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">271</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `246` is a duplicate of line `118`" ruleId="description-duplication" startLine='246' startCol='28' endLine='246' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.403.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">244</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">245</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">246</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">247</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">248</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">249</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `178` is a duplicate of line `28`" ruleId="description-duplication" startLine='178' startCol='22' endLine='178' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">176</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">X-Request-Id</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">177</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">header</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">178</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">An unique ID for the request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">179</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">180</span><span class="cl"><span class="w"> </span><span class="nt">minLength</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">181</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `197` is a duplicate of line `47`" ruleId="description-duplication" startLine='197' startCol='22' endLine='197' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">195</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">reference</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">196</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">197</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The reference of the artifact, can be digest or tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">198</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">199</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">200</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `190` is a duplicate of line `40`" ruleId="description-duplication" startLine='190' startCol='22' endLine='190' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">188</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">repository_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">189</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">190</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the repository. If it contains slash, encode it with</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">191</span><span class="cl"><span class="w"> </span><span class="l">URL encoding. e.g. a/b -> a%252Fb</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">192</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">193</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `184` is a duplicate of line `34`" ruleId="description-duplication" startLine='184' startCol='22' endLine='184' endCol='22' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">182</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">project_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">183</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">184</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the project</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">185</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">186</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">187</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `243` is a duplicate of line `137`" ruleId="description-duplication" startLine='243' startCol='24' endLine='243' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.403"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">241</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">242</span><span class="cl"><span class="w"> </span><span class="s2">"403"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">243</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Forbidden</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">244</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">245</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">246</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `221` is a duplicate of line `115`" ruleId="description-duplication" startLine='221' startCol='24' endLine='221' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.400"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">219</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">220</span><span class="cl"><span class="w"> </span><span class="s2">"400"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">221</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Bad request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">222</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">223</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">224</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `287` is a duplicate of line `159`" ruleId="description-duplication" startLine='287' startCol='24' endLine='287' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.500"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">285</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">286</span><span class="cl"><span class="w"> </span><span class="s2">"500"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">287</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Internal server error</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">288</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">289</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">290</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `213` is a duplicate of line `118`" ruleId="description-duplication" startLine='213' startCol='28' endLine='213' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.201.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">211</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">212</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">213</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">214</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">215</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">216</span><span class="cl"><span class="w"> </span><span class="nt">Location</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `235` is a duplicate of line `118`" ruleId="description-duplication" startLine='235' startCol='28' endLine='235' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.401.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">233</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">234</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">235</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">236</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">237</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">238</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `140` is a duplicate of line `118`" ruleId="description-duplication" startLine='140' startCol='28' endLine='140' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.403.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">138</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">139</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">140</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">141</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">142</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">143</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `151` is a duplicate of line `118`" ruleId="description-duplication" startLine='151' startCol='28' endLine='151' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.404.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">149</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">150</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">151</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">152</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">153</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">154</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `254` is a duplicate of line `148`" ruleId="description-duplication" startLine='254' startCol='24' endLine='254' endCol='24' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.404"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">252</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">253</span><span class="cl"><span class="w"> </span><span class="s2">"404"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">254</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Not found</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">255</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">256</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">257</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `257` is a duplicate of line `118`" ruleId="description-duplication" startLine='257' startCol='28' endLine='257' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.404.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">255</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">256</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">257</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">258</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">259</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">260</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="descriptions" howToFix="Descriptions are only useful, if they are meaningful. If a description is meaningful, then it won't be something you copy and paste. Please don't duplicate descriptions, make them deliberate and meaningful." slot="results" message="Description at line `129` is a duplicate of line `118`" ruleId="description-duplication" startLine='129' startCol='28' endLine='129' endCol='28' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.401.headers.X-Request-Id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">127</span><span class="cl"><span class="w"> </span><span class="nt">headers</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">128</span><span class="cl"><span class="w"> </span><span class="nt">X-Request-Id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">129</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the corresponding request for the response</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">130</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">131</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">132</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result></category-rule></category-rules> | |
</category-report> | |
<category-report slot="violation" id="security"><category-rules id="security"></category-rules> | |
</category-report> | |
<category-report slot="violation" id="examples"><category-rules id="examples"><category-rule maxViolations="100" | |
totalRulesViolated="1" | |
ruleIcon="⚠️" ruleId="oas3-valid-schema-example" | |
description="Examples must be present and valid for operations and components" numResults=37 > | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `errors` on component `Errors`" ruleId="oas3-valid-schema-example" startLine='307' startCol='9' endLine='310' endCol='13' path="$.components.schemas.Errors.errors"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">305</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">object</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">306</span><span class="cl"><span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">307</span><span class="cl"><span class="w"> </span><span class="nt">errors</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">308</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">array</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">309</span><span class="cl"><span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">310</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Error'</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `repository_id` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='330' startCol='9' endLine='333' endCol='19' path="$.components.schemas.Tag.repository_id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">328</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">329</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">330</span><span class="cl"><span class="w"> </span><span class="nt">repository_id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">331</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">integer</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">332</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the repository that the tag belongs to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">333</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `code` on component `Error`" ruleId="oas3-valid-schema-example" startLine='316' startCol='9' endLine='318' endCol='24' path="$.components.schemas.Error.code"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">314</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">object</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">315</span><span class="cl"><span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">316</span><span class="cl"><span class="w"> </span><span class="nt">code</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">317</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">318</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The error code</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">319</span><span class="cl"><span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `id` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='326' startCol='9' endLine='329' endCol='19' path="$.components.schemas.Tag.id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">324</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">object</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">325</span><span class="cl"><span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">326</span><span class="cl"><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">327</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">integer</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">328</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">329</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `page_size` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='74' startCol='9' endLine='78' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[7]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">72</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">73</span><span class="cl"><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">74</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">page_size</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">75</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">76</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The size of per page</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">77</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='240' startCol='15' endLine='241' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.401"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">238</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">239</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">240</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">241</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">242</span><span class="cl"><span class="w"> </span><span class="s2">"403"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">243</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Forbidden</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `sort` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='61' startCol='9' endLine='66' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[5]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">59</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">60</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">61</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">sort</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">62</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">63</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Sort the resource list in ascending or descending order. e.g.</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">64</span><span class="cl"><span class="w"> </span><span class="l">sort by field1 in ascending orderr and field2 in descending order with "sort=field1,-field2"</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='134' startCol='15' endLine='135' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.401"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">132</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">133</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">134</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">135</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">136</span><span class="cl"><span class="w"> </span><span class="s2">"403"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">137</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Forbidden</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `reference` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='45' startCol='9' endLine='50' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[3]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">43</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">44</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">45</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">reference</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">46</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">47</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The reference of the artifact, can be digest or tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">48</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `X-Request-Id` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='26' startCol='9' endLine='30' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">24</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">listTags</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">25</span><span class="cl"><span class="w"> </span><span class="nt">parameters</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">26</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">X-Request-Id</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">27</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">header</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">28</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">An unique ID for the request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">29</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='251' startCol='15' endLine='252' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.403"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">249</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">250</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">251</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">252</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">253</span><span class="cl"><span class="w"> </span><span class="s2">"404"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">254</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Not found</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `page` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='67' startCol='9' endLine='71' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[6]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">65</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">66</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">67</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">page</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">68</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">69</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The page number</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">70</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='229' startCol='15' endLine='230' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.400"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">227</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">228</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">229</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">230</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">231</span><span class="cl"><span class="w"> </span><span class="s2">"401"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">232</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Unauthorized</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `message` on component `Error`" ruleId="oas3-valid-schema-example" startLine='319' startCol='9' endLine='321' endCol='24' path="$.components.schemas.Error.message"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">317</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">318</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The error code</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">319</span><span class="cl"><span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">320</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">321</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The error message</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">322</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">a model for all the error response coming from harbor</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='295' startCol='15' endLine='296' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.500"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">293</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">294</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">295</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">296</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">297</span><span class="cl"><span class="w"> </span><span class="nt">x-codegen-request-body-name</span><span class="p">:</span><span class="w"> </span><span class="l">tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">298</span><span class="cl"><span class="w"></span><span class="nt">components</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='110' startCol='15' endLine='111' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.200"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">108</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">109</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">110</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">111</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">array</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">112</span><span class="cl"><span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">113</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Tag'</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `repository_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='38' startCol='9' endLine='44' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[2]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">36</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">37</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">38</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">repository_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">39</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">40</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the repository. If it contains slash, encode it with</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">41</span><span class="cl"><span class="w"> </span><span class="l">URL encoding. e.g. a/b -> a%252Fb</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `X-Request-Id` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='176' startCol='9' endLine='180' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[0]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">174</span><span class="cl"><span class="w"> </span><span class="nt">operationId</span><span class="p">:</span><span class="w"> </span><span class="l">createTag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">175</span><span class="cl"><span class="w"> </span><span class="nt">parameters</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">176</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">X-Request-Id</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">177</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">header</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">178</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">An unique ID for the request</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">179</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='284' startCol='15' endLine='285' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.409"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">282</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">283</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">284</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">285</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">286</span><span class="cl"><span class="w"> </span><span class="s2">"500"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">287</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Internal server error</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='205' startCol='13' endLine='206' endCol='15' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.requestBody"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">203</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">204</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">205</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">206</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Tag'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">207</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">208</span><span class="cl"><span class="w"> </span><span class="nt">responses</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `q` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='51' startCol='9' endLine='60' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[4]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">49</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">50</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">51</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">q</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">52</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">53</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Query string to query resources. Supported query patterns are</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">54</span><span class="cl"><span class="w"> </span><span class="s2">"exact match(k=v)"</span><span class="p">,</span><span class="w"> </span><span class="s2">"fuzzy match(k=~v)"</span><span class="p">,</span><span class="w"> </span><span class="s2">"range(k=[min~max])"</span><span class="p">,</span><span class="w"> </span><span class="l">"list with</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='145' startCol='15' endLine='146' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.403"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">143</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">144</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">145</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">146</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">147</span><span class="cl"><span class="w"> </span><span class="s2">"404"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">148</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Not found</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='273' startCol='15' endLine='274' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.405"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">271</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">272</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">273</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">274</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">275</span><span class="cl"><span class="w"> </span><span class="s2">"409"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">276</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Conflict</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='156' startCol='15' endLine='157' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.404"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">154</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">155</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">156</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">157</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">158</span><span class="cl"><span class="w"> </span><span class="s2">"500"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">159</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Internal server error</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `repository_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='188' startCol='9' endLine='194' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[2]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">186</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">187</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">188</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">repository_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">189</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">190</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the repository. If it contains slash, encode it with</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">191</span><span class="cl"><span class="w"> </span><span class="l">URL encoding. e.g. a/b -> a%252Fb</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `push_time` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='341' startCol='9' endLine='344' endCol='19' path="$.components.schemas.Tag.push_time"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">339</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">340</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the tag</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">341</span><span class="cl"><span class="w"> </span><span class="nt">push_time</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">342</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">343</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The push time of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">344</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">date-time</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `reference` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='195' startCol='9' endLine='200' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[3]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">193</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">194</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">195</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">reference</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">196</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">197</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The reference of the artifact, can be digest or tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">198</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `artifact_id` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='334' startCol='9' endLine='337' endCol='19' path="$.components.schemas.Tag.artifact_id"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">332</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the repository that the tag belongs to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">333</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">334</span><span class="cl"><span class="w"> </span><span class="nt">artifact_id</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">335</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">integer</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">336</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the artifact that the tag attached to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">337</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `name` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='338' startCol='9' endLine='340' endCol='24' path="$.components.schemas.Tag.name"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">336</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The ID of the artifact that the tag attached to</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">337</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">338</span><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">339</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">340</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">341</span><span class="cl"><span class="w"> </span><span class="nt">push_time</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Missing example for `pull_time` on component `Tag`" ruleId="oas3-valid-schema-example" startLine='345' startCol='9' endLine='348' endCol='19' path="$.components.schemas.Tag.pull_time"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">343</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The push time of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">344</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">date-time</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">345</span><span class="cl"><span class="w"> </span><span class="nt">pull_time</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">346</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">347</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The latest pull time of the tag</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">348</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">date-time</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `project_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='32' startCol='9' endLine='37' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[1]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">30</span><span class="cl"><span class="w"> </span><span class="nt">minLength</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">31</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">32</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">project_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">33</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">34</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the project</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">35</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `project_name` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='182' startCol='9' endLine='187' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.parameters[1]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">180</span><span class="cl"><span class="w"> </span><span class="nt">minLength</span><span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">181</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">string</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">182</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">project_name</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">183</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">path</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">184</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">The name of the project</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">185</span><span class="cl"><span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `with_signature` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='82' startCol='9' endLine='87' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[8]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">80</span><span class="cl"><span class="w"> </span><span class="nt">format</span><span class="p">:</span><span class="w"> </span><span class="l">int64</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">81</span><span class="cl"><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="m">10</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">82</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">with_signature</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">83</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">84</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Specify whether the signature is included inside the returning</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">85</span><span class="cl"><span class="w"> </span><span class="l">tags</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='167' startCol='15' endLine='168' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.500"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">165</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">166</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">167</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">168</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">169</span><span class="cl"><span class="w"> </span><span class="nt">post</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">170</span><span class="cl"><span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='262' startCol='15' endLine='263' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.post.responses.404"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">260</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">261</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">262</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">263</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">264</span><span class="cl"><span class="w"> </span><span class="s2">"405"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">265</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Method not allowed</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `with_immutable_status` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='89' startCol='9' endLine='94' endCol='11' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.parameters[9]"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">87</span><span class="cl"><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">boolean</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">88</span><span class="cl"><span class="w"> </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">89</span><span class="cl"><span class="w"> </span>- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">with_immutable_status</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">90</span><span class="cl"><span class="w"> </span><span class="nt">in</span><span class="p">:</span><span class="w"> </span><span class="l">query</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">91</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Specify whether the immutable status is included inside the returning</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">92</span><span class="cl"><span class="w"> </span><span class="l">tags</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result> | |
<category-rule-result category="examples" howToFix="Examples are critical for consumers to be able to understand schemas and models defined by the spec. Without examples, developers can't understand the type of data the API will return in real life. Examples are turned into mocks and can provide a rich testing capability for APIs. Add detailed examples everywhere!" slot="results" message="Schema for `application/json` does not contain any examples or example data" ruleId="oas3-valid-schema-example" startLine='123' startCol='15' endLine='124' endCol='17' path="$.paths./projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags.get.responses.400"><pre tabindex="0" class="chroma"><code><span class="line"><span class="ln">121</span><span class="cl"><span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">122</span><span class="cl"><span class="w"> </span><span class="nt">application/json</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line hl"><span class="ln">123</span><span class="cl"><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">124</span><span class="cl"><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s1">'#/components/schemas/Errors'</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">125</span><span class="cl"><span class="w"> </span><span class="s2">"401"</span><span class="p">:</span><span class="w"> | |
</span></span></span><span class="line"><span class="ln">126</span><span class="cl"><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l">Unauthorized</span><span class="w"> | |
</span></span></span></code></pre></category-rule-result></category-rule></category-rules> | |
</category-report> | |
<violation-drawer slot="details"></violation-drawer> | |
</result-grid> | |
</section> | |
</html-report> | |
</div> | |
<div class="container"> | |
<footer> | |
<!-- do something in here --> | |
</footer><script> | |
// statistics | |
window.statistics = {"filesizeKb":10,"filesizeBytes":10845,"specType":"openapi","specFormat":"oas3","version":"3.0.1","references":3,"schemas":3,"parameters":10,"paths":1,"operations":2,"tags":1,"security":1,"overallScore":53,"totalErrors":2,"totalWarnings":37,"totalInfo":21,"categoryStatistics":[{"categoryName":"Contract Information","categoryId":"information","numIssues":0,"score":0,"warnings":0,"errors":0,"info":0,"hints":0},{"categoryName":"Operations","categoryId":"operations","numIssues":0,"score":0,"warnings":0,"errors":0,"info":0,"hints":0},{"categoryName":"Tags","categoryId":"tags","numIssues":2,"score":0,"warnings":0,"errors":2,"info":0,"hints":0},{"categoryName":"Schemas","categoryId":"schemas","numIssues":0,"score":0,"warnings":0,"errors":0,"info":0,"hints":0},{"categoryName":"Validation","categoryId":"validation","numIssues":0,"score":0,"warnings":0,"errors":0,"info":0,"hints":0},{"categoryName":"Descriptions","categoryId":"descriptions","numIssues":21,"score":0,"warnings":0,"errors":0,"info":21,"hints":0},{"categoryName":"Security","categoryId":"security","numIssues":0,"score":0,"warnings":0,"errors":0,"info":0,"hints":0},{"categoryName":"Examples","categoryId":"examples","numIssues":37,"score":0,"warnings":37,"errors":0,"info":0,"hints":0}]} | |
</script> | |
<script> | |
(()=>{"use strict";setTimeout((function(){const t=document.querySelector("category-piechart");t&&t.setChartData(window.statistics)}),200)})(); | |
</script></div> | |
</body> | |
</html> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment