正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。
ドキュメントに関する現在のご利用体験についてお聞かせください。アンケートにご協力ください。

スキーマリファレンス

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com
  • ステータス: ベータ版

この機能の利用可否は、機能フラグによって制御されます。詳細については、履歴を参照してください。この機能はテスト目的で利用可能ですが、本番環境での使用には対応していません。

GitLab Orbitは6つのドメインにわたる27のノードタイプのインデックスを作成します。クエリのエンティティ名としてこれらを使用してください。

ライブスキーマをいつでもフェッチするには:

glab orbit remote schema

コア

ノードタイプ説明主要プロパティ
GroupGitLabグループまたはサブグループid、full_path、name、visibility、traversal_path
ProjectGitLabプロジェクトおよびリポジトリid、full_path、name、visibility、archived、star_count
UserGitLabユーザーアカウントid、username、email、name、state、is_admin
NoteGitLabオブジェクトに対するコメントまたは注釈id、note、noteable_type、noteable_id、internal、confidential

ソースコード

ノードタイプ説明主要プロパティ
BranchGitブランチid、project_id、name、is_default
Definition関数、クラス、メソッド、またはモジュールの定義id、file_path、fqn、name、definition_type、start_line、end_line、content
Directoryリポジトリ内のディレクトリid、project_id、path、name
Fileソースコードファイルid、path、name、extension、language、content
ImportedSymbolインポートまたはクロスファイルシンボル参照id、file_path、import_type、import_path、identifier_name

コードレビュー

ノードタイプ説明主要プロパティ
MergeRequestマージリクエストid、iid、title、description、source_branch、target_branch、state、draft、squash
MergeRequestDiffMR内の変更のスナップショットid、merge_request_id、commits_count、files_count
MergeRequestDiffFileMR差分で変更されたファイルid、new_path、old_path、new_file、renamed_file、deleted_file

CI/CD

ノードタイプ説明主要プロパティ
PipelineCI/CDパイプラインの実行id、sha、ref、status、source、duration、failure_reason
Stageパイプラインステージid、name、status、position
JobCI/CDジョブid、name、status、ref、allow_failure、environment、failure_reason
DeploymentコミットのCI/CDデプロイid、iid、status、ref、sha、environment_id
EnvironmentCI/CDデプロイターゲットid、name、state、tier、external_url
RunnerCI/CD Runnerid、runner_type、name、active、locked

プランニング

ノードタイプ説明主要プロパティ
WorkItemイシュー、エピック、タスク、インシデント、またはその他の作業アイテムid、iid、title、description、state、work_item_type、due_date、weight
Milestoneマイルストーンid、title、state、due_date、start_date
Label作業を分類するためのラベルid、title、color

セキュリティ

ノードタイプ説明主要プロパティ
Findingsecurity_findingsからのセキュリティスキャン検出結果id、uuid、name、description、severity、deduplicated
SecurityScanパイプライン内のセキュリティスキャン実行id、scan_type、status、latest
Vulnerability確認済みまたは潜在的なセキュリティ脆弱性id、title、state、severity、report_type、resolved_on_default_branch
VulnerabilityIdentifierCVE、CWE、またはその他の外部参照id、external_type、external_id、name、url
VulnerabilityOccurrence脆弱性の特定の発生箇所（RailsではVulnerabilities::Finding）id、uuid、severity、report_type、detection_method、cve、location
VulnerabilityScannerセキュリティスキャナーid、external_id、name、vendor

注記

  • 定義IDは、プロジェクトおよびブランチごとにスコープされたコンテンツハッシュ整数です。異なるプロジェクトで同じシンボルを定義した場合、関数名やファイルパスが同一であっても、IDは異なります。
  • すべてのエンティティIDは、基となる値が整数であっても、クエリレスポンスでは文字列として返されます。これにより、Number.MAX_SAFE_INTEGERを超える値に対してJavaScriptクライアントでの精度損失を防ぎます。
  • DefinitionおよびFileノードのcontentフィールドには、定義またはファイルの完全なソーステキストが含まれます。これらのフィールドは、GitLabへの個別のAPIコールを行わずにファイルコンテンツをハイドレートする必要があるエージェントツールで利用できます。
  • すべてのノードには、認可フィルタリングに使用されるtraversal_pathプロパティが含まれています。クエリ結果は、リクエストを行うユーザーがアクセスできるエンティティに自動的にスコープされます。