For those with current local builds of WebAPI @cahilton recently included the MireDot library that generates documentation of the services. I’m interested in hearing feedback to determine if people are happy with the content it provides. I’ll add a brief discussion to the next architecture call so we can make a go/no go call on its inclusion going forward.
Works for me. Handles my subclasses of Criteria excellently.
@lee_evans, would it be possible to host the MireDot output somewhere under our public website? On my local build, the output website is found under target/miredot. The index.html is the root page of the site and everything in that folder is the content.
-Chris
Here is a link to the MireDot output generated on the CI server:
http://webapidoc.ohdsi.org:8080/job/WebAPI/ws/target/miredot/index.html
I’ll also post the link in the OHDSI wiki.
Lee
Will this automatically update with builds from the CI server?
Yes it will.
Tried going to the link:
http://webapidoc.ohdsi.org:8080/job/WebAPI/ws/target/miredot/index.html
But it appears that not all the required files are available and so it just hangs when trying to load. For example it can’t find:
http://webapidoc.ohdsi.org:8080/job/WebAPI/ws/target/miredot/input/input.js
http://webapidoc.ohdsi.org:8080/job/WebAPI/ws/target/miredot/css/bootstrap-combined.min.css
http://webapidoc.ohdsi.org:8080/job/WebAPI/ws/target/miredot/css/normalize.css
The list goes on…
Hi @Frank
I’m not sure what the issue might be. The link works OK for me and Chris.
Maybe you are using a different web browser? I’m using chrome web browser. Maybe you could try it again in chrome?
Works for me on Chrome with Mac.
Worked on Firefox and Safari too.
It wasn’t a browser issue as I was getting 404 errors from the server. Tried again today and its fine, not sure why the server wasn’t serving the files.
Looks like the MireDot key is expired. Are we thinking of keeping that up to date or using something else to document APIs?
@Frank got the new key and updated the WebAPI master branch. I’ve just updated the key in the released branch so the API documentation is available again here:
http://webapidoc.ohdsi.org/job/WebAPI/WebAPI_Miredot_Documentation/index.html