इवेंट

कर्सर के बाद इंस्टॉलेशन की इवेंट फ़ीड और इवेंट टाइप की सूची।

इस समूह के ऑपरेशन, उनके एक्सेस नियम, पुनः प्रयास नियम, पैरामीटर और जवाबों के साथ। हर अनुरोध में एक कुंजी होती है: Authorization: Bearer <कुंजी> (“प्रमाणीकरण” देखें)।

ऑपरेशन

इंस्टॉलेशन के इवेंट पढ़ें

GET HEAD /api/v1/events

एक्सेस: कोई भी मान्य कुंजी या सत्र · पुनः प्रयास: दोहराना सुरक्षित है (पढ़ना)

कर्सर after के बाद के अधिकतम limit इवेंट (1–500, डिफ़ॉल्ट 100), सबसे पुराना पहले, CloudEvents 1.0 के रूप में लौटाता है: हर उस रिपॉज़िटरी के प्रकाशन, हटाना, फ़ाइल रिविज़न, पैकेज पंजीकरण, एनोटेशन, अटैचमेंट, स्टेज, प्रमोशन तथा इमेज, npm और Git LFS के परिवर्तन, जिसकी सूची कॉलर देख सकता है (artifact.list)। after के बिना फ़ीड रखे गए सबसे पुराने इवेंट से शुरू होती है। आगे पढ़ने के लिए next को after में दें: यह उन इवेंट के पार भी बढ़ता है जिन्हें कॉलर नहीं देख सकता, प्रति अनुरोध अधिकतम 5000। types नामित टाइप या artifact.* जैसे उपसर्ग रखता है, repository एक रिपॉज़िटरी। oldest से पुराने कर्सर को 410 events_cursor_expired मिलता है; दूसरे epoch के कर्सर को (सर्वर बैकअप से पुनर्स्थापित हुआ) 409 events_epoch_changed; दोनों events में वर्तमान epoch, oldest और head देते हैं। id से डुप्लिकेट हटाएँ; इवेंट एक संकेत है, वर्तमान स्थिति सामान्य रूट से पढ़ें।

पैरामीटर

नाम	स्थान	प्रकार	आवश्यक	नियम
after	क्वेरी	string	नहीं	पैटर्न: ^[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	क्वेरी	integer	नहीं	1–500
types	क्वेरी	string	नहीं	अधिकतम 2048 वर्ण; Comma-separated names or prefixes such as artifact.*
repository	क्वेरी	string	नहीं	पैटर्न: ^[a-z0-9][a-z0-9_-]{0,63}$

प्रतिक्रिया 200

फ़ील्ड	प्रकार	आवश्यक	नियम
epoch	string (uuid)	हाँ	—
items	object का ऐरे	हाँ	अधिकतम 500 आइटम
items[].specversion	string	हाँ	इनमें से एक: 1.0
items[].id	string	हाँ	पैटर्न: ^[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})$; इवेंट ID, <epoch>:<position>; इसी से डुप्लिकेट हटाएँ
items[].source	string	हाँ	—
items[].type	string	हाँ	—
items[].subject	string	हाँ	आर्टिफ़ैक्ट ID, या फ़ाइल इवेंट में पथ
items[].time	string (date-time)	हाँ	—
items[].datacontenttype	string	हाँ	इनमें से एक: application/json
items[].dataschema	string	हाँ	—
items[].partitionkey	string	हाँ	repository:<repository>; एक पार्टिशन के इवेंट अपना कमिट क्रम बनाए रखते हैं
items[].arkvoryposition	string	हाँ	दशमलव अंकों में पूर्णांक, स्ट्रिंग के रूप में भेजा जाता है
items[].arkvoryepoch	string (uuid)	हाँ	—
items[].data	object	हाँ	टाइप का डेटा; उसका JSON Schema टाइप सूची में है
next	string	हाँ	पैटर्न: ^[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	हाँ	दशमलव अंकों में पूर्णांक, स्ट्रिंग के रूप में भेजा जाता है
oldest	string	हाँ	दशमलव अंकों में पूर्णांक, स्ट्रिंग के रूप में भेजा जाता है

प्रतिक्रियाएँ: 200, 400, 401, 403, 404, 409, 410, 422, 503, 507

उदाहरण

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

इवेंट टाइप सूचीबद्ध करें

GET HEAD /api/v1/events/types

एक्सेस: कोई भी मान्य कुंजी या सत्र · पुनः प्रयास: दोहराना सुरक्षित है (पढ़ना)

यह सर्वर जो भी इवेंट टाइप लिखता है, सब लौटाता है: नाम, schemaVersion, दायरा, पाठक को चाहिए अनुमति, क्रम बनाए रखने वाला पार्टिशन और data का JSON Schema। CloudEvents का type arkvory.<name>.v<schemaVersion> है।

प्रतिक्रिया 200

फ़ील्ड	प्रकार	आवश्यक	नियम
items	object का ऐरे	हाँ	—
items[].name	string	हाँ	—
items[].schemaVersion	integer	हाँ	कम से कम 1
items[].scope	string	हाँ	इनमें से एक: repository, system
items[].permission	string	हाँ	इनमें से एक: artifact.list, administrator
items[].partition	string	हाँ	—
items[].description	string	हाँ	—
items[].dataSchema	object	नहीं	—

प्रतिक्रियाएँ: 200, 400, 401, 403, 404, 409, 422, 503, 507

उदाहरण

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