Repositorys
Die Repositorys, die ein Aufrufer sehen darf, und die Details eines Repositorys.
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
Zugängliche Repositorys auflisten
GET HEAD /api/v1/repositories
Zugriff: Repositorys, die der Aufrufer sehen darf (repository.read) · Wiederholung: Wiederholen ist sicher (Lesen)
Listet die Repositorys nach Namen geordnet auf, in denen der Aufrufer eine Berechtigung besitzt, jeweils mit ihren Formaten (upack, assets) und den eigenen Berechtigungen des Aufrufers dort; ein verwalteter Dienstschlüssel sieht nur die Repositorys, in denen er repository.read besitzt. Ein Repository ist der Geltungsbereich der Zuweisungen des Aufrufers, kein Eintrag eines serverweiten Verzeichnisses. Seiten enthalten limit Karten (1–100, Standard 50); weiter mit after = next.
Parameter
| Name | Ort | Typ | Erforderlich | Regeln |
|---|---|---|---|---|
after | Query | string | nein | entspricht ^[a-z0-9][a-z0-9_-]{0,63}$; Exclusive repository ID boundary; authorization is rechecked on every page. |
limit | Query | integer | nein | 1–100; Standard 50 |
Antwort 200
| Feld | Typ | Erforderlich | Regeln |
|---|---|---|---|
items | Array von object | ja | höchstens 100 Elemente |
items[].id | string | ja | entspricht ^[a-z0-9][a-z0-9_-]{0,63}$ |
items[].formats | Array von string | ja | 2–2 Elemente; keine wiederholten Elemente; jedes Element: einer von upack, assets |
items[].permissions | Array von string | ja | 1–24 Elemente; keine wiederholten Elemente; jedes Element: einer von repository.read, storage.read, storage.manage, diagnostics.read, artifact.read, artifact.list, artifact.delete, artifact.promote, content.read, upload.create, upload.read, upload.write, upload.complete, upload.cancel, job.read, package.read, package.publish, asset.read, asset.write, asset.restore, annotation.read, annotation.write, reference.write, audit.read |
next | string | ja | entspricht ^[a-z0-9][a-z0-9_-]{0,63}$; darf null sein |
Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507
Beispiel
curl -X GET "$ARKVORY_URL/api/v1/repositories" \
-H "Authorization: Bearer $ARKVORY_TOKEN"Repository-Karte abrufen
GET HEAD /api/v1/repositories/{repository}
Zugriff: Repositorys, die der Aufrufer sehen darf (repository.read) · Wiederholung: Wiederholen ist sicher (Lesen)
Liefert die Karte eines Repositorys für den Aufrufer: seine Formate und die Berechtigungen des Aufrufers darin. Ein Repository, das der Aufrufer nicht sehen kann, antwortet mit 404, genau wie ein nicht vorhandenes; HEAD macht daraus eine günstige Zugriffsprüfung. Ein sichtbares Repository gewährt keinen Zugriff auf seinen Inhalt oder seine Einstellungen.
Parameter
| Name | Ort | Typ | Erforderlich | Regeln |
|---|---|---|---|---|
repository | Pfad | string | ja | entspricht ^[a-z0-9][a-z0-9_-]{0,63}$ |
Antwort 200
| Feld | Typ | Erforderlich | Regeln |
|---|---|---|---|
id | string | ja | entspricht ^[a-z0-9][a-z0-9_-]{0,63}$ |
formats | Array von string | ja | 2–2 Elemente; keine wiederholten Elemente; jedes Element: einer von upack, assets |
permissions | Array von string | ja | 1–24 Elemente; keine wiederholten Elemente; jedes Element: einer von repository.read, storage.read, storage.manage, diagnostics.read, artifact.read, artifact.list, artifact.delete, artifact.promote, content.read, upload.create, upload.read, upload.write, upload.complete, upload.cancel, job.read, package.read, package.publish, asset.read, asset.write, asset.restore, annotation.read, annotation.write, reference.write, audit.read |
Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507
Beispiel
curl -X GET "$ARKVORY_URL/api/v1/repositories/$REPOSITORY" \
-H "Authorization: Bearer $ARKVORY_TOKEN"