Add tutorial for symbol and string collection using `/api/collect` endpoint

nexB / purldb

Tools to create and expose a database of purls (Package URLs). This project is sponsored by NLnet project https://nlnet.nl/project/vulnerabilitydatabase/ and nexB for https://www.aboutcode.org/ Chat is at https://gitter.im/aboutcode-org/discuss

https://purldb.readthedocs.io/

29 stars 21 forks source link

Add tutorial for symbol and string collection using `/api/collect` endpoint #411

Closed keshav-space closed 1 month ago

keshav-space commented 2 months ago

Refrence https://github.com/nexB/purldb/issues/330

keshav-space commented 2 months ago

but I think some of the results can be truncated so the doc page isnt so large with example data

@JonoYang I tried using ellipsis to truncate the JSON result, but that resulted in Sphinx throwing lexing error. Instead of truncating the results, I have changed the example to a smaller file, and we still have sufficient results to show from each tools.

pombredanne commented 2 months ago

@JonoYang we found a way using the standard HTML <details> tag to collapse/expand long text runs

keshav-space commented 2 months ago

@JonoYang

https://github.com/nexB/purldb/assets/44315208/d2dd7bd6-0bac-4ea3-a384-28f336923f81

JonoYang commented 1 month ago

@keshav-space The toggle-able file contents looks great, thanks!