search

fossology / fossology

FOSSology is an open source license compliance software system and toolkit. As a toolkit you can run license, copyright and export control scans from the command line. As a system, a database and web ui are provided to give you a compliance workflow. License, copyright and export scanners are tools used in the workflow.
https://fossology.github.io/
GNU General Public License v2.0
802 stars 419 forks source link

FOSSology REST API Documentation is out of date and inaccurate #1680

Open jeremiah opened 4 years ago

jeremiah commented 4 years ago

Description

There are multiple, conflicting documents describing the FOSSology REST API;

  1. https://www.fossology.org/get-started/basic-rest-api-calls/
  2. https://github.com/fossology/fossology/wiki/FOSSology-REST-API
  3. https://github.com/fossology/fossology/wiki/REST-API

Neither work and the instructions are contradictory and incomplete.

How to reproduce

View the URIs and compare the instructions

Screenshots

I believe it's not necessary.

Versions

Version: [3.8.0], Branch: [master], Commit: [#b5a389] 2020/03/16 19:23 UTC built @ 2020/04/03 19:51 UTC

Logs

None available

FOSSology logs

Logs are empty on default install (this ought to be a separate bug.)

Apache logs

Also empty.

Job logs

Logs generated under Geeky Scan Details (Job history => click on agent's job id) (Is this still relevant?)

teekhandekar commented 2 years ago

@GMishx can I work on this ?

GMishx commented 2 years ago

Please go ahead @teekhandekar

teekhandekar commented 2 years ago

Thank you @GMishx

kwennB commented 1 year ago

Hi @GMishx, Is anyone still working on this issue? I'd like to take this.

jeremiah commented 1 year ago

@kwennB That would be awesome if you were to take this on. I personally haven't seen much movement here, but I've not been involved for a while. Please note that the API documentation is different in different locations as well - so starting with a 'single source of truth' for the API is a great start.