Trying to get API documentation as HTML

[HyperCriSiS]

Hi,

I just saw the API documentation can be fetched as HTML which would be nice to make it available for AI.
I tried to get it with CURL.

Versions

Core [v6.0.4]
FTL [v6.0.2]
Web interface [v6.0.1]

Windows 11

Expected behavior

API doc should be downloaded as HTML.

Actual behavior / bug

CURL is executed. Absolutely nothing happens.

Steps to reproduce

curl -insecure -X GET "https://192.168.0.100:443/api/docs" \ -H 'accept: text/html'

[DL6ER]

It is downloadable, your curl call just won't work. Please use some other tool that can crawl the page. For instance, saving with a browser would be much easier.

If you want to use the CLI, I'd recommend using wget instead, e.g.

wget -r -np -k http://192.168.0.100:443/api/docs

I suggest you consult wget -h if you want to know what the individual flags I proposed do.

[HyperCriSiS]

That's strange, because I got this from the documentation 😅

[DL6ER]

It is an automatically generated example that - unfortunately - doesn't work like this because of external dependencies the HTML page has. Seems we need to remove it if it is confusing

[DL6ER]

@yubiuser @rdwebdesign @PromoFaux What is your suggestion on this? I don't think we can disable the automatically generated curl example in this case. Do we want to remove the endpoint or shall we rather amend the description to something like "the automatically generated curl example does not create a self-contained full clone of the documentation" (nicer written)?

[rdwebdesign]

or shall we rather amend the description to something like "the automatically generated curl example does not create a self-contained full clone of the documentation" (nicer written)?

This.