InfoGrab Docs

GLQL API

GLQL API에 대해 설명합니다.

히스토리 GitLab 18.7에서 도입 . 이 API를 사용하여 GitLab 쿼리 언어(GLQL) 쿼리를 프로그래밍 방식으로 실행합니다. GLQL은 프로젝트 및 그룹 전체에서 이슈, 머지 요청, 에픽과 같은 GitLab 리소스 를 검색하고 필터링하기 위한 단순화된 쿼리 언어를 제공합니다. 사전 요건: 그룹 또는 프로젝트가 해당 데이터에 대한 접근을 허용해야 합니다. 비공개 그룹 및 프로젝트의 경우 적절한 권한이 있는 개인 액세스 토큰 을 사용해야 합니다. GLQL 쿼리 실행 # GitLab 리소스를 검색하고 필터링하기 위한 GLQL 쿼리를 실행합니다. POST /glql Note 이 엔드포인트는 쿼리 SHA를 기반으로 쿼리를 속도 제한합니다. 시간 초과된 동일한 쿼리가 추적되며 너무 자주 실행되면 일시적으로 차단될 수 있습니다. 지원되는 속성: 속성 유형 필수 설명 glql_yaml string Yes 선택적 YAML 구성이 있는 GLQL 쿼리. 최대 크기: 10,000바이트(10 KB). 자세한 내용은 쿼리 형식 을 참조하세요. after string No 페이지네이션을 위한 커서. 이전 쿼리의 data.pageInfo.endCursor 값을 사용하여 다음 결과 페이지를 가져옵니다. 쿼리 형식 # glql_yaml 파라미터는 query 키가 있는 YAML 형식을 허용합니다: fields: id,title,author group: my-group limit: 10 sort: created desc query: state = opened 구성 옵션 # YAML에는 다음 구성 옵션을 포함할 수 있습니다: 옵션 유형 필수 설명 fields string No 반환할 쉼표로 구분된 필드 목록. 기본값: title . 사용 가능한 필드 를 참조하세요. group string No 특정 그룹으로 쿼리 범위를 지정합니다. project 와 함께 사용할 수 없습니다. group 이 쿼리에도 지정된 경우 쿼리 값이 우선합니다. limit integer No 반환할 최대 결과 수. 1에서 100 사이여야 합니다. 기본값: 100 . project string No 특정 프로젝트로 쿼리 범위를 지정합니다. 형식: group/project . project 가 쿼리에도 지정된 경우 쿼리 값이 우선합니다. sort string No 결과 정렬 순서. 형식: field direction (예: created asc 또는 created desc ). 사용 가능한 필드 # fields 구성 옵션은 GLQL의 사용 가능한 필드 에 의해 정의됩니다. GLQL 쿼리 구문 # 쿼리 구문은 GLQL 에 의해 정의됩니다. 응답 속성 # 성공하면 200 OK 와 다음 응답 속성을 반환합니다: 속성 유형 설명 data object 쿼리 결과를 포함합니다. data.count integer 일치하는 결과의 총 수. data.nodes array 요청된 필드가 포함된 일치하는 리소스 배열. data.pageInfo object 페이지네이션 정보. data.pageInfo.endCurs