discord api spec

ข้อกำหนด OpenAPI ของ Discord

พื้นที่เก็บข้อมูลนี้มีการแสดงตัวอย่างสาธารณะของข้อกำหนด OpenAPI 3.1 สำหรับ API ของ Discord ปัจจุบันข้อมูลจำเพาะนี้มีเฉพาะใน Discord API เวอร์ชันล่าสุด (v10) เท่านั้น

การแสดงตัวอย่างสาธารณะของข้อมูลจำเพาะของ OpenAPI อาจมีการเปลี่ยนแปลงโดยไม่ได้แจ้งให้ทราบล่วงหน้า และไม่ควรใช้ภายในสภาพแวดล้อมการใช้งานจริง

การใช้งาน

ไฟล์ข้อมูลจำเพาะ

มีข้อมูลจำเพาะสองเวอร์ชัน—ข้อมูลจำเพาะมาตรฐานและข้อมูลจำเพาะตัวอย่าง:

• openapi.json เป็นข้อกำหนดมาตรฐานที่มี API สาธารณะที่เสถียร
• openapi_preview.json เป็นข้อกำหนดการแสดงตัวอย่างซึ่งมีฟีเจอร์ API ที่ไม่เสถียรและ/หรือรุ่นทดลอง สิ่งนี้ไม่ควรถือว่ามีเสถียรภาพ หรือใช้ในสภาพแวดล้อมการผลิต

บูรณาการกับบุรุษไปรษณีย์

หากต้องการใช้ข้อมูลจำเพาะกับบุรุษไปรษณีย์ คุณสามารถดูคอลเลกชันสาธารณะได้

มีส่วนร่วม

เนื้อหาข้อมูลจำเพาะของ OpenAPI จะถูกสร้างขึ้นโดยอัตโนมัติ ดังนั้น เราจึงไม่อนุญาตให้สาธารณะสนับสนุน repo นี้

- สำหรับการแก้ไขข้อบกพร่องหรือการปรับปรุง คุณสามารถเปิดปัญหาได้

อนุสัญญาเฉพาะ

• นี่คือการแสดงตัวอย่างและอาจไม่ถูกต้อง หากคุณพบความแตกต่างระหว่างข้อมูลจำเพาะและเอกสารของเรา นอกเหนือจากที่กล่าวไว้ด้านล่าง โปรดแจ้งให้เราทราบ และปฏิบัติตามเอกสาร ไม่ใช่ข้อมูลจำเพาะ
• แม้ว่าเราจะกำหนดสหภาพ anyOf และ oneOf แต่ทั้งหมดหมายความว่ามีเพียงประเภทเดียวจากรายการเท่านั้นที่สามารถใช้เป็นรูปแบบข้อมูลได้ เช่น anyOf: {'Cat', 'Dog'} ยังคงหมายความว่าคุณสามารถผ่าน Cat หรือ Dog ไม่ใช่ Cat+Dog สิ่งนี้แสดงให้เห็นโดยส่วนขยายที่กำหนดเอง x-discord-union: oneOf เราใช้ anyOf เมื่อเราไม่สามารถใช้ oneOf ในทางเทคนิคได้ สาเหตุหนึ่งที่ต้องทำเช่นนั้นคือ เมื่อฟิลด์ทั้งหมดเป็นทางเลือก และข้อมูลที่ส่งผ่านสามารถตรวจสอบความถูกต้องได้มากกว่าหนึ่งรูปแบบ
• เราหลีกเลี่ยงการระบุฟิลด์ตอบกลับมากเกินไป และเพียงกำหนดประเภทฟิลด์ เช่น int32 และเราหลีกเลี่ยงการกำหนดขั้นต่ำ สูงสุด ฯลฯ ที่เฉพาะเจาะจง
• บางฟิลด์ที่พิมพ์เป็นสตริงในเอกสารของเราอาจพิมพ์เป็น ints ในข้อมูลจำเพาะ API ของเรายอมรับสตริงสำหรับฟิลด์ int หากสามารถแยกวิเคราะห์เป็น ints ได้ เราคิดว่ามันจะแม่นยำกว่าหากระบุสตริง int-parseable เหล่านี้เป็น ints

ปัญหาที่ทราบ

• (เกือบ) ฟิลด์ที่เป็นโมฆะทั้งหมดจะถูกทำเครื่องหมายเพิ่มเติมว่าเป็นทางเลือก และฟิลด์ที่ไม่บังคับทั้งหมดจะถูกทำเครื่องหมายเพิ่มเติมว่าเป็นโมฆะ
• การดำเนินงานและฟิลด์ไม่มีคำอธิบาย
• การดำเนินการไม่มีแท็ก
• ฟิลด์แฟล็กไม่ได้แสดงรายละเอียดค่าแฟล็กเฉพาะและความหมาย
• args ของข้อความค้นหาเพิ่มเติมจะพิมพ์เป็น nullable แม้ว่าจะไม่สมเหตุสมผลก็ตาม