레일스 엔드포인트

레일스 엔드포인트는 다양한 GitLab 구성 요소에서 사용되며, 다른 소비자는 사용할 수 없습니다. 이 문서는 GitLab 코드베이스에서 작업하는 사람들을 위한 것입니다.

이 레일스 엔드포인트는:

  • 광범위한 문서가 없거나 공개 또는 비공식 API와 같은 규칙을 따르지 않을 수 있습니다.
  • 표준화된 규칙이나 지침을 준수하지 않을 수 있습니다.
  • 코드베이스의 특정 내부 목적으로 설계되었습니다.
  • 언제든지 변경될 수 있습니다.

개념 증명 기간: 피드백 요청

우리는 레일스 엔드포인트 문서화를 위한 새로운 접근 방식을 평가하고 있습니다. 피드백 이슈를 확인해 보세요 그리고 자유롭게 당신의 생각, 제안 또는 우려 사항을 공유해 주세요. 문서 개선에 참여해 주셔서 감사합니다!

SAST 스캐너

정적 애플리케이션 보안 테스트(SAST)는 소스 코드에 대한 알려진 취약점을 검사합니다. 프로젝트에서 SAST가 활성화되면 이러한 엔드포인트를 사용할 수 있습니다.

파일별로 정렬된 기존 병합 요청 코드 품질 발견 목록 가져오기

기존의 코드 품질 발견 목록이 있는 경우, 이를 파일별로 정렬하여 가져옵니다.

GET /projects/:id/merge_requests/:merge_request_iid/codequality_mr_diff_reports.json

응답:

{
  "files": {
    "index.js": [
      {
        "line": 1,
        "description": "예기치 않은 'debugger' 문장입니다.",
        "severity": "major"
      }
    ]
  }
}

새로운, 해결된 및 기존 병합 요청 코드 품질 발견 목록 가져오기

새로운, 해결된 및 기존 코드 품질 발견 목록이 있는 경우 가져옵니다.

GET /projects/:id/merge_requests/:merge_request_iid/codequality_reports.json

{
  "status": "failed",
  "new_errors": [
    {
      "description": "예기치 않은 'debugger' 문장입니다.",
      "severity": "major",
      "file_path": "index.js",
      "line": 1,
      "web_url": "https://gitlab.com/jannik_lehmann/code-quality-test/-/blob/ed1c1b3052fe6963beda0e416d5e2ba3378eb715/noise.rb#L12",
      "engine_name": "eslint"
    }
  ],
  "resolved_errors": [],
  "existing_errors": [],
  "summary": { "total": 1, "resolved": 0, "errored": 1 }
}