Example in Embedding API documentation does not work

[tovrstra]

Details

• Read the Docs project URL: https://sphinx-tippy.readthedocs.io/en/latest/
• Build URL (if applicable): I'm trying to get this one to work: https://app.readthedocs.org/projects/sphinx-tippy/builds/29525245/ and Use appropriate User-Agent in HTTP header sphinx-extensions2/sphinx-tippy#30 (I'm not a maintainer of sphinx-tippy)
• Read the Docs username (if applicable): not relevant

The curl example on the following documentation page does not work: https://docs.readthedocs.com/platform/stable/api/v3.html#embed

I tried running locally the following command from the RTD documentation

curl https://app.readthedocs.org/api/v3/embed/?url=https://docs.readthedocs.io/en/latest/features.html%23read-the-docs-features

Expected Result

A JSON object with a content field as shown in the documentation.

Actual Result

I get the following:

{"error":"External domain not allowed. domain=docs.readthedocs.io"}

I tried a few variants but found not combination of domains that worked.

[stsewd]

Hi, we changed our docs to be single version, so no en part in the URL is allowed, the URL should be https://docs.readthedocs.io/latest/features.html, or https://docs.readthedocs.com/platform/stable/features.html. But looks like the error message is wrong, as the domain is valid, it's just the path that's wrong.

[tovrstra]

Thanks for the info. However, it is still not clear to me which curl command will work. I couln't come up with one that worked:

$ curl https://app.readthedocs.org/api/v3/embed/?url=https://docs.readthedocs.io/latest/features.html%23read-the-docs-features
{"error":"Can't find content for section: url=https://docs.readthedocs.io/latest/features.html#read-the-docs-features fragment=read-the-docs-features maincontent=None"} 
$ curl https://app.readthedocs.org/api/v3/embed/?url=https://docs.readthedocs.io/latest/features.html
{"error":"Can't find content for section: url=https://docs.readthedocs.io/latest/features.html fragment= maincontent=None"} 
$  curl https://app.readthedocs.org/api/v3/embed/?url=https://docs.readthedocs.ioplatform/latest/reference/features.htmll
{"error":"External domain not allowed. domain=docs.readthedocs.io"}

Can you give an example that works for you?

[stsewd]

This should work, looks like the page was moved to be inside a directory.

curl 'https://app.readthedocs.org/api/v3/embed/?url=https://docs.readthedocs.com/platform/stable/reference/features.html'