gitLabApi.getRunnersApi().getAllRunners(scope) fails with "scope does not have a valid value"

[BorisDaich]

when talking to https://gitlab.com

sample code that fails

                RunnerStatus scope = RunnerStatus.SHARED;
GitLabApi gitLabApi = new GitLabApi("https://gitlab.com", U.GITLAB_COM_TOKEN)
		List<Runner> allRunners2 = gitLabApi.getRunnersApi().getAllRunners(scope);
		log.debug("Shared Runners:\n{}", allRunners2);

throws

org.gitlab4j.api.GitLabApiException: scope does not have a valid value
at org.gitlab4j.api.AbstractApi.validate(AbstractApi.java:593)
at org.gitlab4j.api.AbstractApi.get(AbstractApi.java:191)
at org.gitlab4j.api.Pager.(Pager.java:88)
at org.gitlab4j.api.RunnersApi.getAllRunners(RunnersApi.java:244)
at org.gitlab4j.api.RunnersApi.getAllRunners(RunnersApi.java:169)

in the pom.xml

org.gitlab4j
gitlab4j-api
4.11.4

---

possible reason
JerseyWebTarget { https://gitlab.com/api/v4/runners?scope=shared&per_page=96&page=1 }
but should be
https://gitlab.com/api/v4/runners/all?scope=shared&per_page=96&page=1

notice the /all in the path ...

will return

{
"message": "403 Forbidden"
}

which is the whole different story....

[gmessner]

@BorisDaich
You did locate the issue, I will get that corrected today and will actually be deprecating the methods that filter on scope as it's use is deprecated, see:
https://docs.gitlab.com/ee/api/runners.html#list-all-runners

As per the docs, I will be adding methods that take type and status to replace the deprecated methods. I will also create an integration test that tests these new methods in the RunnersApi

[BorisDaich]

Wow that was one fast response! I so much appreciate it!
your API is much more usable than the "official" one! IMHO.

so if we are at it... I am writing a comprehensive migration tool for gitlab from on premise installation to the gitlab.com
so as you do not have Java Wrapper for the import / export API I already wrote my own ugly code.
do you want me to try to make it to something that you can incorporate into the the lib?

[gmessner]

@BorisDaich
Just an FYI, I am assuming that you are referring to https://github.com/timols/java-gitlab-api as the "official" one. There actually is not an "official" one, the author of the java-gitlab-api is incorrectly using org.gitlab in his package names, and it is not part of gitlab.org, I have thought about mentioning this to one of my contacts at GitLab, as it does lead to some confusion.

Concerning the import/export question, if you could send me the URL to the API docs I will take a look and get back to you on it. I believe you are likely using:
https://docs.gitlab.com/ee/api/project_import_export.html

And possibly:
https://docs.gitlab.com/ee/api/import.html

[gmessner]

@BorisDaich
The getAllRunners() has been fixed and new methods added that take type and status as parameters, since the scope parameter is now deprecated. Release 4.11.5 should now be available in Maven Central.

Concerning the following error:

{
"message": "403 Forbidden"
}

You will receive that calling getAllRunners() if the account being used is not an admin account.

When you have time please verify and close this issue.

[gmessner]

@BorisDaich
Can I close this issue since the fix has been released?

[BorisDaich]

Thanks it works as expected.

[BorisDaich]

@gmessner

Concerning the import/export question, if you could send me the URL to the API docs I will take a look and get back to you on it. I believe you are likely using:
https://docs.gitlab.com/ee/api/project_import_export.html

yes that one

[gmessner]

@BorisDaich
I have completed most of the work on the import/export API, Should be doing a release this weekend with this functionality. I may not be including any integration testing because of the asynchronous nature of this.

[gmessner]

@BorisDaich
FYI, The ImportExportApi is available in release 4.11.7. Actually ended up including integration tests, made it a lot easier to test the implementation.

[BorisDaich]

I took a look on the code. and wow. it way cleaner than what I have did :-)
Thank you!

[creib]

Hi, I just got the same error when calling the eraseJob method.

Caught: org.gitlab4j.api.GitLabApiException: 403 Forbidden
org.gitlab4j.api.GitLabApiException: 403 Forbidden
at org.gitlab4j.api.AbstractApi.validate(AbstractApi.java:593)
at org.gitlab4j.api.AbstractApi.post(AbstractApi.java:264)
at org.gitlab4j.api.JobApi.eraseJob(JobApi.java:475)
at org.gitlab4j.api.JobApi$eraseJob.call(Unknown Source)