http-apis / documentation-hydrus Goto Github PK

Provide a hook to parse and publish the content in https://github.com/HTTP-APIs/hydra-ecosystem-wiki alongside with hydrus API in readthedocs.

Sphinx documentation has to be rebuild and republished

README.md should provide information about how the repo has been developed and which design choices have been made.

The JSON schema draft seems to be takjng momentum.

I think this is pretty relevant to what we are doing: http://json-schema.org
There is also a wide array of tools like: https://github.com/aromanovich/jsl
Python DSL for describing JSON schemas http://jsl.readthedocs.org/
For hyperschemas https://github.com/core-api/python-jsonhyperschema-codec

Investigate possible synergies.

I am trying to build the documentation. This is the error that I am getting.

I have installed hydrus by cd into hydrus folder and then pip install -e .

URSA is a very interesting C# library that implements HYDRA:

• code
• documentation

Having somebody that can get into the repository and documentation and write a brief report about the interesting features we can use in hydrus would be really helpful.

Instead of having separate repos for each project, we should add all documentation in the doc/ path into the hydrus repo. This way we build documentation directly with hydrus.

We should also implement the same things for other repos that need documentation.

As hydrus define a precise workflow like:

1. the API designer write a SWAGGER/OpenAPI JSON document that describes his/her API (yet to be implemented, hopefully this year. Please consider submitting an application for this)
2. hydrus parser will parse this JSON into a HYDRA API documentation (example here)
3. hydrus deploys the Web server byt parsing the outcome at 2.
4. hydrus serves the API
5. HYDRA-aware generic clients can use the API

We need an extensive document that improve the current WIKI by adding a detailed description of this workflow, with references to RDF codebase and Hydra draft.

References:

• URSA