eXist-db / documentation

Documentation of eXist
13 stars 44 forks source link

[suggestion] add documentation for EXPath http-client module #861

Open line-o opened 1 year ago

line-o commented 1 year ago

Is your feature request related to a problem? Please describe.

The documentation and specification of the EXPath http-client module are both outdated. The documentation is sparse and could use some more examples. There are even cases where our implementation has diverged or simply is not usable as advertised.

Describe the solution you'd like

In order to provide our users with actionable information how to effectively send HTTP requests from within XQuery modules in exist I believe it is in our best interest to just create it ourselves.

Things to cover

Describe alternatives you've considered

We could attempt to improve on the documentation on the project page. There is some discussion around that in https://github.com/expath/expath-http-client-java/issues/9

I do still see the need of eXist-db specific documentation.

line-o commented 1 year ago

The only mention of the module I could find in our current docs is at the very end of the XQuery in eXist-db article under the headline Community Specifications and only provides a link the project home page. https://exist-db.org/exist/apps/doc/xquery.xml?field=all&id=D3.61.7#D3.61.7