xqDoc - potential updates
Wednesday, 19 October 2022 · 3 messages · last reply 24 Oct 2022
OS
Hi,
You can also have a look at this:
https://github.com/acdh-oeaw/openapi4restxq
Quoted text · Loren Cahlander · 18 lines
Am 19.10.2022 um 16:17 schrieb Loren Cahlander: > Hello folks, > > I am looking at maybe doing some updates to the xqDoc spec and the > codebase. I have code that transforms the xqDoc resources with RestXQ > into an OpenAPI 3 API documentation. The things that I want to figure > out is: > > * Figure out how to specify the schema of the parameters and the return > * Document the various HTTP return codes and the response content > for each return code > > > I would like to get the input from everyone using xqDoc > > Thank you, > Loren >
Best regards
--
Mag. Ing. Omar Siam
Austrian Center for Digital Humanities and Cultural Heritage Österreichische Akademie der Wissenschaften | Austrian Academy of Sciences Stellvertretende Behindertenvertrauensperson | Deputy representative for disabled persons Bäckerstraße 13, 1010 Wien, Österreich | Vienna, Austria
T: +43 1 51581-7295
omar.siam at oeaw.ac.at |www.oeaw.ac.at/acdh
LC
Loren Cahlander19 Oct 2022 18:17 #
Hello folks,
I am looking at maybe doing some updates to the xqDoc spec and the codebase. I have code that transforms the xqDoc resources with RestXQ into an OpenAPI 3 API documentation. The things that I want to figure out is:
Figure out how to specify the schema of the parameters and the return Document the various HTTP return codes and the response content for each return code
I would like to get the input from everyone using xqDoc
Thank you,
Loren
AB
Hi Loren,
Quoted text · Omar Siam · 1 line
>I am looking at maybe doing some updates to the xqDoc spec and the
codebase.
I have some suggestions for additions to the xqDoc schema:
1. Add optional boolean attribute 'external' to xqDoc:function and xqDoc: variable. I see the main use for this as allowing documentation to show clearly which variables can be passed in when an XQuery main module is invoked.
2. Add additional optional children to the variable element. Namely: body, invoked and ref-variable.
These children are defined for functions. Declared variables can have complex code which references other elements. These changes allow the cross reference information to be complete.
3. Add optional attribute 'at' to import element. Maybe controversial🙂 but if it is in the source I think the doc should be able to capture it.
I think I could get a pull request for these schema changes together in a couple of weeks if you like?
/Andy
Written for BaseX 10.3. BaseX may have changed since: please check the current documentation.
⚡Generated with XQuery