Rails 엔드포인트

다양한 GitLab 컴포넌트에서 사용하는 Rails 엔드포인트는 다른 소비자에서는 사용할 수 없습니다. 이 문서는 GitLab 코드베이스에서 작업하는 사람들을 대상으로 합니다.

이러한 Rails 엔드포인트:

  • 문서화가 충분하지 않을 수 있으며 공개 또는 비공개 API와 동일한 규칙을 준수하지 않을 수 있습니다.
  • 표준화된 규칙이나 지침을 준수하지 않을 수 있습니다.
  • 코드베이스 내에서 특정 내부 목적을 위해 설계되었습니다.
  • 언제든지 변경될 수 있습니다.

컨셉 검증 기간: 피드백 요청

우리는 현재 Rails 엔드포인트를 문서화하기 위한 새로운 접근 방식을 평가하고 있습니다. 피드백 이슈를 확인하고 의견, 제안 또는 우려를 자유롭게 공유해 주세요. 귀하의 참여에 감사드리며 문서를 개선하는 데 도움을 주셔서 감사합니다!

SAST 스캐너

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

파일별로 정렬된 기존 Merge Request 코드 품질 발견 디렉터리

파일별로 정렬된 기존 코드 품질 발견(있는 경우) 디렉터리을 가져옵니다. 

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

응답: 

{
  "files": {
    "index.js": [
      {
        "line": 1,
        "description": "Unexpected 'debugger' statement.",
        "severity": "major"
      }
    ]
  }
}

새로운, 해결된 및 기존 Merge Request 코드 품질 발견 디렉터리

새로운, 해결된 및 기존 코드 품질 발견(있는 경우) 디렉터리을 가져옵니다. 

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

{
  "status": "failed",
  "new_errors": [
    {
      "description": "Unexpected 'debugger' statement.",
      "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 }
}