Zum Inhalt springen

Build-Anhänge ​

Protokolle, Berichte und andere Dateien, die an ein Artefakt angehängt sind, samt ihrem Verlauf.

Die Vorgänge dieser Gruppe mit ihrer Zugriffsregel, Wiederholungsregel, ihren Parametern und Antworten. Jede Anfrage trägt einen Schlüssel: Authorization: Bearer <Schlüssel> (siehe „Authentifizierung“).

Vorgänge ​

Anhänge eines Builds abrufen ​

GET HEAD /api/v1/repositories/{repository}/artifacts/{id}/attachments

Zugriff: Repository-Berechtigung: annotation.read; Dateischlüssel: read · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert die aktuelle Anhangsrevision eines Artefakts: bis zu 32 Einträge, die jeweils ein anderes veröffentlichtes Artefakt des Repositorys mit name, kind (manifest, sbom, signature, report, file) und description benennen, dazu Akteur und Zeit der Änderung. Revision 0 ohne Einträge bedeutet, dass nie etwas angehängt wurde. Laden Sie eine angehängte Datei über ihre artifactId herunter.

Parameter

NameOrtTypErforderlichRegeln
repositoryPfadstringjaentspricht ^[a-z0-9][a-z0-9_-]{0,63}$
idPfadstring (uuid)ja—

Antwort 200

FeldTypErforderlichRegeln
revisionintegerja0–2147483647
itemsArray von objectjahöchstens 32 Elemente
items[].namestringja1–240 Zeichen
items[].kindstringjaeiner von manifest, sbom, signature, report, file
items[].artifactIdstring (uuid)ja—
items[].descriptionstringjahöchstens 512 Zeichen
actorstringjadarf null sein
createdAtstring (date-time)jadarf null sein

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash
curl -X GET "$ARKVORY_URL/api/v1/repositories/$REPOSITORY/artifacts/$ID/attachments" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Anhänge eines Builds ersetzen ​

PUT /api/v1/repositories/{repository}/artifacts/{id}/attachments

Zugriff: Repository-Berechtigung: annotation.write, artifact.read; Dateischlüssel: read, write · Wiederholung: Nur mit der erwarteten Revision wiederholen (compare-and-swap)

Ersetzt die gesamte Anhangsliste eines Artefakts (bis zu 32 Einträge; eine leere Liste entfernt alle) und liefert die neue Revision zurück. Jedes Ziel muss ein anderes, bereits im selben Repository veröffentlichtes Artefakt sein (laden Sie es zuerst hoch), Namen sind ohne Beachtung der Groß-/Kleinschreibung eindeutig, und Beschreibungen haben bis zu 512 Zeichen. expectedRevision muss die aktuelle Revision sein (0 für die erste Liste), sonst 409 revision_mismatch; in einer beliebigen Revision genannte Artefakte bleiben vor dem Löschen geschützt.

Parameter

NameOrtTypErforderlichRegeln
repositoryPfadstringjaentspricht ^[a-z0-9][a-z0-9_-]{0,63}$
idPfadstring (uuid)ja—

Anfragetext (application/json)

FeldTypErforderlichRegeln
expectedRevisionintegerja0–2147483646
itemsArray von objectjahöchstens 32 Elemente
items[].namestringja1–240 Zeichen
items[].kindstringjaeiner von manifest, sbom, signature, report, file
items[].artifactIdstring (uuid)ja—
items[].descriptionstringjahöchstens 512 Zeichen

Antwort 200

FeldTypErforderlichRegeln
revisionintegerja0–2147483647
itemsArray von objectjahöchstens 32 Elemente
items[].namestringja1–240 Zeichen
items[].kindstringjaeiner von manifest, sbom, signature, report, file
items[].artifactIdstring (uuid)ja—
items[].descriptionstringjahöchstens 512 Zeichen
actorstringjadarf null sein
createdAtstring (date-time)jadarf null sein

Antworten: 200, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Beispiel

bash
curl -X PUT "$ARKVORY_URL/api/v1/repositories/$REPOSITORY/artifacts/$ID/attachments" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"items":[]}'

Anhangsverlauf eines Builds auflisten ​

GET HEAD /api/v1/repositories/{repository}/artifacts/{id}/attachments/history

Zugriff: Repository-Berechtigung: annotation.read; Dateischlüssel: read · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert die früheren und die aktuelle Anhangsrevision eines Artefakts, neueste zuerst, 20 pro Seite, jeweils mit ihren Einträgen, Akteur und Zeit; weiter mit before = next. Die angehängten Artefakte jeder Revision bleiben herunterladbar, weil sie vor dem Löschen geschützt sind.

Parameter

NameOrtTypErforderlichRegeln
repositoryPfadstringjaentspricht ^[a-z0-9][a-z0-9_-]{0,63}$
idPfadstring (uuid)ja—
beforeQueryintegernein1–2147483647

Antwort 200

FeldTypErforderlichRegeln
itemsArray von objectjahöchstens 20 Elemente
items[].revisionintegerja0–2147483647
items[].itemsArray von objectjahöchstens 32 Elemente
items[].items[].namestringja1–240 Zeichen
items[].items[].kindstringjaeiner von manifest, sbom, signature, report, file
items[].items[].artifactIdstring (uuid)ja—
items[].items[].descriptionstringjahöchstens 512 Zeichen
items[].actorstringjadarf null sein
items[].createdAtstring (date-time)jadarf null sein
nextintegerja1–2147483647; darf null sein

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash
curl -X GET "$ARKVORY_URL/api/v1/repositories/$REPOSITORY/artifacts/$ID/attachments/history" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Arkvory · ProAnimaStudio