버전과 호환성

약속

• 응답에서 필드를 지우거나 뜻을 바꾸지 않습니다.
• 요청의 필수 필드를 늘리지 않습니다. 새 필드는 선택입니다.
• 새 응답 필드는 언제든 추가될 수 있습니다. 모르는 필드는 무시하세요.
• 오류 문자열은 바뀌지 않습니다. 새 오류 문자열이 추가될 수 있으니 모르는 오류는 상태 코드로 처리하세요.
• 위 약속을 깨야 하면 /api/v2 경로를 새로 엽니다. /api/plugin/v1/* 는 배포된 플러그인이 계속 부르므로 영구히 유지됩니다.

클라이언트 작성 규칙

• JSON은 느슨하게 파싱하세요. 모르는 키가 있어도 실패하면 안 됩니다.
• 상태 코드를 먼저 보고, 그다음 error 문자열을 봅니다.
• blockedUntil은 null일 수 있습니다. exhausted는 true일 때만 존재합니다.
• 시각은 ISO-8601 UTC 문자열입니다. 소수점 초가 붙을 수 있습니다.

플러그인 최소 버전

공식 플러그인 경로(/api/plugin/v1/*)에만 있는 규칙입니다. 운영자가 최소 버전을 정하면 그보다 낮은 pluginVersion의 claim과 report는 426으로 거절됩니다. GET /api/plugin/v1/version 으로 미리 확인할 수 있습니다. 서버 API(/api/v1/servers/*)에는 버전 검사가 없습니다.

변경 내역

엔드포인트와 규칙의 변경은 변경 내역 페이지에 날짜순으로 적습니다.