เผยแพร่เวอร์ชัน Workflow

เผยแพร่เวอร์ชัน Workflow

รองรับการเผยแพร่เวอร์ชัน Workflow ที่ระบุให้เป็นเวอร์ชันโปรดักชันบนออนไลน์

อินเทอร์เฟซนี้ใช้ API Key ของ Workflow เป้าหมายในการยืนยันตัวตน และอนุญาตให้เรียกใช้ได้เฉพาะ Workflow ที่เปิดสิทธิ์การจัดการเวอร์ชันเท่านั้น

วิธีการร้องขอ

POST

URL สำหรับร้องขอ

https://api.${endpoint}/v1/workflow/version/release

การยืนยันตัวตนในการร้องขอ

ดูรายละเอียดได้ที่คำอธิบายวิธีการยืนยันตัวตนใน API Overview โปรดใช้ API Key ของ Workflow เป้าหมายเป็น token

การร้องขอ

ตัวอย่างการร้องขอ

curl -X POST 'https://api.${endpoint}/v1/workflow/version/release' \ -H 'Authorization: Bearer ${token}' \ -H 'Content-Type: application/json' \ -d '{ "version": "v2" }'
                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/release' \
  -H 'Authorization: Bearer ${token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "v2"
  }'

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

Header สำหรับร้องขอ

ฟิลด์ ประเภท คำอธิบาย
Authorization Bearer ${token} ใช้ API Key ของ Workflow เป้าหมายในการยืนยันตัวตนของการเรียกใช้
Content-Type application/json รูปแบบของเนื้อหาคำขอ

พารามิเตอร์การร้องขอ (Body Parameters)

พารามิเตอร์ ประเภท คำอธิบาย required
version String หมายเลขเวอร์ชันที่ต้องการเผยแพร่ให้เป็นเวอร์ชันออนไลน์ true

การตอบกลับ

เนื้อหาการตอบกลับ

{ "code": 0, "message": "OK", "data": { "version": "v2", "previous_version": "v1" } }
                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "version": "v2",
    "previous_version": "v1"
  }
}

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ

ฟิลด์ ประเภท คำอธิบาย
version String หมายเลขเวอร์ชันที่เผยแพร่ในครั้งนี้
previous_version String หมายเลขเวอร์ชันออนไลน์ก่อนการเผยแพร่ ครั้งแรกที่เผยแพร่จะเป็นค่าว่าง

การตอบกลับเมื่อผิดพลาด

ฟิลด์ ประเภท คำอธิบาย
code int รหัสข้อผิดพลาด
message string ข้อความแสดงข้อผิดพลาด

รหัสสถานะ

รหัสสถานะ คำอธิบาย
200 สำเร็จ
400 พารามิเตอร์ไม่ถูกต้อง
401 ไม่ได้รับอนุญาต
403 สิทธิ์ไม่เพียงพอ หรือ API Key ยังไม่ได้เปิดสิทธิ์การจัดการเวอร์ชัน
429 คำขอถี่เกินไป
500 ข้อผิดพลาดของเซิร์ฟเวอร์