Ereignisse

Der Ereignis-Feed der Installation nach einem Cursor und die Liste der Ereignistypen.

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

Die Ereignisse der Installation lesen

GET HEAD /api/v1/events

Zugriff: Jeder gültige Schlüssel oder jede gültige Sitzung · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert, älteste zuerst, bis zu limit Ereignisse (1–500, Standard 100) nach dem Cursor after als CloudEvents 1.0: Veröffentlichungen, Löschungen, Dateirevisionen, Paketregistrierungen, Annotationen, Anhänge, Stufen, Hochstufungen sowie Änderungen an Images, npm und Git LFS in jedem Repository, das der Aufrufer auflisten darf (artifact.list). Ohne after beginnt der Feed beim ältesten aufbewahrten Ereignis. Zum Weiterlesen übergeben Sie next als after: Es rückt auch über Ereignisse hinweg, die der Aufrufer nicht sehen darf, höchstens 5000 je Anfrage. types behält die genannten Typen oder Präfixe wie artifact.*, repository ein Repository. Ein Cursor älter als oldest erhält 410 events_cursor_expired, ein Cursor einer anderen epoch (der Server wurde aus einem Backup wiederhergestellt) 409 events_epoch_changed; beide enthalten die aktuellen epoch, oldest und head in events. Deduplizieren Sie nach id; ein Ereignis ist ein Hinweis, den aktuellen Stand lesen Sie über die üblichen Routen.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
after	Query	string	nein	entspricht ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(0|[1-9][0-9]{0,18})$; Event id or next of a page; without it the feed starts at oldest
limit	Query	integer	nein	1–500
types	Query	string	nein	höchstens 2048 Zeichen; Comma-separated names or prefixes such as artifact.*
repository	Query	string	nein	entspricht ^[a-z0-9][a-z0-9_-]{0,63}$

Antwort 200

Feld	Typ	Erforderlich	Regeln
epoch	string (uuid)	ja	—
items	Array von object	ja	höchstens 500 Elemente
items[].specversion	string	ja	einer von 1.0
items[].id	string	ja	entspricht ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(0|[1-9][0-9]{0,18})$; Ereignis-ID, <epoch>:<position>; danach deduplizieren
items[].source	string	ja	—
items[].type	string	ja	—
items[].subject	string	ja	Artefakt-ID oder der Pfad bei Dateiereignissen
items[].time	string (date-time)	ja	—
items[].datacontenttype	string	ja	einer von application/json
items[].dataschema	string	ja	—
items[].partitionkey	string	ja	repository:<repository>; Ereignisse einer Partition behalten ihre Commit-Reihenfolge
items[].arkvoryposition	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet
items[].arkvoryepoch	string (uuid)	ja	—
items[].data	object	ja	Daten des Typs; ihr JSON Schema steht in der Typliste
next	string	ja	entspricht ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:(0|[1-9][0-9]{0,18})$
head	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet
oldest	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet

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

Beispiel

curl -X GET "$ARKVORY_URL/api/v1/events" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Die Ereignistypen auflisten

GET HEAD /api/v1/events/types

Zugriff: Jeder gültige Schlüssel oder jede gültige Sitzung · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert jeden Ereignistyp, den dieser Server schreibt: Name, schemaVersion, Bereich, das Recht, das ein Leser braucht, die Partition, die seine Reihenfolge hält, und das JSON Schema von data. Der CloudEvents-type ist arkvory.<name>.v<schemaVersion>.

Antwort 200

Feld	Typ	Erforderlich	Regeln
items	Array von object	ja	—
items[].name	string	ja	—
items[].schemaVersion	integer	ja	mindestens 1
items[].scope	string	ja	einer von repository, system
items[].permission	string	ja	einer von artifact.list, administrator
items[].partition	string	ja	—
items[].description	string	ja	—
items[].dataSchema	object	nein	—

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

Beispiel

curl -X GET "$ARKVORY_URL/api/v1/events/types" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"