complete REST API documentation

[mhow2]

It's about completing https://scava-docs.readthedocs.io/en/latest/users/REST-API-Documentation/

For example, we don't have the expected parameters name and value for each methods. The only way to find the info is to refer to the raw code, for example : https://github.com/crossminer/scava/blob/master/metric-platform/platform/org.eclipse.scava.platform.client.api/src/org/eclipse/scava/platform/client/api/AnalysisCreationTaskResource.java

[ambpro]

@mhow2, a first prototype of the Rest API developers guide is available here: https://github.com/crossminer/scava/wiki/REST-API-Documentation

[mhow2]

So we now have https://crossminer.github.io/scava-docs/developers-guide/api-reference-guide/metric-platform-api/ which is a big enhancement from the previous doc. Is it complete @ambpro ?

[ambpro]

I pushed an update to the scava-doc API. It covers the following fixes/enhancements:

• Fixing the /analysis/task/create request body args.
• Fixing the /analysis/task/update request body args.
• Adding the /projects/edit API documentation.
• And other minor fixes.

Feel free if you have any comments !

[mawentowski]

Hello, I am a technical writer looking to join an open source project to document RESTful APIs. I currently have 7 years experience as a technical writer that includes experience with "docs as code" workflows, Git, and static sites. I am venturing into the world of APIs and was wondering if you currently have any tasks you need assistance with?

[ambpro]

Hello @mawentowski,

Thank you very much for your initiative.
It's a big pleasure to have you on board, and we will help you as much as we can.
I will let you know asap in case we need help regarding the APIs docs.
Thank you again and have a wonderful day!

[davidediruscio]

Hello @mawentowski,

I'm back on this and on your offer :-) As you can see we are working hard on the project. Its documentation is available at https://scava-docs.readthedocs.io/en/latest/ and it is generated out of https://github.com/crossminer/scava-docs

It would be really great if a couple of fresh eyes could have a look at the docs and identify existing issues/inconsistencies/etc. (we already know there are a lot). Even listing pages/links that deserve our attention would be of a great help for us. Would you be willing to do that?

Thanks
Davide