Make ref parameter optional in get raw file api

changelogs/unreleased/fix-compliance-pipeline-validation.yml

+---
+title: Make ref parameter optional in get raw file api
+merge_request: 58787
+author:
+type: changed

doc/api/repository_files.md

@@ -168,8 +168,8 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
 
 Parameters:
 
-- `file_path` (required) - URL encoded full path to new file. Ex. lib%2Fclass%2Erb
-- `ref` (required) - The name of branch, tag or commit
+- `file_path` (required) - URL encoded full path to new file, such as lib%2Fclass%2Erb.
+- `ref` (optional) - The name of branch, tag or commit. Default is the `HEAD` of the project.
 
 NOTE:
 Like [Get file from repository](repository_files.md#get-file-from-repository) you can use `HEAD` to get just file metadata.

ee/app/assets/javascripts/groups/settings/compliance_frameworks/utils.js

@@ -45,7 +45,7 @@ export const fetchPipelineConfigurationFileExists = async (path) => {
   }
 
   try {
-    const { status } = await Api.getRawFile(`${group}/${project}`, file);
+    const { status } = await Api.getRawFile(`${group}/${project}`, file, { ref: undefined });
 
     return status === httpStatus.OK;
   } catch (e) {

lib/api/files.rb

@@ -113,7 +113,7 @@ module API
       desc 'Get raw file metadata from repository'
       params do
         requires :file_path, type: String, file_path: true, desc: 'The url encoded path to the file. Ex. lib%2Fclass%2Erb'
-        requires :ref, type: String, desc: 'The name of branch, tag or commit', allow_blank: false
+        optional :ref, type: String, desc: 'The name of branch, tag or commit', allow_blank: false
       end
       head ":id/repository/files/:file_path/raw", requirements: FILE_ENDPOINT_REQUIREMENTS do
         assign_file_vars!
@@ -124,7 +124,7 @@ module API
       desc 'Get raw file contents from the repository'
       params do
         requires :file_path, type: String, file_path: true, desc: 'The url encoded path to the file. Ex. lib%2Fclass%2Erb'
-        requires :ref, type: String, desc: 'The name of branch, tag commit', allow_blank: false
+        optional :ref, type: String, desc: 'The name of branch, tag or commit', allow_blank: false
       end
       get ":id/repository/files/:file_path/raw", requirements: FILE_ENDPOINT_REQUIREMENTS do
         assign_file_vars!

spec/requests/api/files_spec.rb

@@ -517,6 +517,21 @@ RSpec.describe API::Files do
         expect(response).to have_gitlab_http_status(:ok)
       end
 
+      context 'when ref is not provided' do
+        before do
+          stub_application_setting(default_branch_name: 'main')
+        end
+
+        it 'returns response :ok', :aggregate_failures do
+          url = route(file_path) + "/raw"
+          expect(Gitlab::Workhorse).to receive(:send_git_blob)
+
+          get api(url, current_user), params: {}
+
+          expect(response).to have_gitlab_http_status(:ok)
+        end
+      end
+
       it 'returns raw file info for files with dots' do
         url = route('.gitignore') + "/raw"
         expect(Gitlab::Workhorse).to receive(:send_git_blob)