진단
진단 실행(회차 생성). 대상 = screenIds ∪ labelIds 로 고른 화면, 분석 = 화면마다 (화면 viewport ∩ viewports).
POST/api/projects/{projectId}/diagnoses
분석(ScreenResult)을 QUEUED 로 만들고 진단 일꾼이 가져간다. 201 + Location: /api/diagnoses/{id}
- Scope
diagnoses:write - Since
1.0.0 - Success
201 - Demo tokenReal token required
id diagnoses.create
Path parameters
CreateDiagnosisRequestPath
projectIdstringrequired
Request body
CreateDiagnosisRequestBody
screenIdsstring[]optional직접 고른 화면(모두 이 프로젝트 화면이어야 한다, 아니면 400 BAD_REQUEST)
labelIdsstring[]optional레이블로 고른 화면(공통 · 이 프로젝트 전용, 실행 시점의 화면 목록으로 고정)
viewportsAbleflowViewport[]optional없거나 비면 프로젝트 진단 기본값
criteriaAbleflowCriterion[]optional없거나 비면 프로젝트 진단 기본값
excludeRequiresAuthbooleanoptionaltrue 면 로그인이 필요한 URL 화면은 빼고 만든다(기본 false = 넣고 열리지 않으면 LOGIN_REQUIRED 실패)
Response 201
CreateDiagnosisResponse
trigger 는 MANUAL 고정. 실행 권한은 구성원 누구나(화면 관리와 같다)
Errors
| Status | Code | When |
|---|---|---|
| 400 | VALIDATION_FAILED | 대상 화면이 0개 |
| 400 | BAD_REQUEST | 다른 프로젝트 화면 · 쓸 수 없는 레이블 |
| 400 | SCREEN_LIMIT_EXCEEDED | 한 회차 화면 수 초과 |
| 409 | DIAGNOSIS_ALREADY_RUNNING | 진행 중 회차가 있다 |
| 403 | WORKSPACE_SUSPENDED | 워크스페이스가 정지됐다(요금제로 막을 때). detail { target: NEW_DIAGNOSIS, reason: SUSPENDED } |
| 409 | PLAN_LIMIT_REACHED | 이번 기간 분석 수 + 이번 회차 분석 수, 또는 이번 기간 진단 회차 + 1 이 요금제 한도를 넘는다(요금제로 막을 때). detail { target: NEW_DIAGNOSIS, reason: LIMIT_REACHED, limitKey: monthlyAnalyses | monthlyDiagnoses, used, limit, requested, suggestedPlan? } |
9 errors common to every public API
| Status | Code | When |
|---|---|---|
| 400 | UNSUPPORTED_API_VERSION | AbleFlow-Version(또는 토큰 고정 버전)을 맞출 수 없다. detail { requested, supported } |
| 401 | UNAUTHORIZED | Authorization 머리글이 없다(토큰 없음). 공개 API 요청으로 보지 않아 응답에 AbleFlow-Version 머리글이 없다 |
| 401 | INVALID_TOKEN | 토큰이 틀렸거나 폐기됐다(발급자가 워크스페이스를 나가 폐기된 토큰 포함) |
| 401 | TOKEN_EXPIRED | 토큰이 만료됐다 |
| 403 | INSUFFICIENT_SCOPE | 토큰 범위가 모자란다. detail { required } |
| 403 | DEMO_READ_ONLY | 데모 토큰은 GET · HEAD 만 부를 수 있다 |
| 403 | PLAN_FEATURE_REQUIRED | 워크스페이스 요금제에 공개 API 가 없거나 체험이 끝났다(요금제로 막을 때, 데모 토큰 제외). detail { target: PUBLIC_API, reason: PLAN_FEATURE | TRIAL_ENDED, suggestedPlan? } |
| 404 | RESOURCE_NOT_FOUND | 자원이 없거나 토큰이 묶인 워크스페이스 밖이다 |
| 429 | API_RATE_LIMITED | 호출 한도를 넘었다. Retry-After(초) |