MR build not showing up via the API

[chaen]

Details

• Read the Docs project URL: https://readthedocs.org/projects/mylhcbdirac/
• Build URL (if applicable): https://readthedocs.org/projects/mylhcbdirac/builds/17564876/
• Read the Docs username (if applicable): https://readthedocs.org/profiles/chaen/

I wanted to integrate the MR doc build with our private gitlab instance but read somewhere on the doc that this wasn't supported.
So my next idea was to pull the status of the build in order to have its status in our pipeline. However, I noticed that builds triggered for a MR are not listed when using the API, nor can we query their details.

I can see other builds and display their details, so I can exclude a token issue.

I could not find anything in the documentation that would explain that. Sorry if I missed it !

Expected Result

See the MR build (with an external ID) details like any other.

Actual Result

For example, for this specific build:

curl -H "Authorization: Token ${RTD_TOKEN}" https://readthedocs.org/api/v3/projects/mylhcbdirac/builds/17564876/
{"detail":"Not found."}

curl -H "Authorization: Token ${RTD_TOKEN}" "https://readthedocs.org/api/v3/projects/mylhcbdirac/builds/?commit=5c19238f6afd6af185d3f680391cf10efbe5a29d" 
{"count":0,"next":null,"previous":null,"results":[]}

I also noticed that the link of the External version is wrong (https://gitlab.com/None/None/merge_requests/8), but I suspect this is due to the fact that we use a private gitlab instance.

Many thanks !

[stsewd]

So, yeah, looks like we are excluding builds and versions that are external (from PR previews)

readthedocs.org/readthedocs/api/v3/views.py

Line 311 in 7e0fa4e

queryset = Build.internal.all()

readthedocs.org/readthedocs/api/v3/views.py

Line 285 in 7e0fa4e

queryset = Version.internal.all()

I think it makes sense for the API to return those, if we do so, not sure if this would be a breaking change, since some people may be expecting internal versions only (specially for the versions/ endpoint).

[humitos]

I think it makes sense for the API to return those, if we do so, not sure if this would be a breaking change, since some people may be expecting internal versions only (specially for the versions/ endpoint).

IMO, It makes sense to return only the non-external versions by default. I'd say that we should add an expansion argument (if we don't have one already) to include the external versions in the response as well. Something like ?expand=externals

[chaen]

I am happy with a flag :-)