scorecard-webapp icon indicating copy to clipboard operation
scorecard-webapp copied to clipboard
verified publisher icon ossf

Include docs for API in the website

Open naveensrinivasan opened this issue 3 years ago • 4 comments

The website doesn't have docs for the new API.

https://securityscorecards.dev/#run-the-checks

naveensrinivasan avatar Sep 18 '22 12:09 naveensrinivasan

@olivekl Assigned it to you. If you think this doesn't apply to you, please let me know; I can take it.

naveensrinivasan avatar Sep 18 '22 12:09 naveensrinivasan

@naveensrinivasan I'd like to help but won't have the cycles for a while. I'd be able to edit if you can get it started!

olivekl avatar Sep 19 '22 13:09 olivekl

@naveensrinivasan any specific docs you had in mind? Meaning what info do you think is currently missing ?

azeemshaikh38 avatar Sep 20 '22 18:09 azeemshaikh38

@naveensrinivasan any specific docs you had in mind? Meaning what info do you think is currently missing ?

The website doesn't have any reference to the API. We should add a reference to the API. Thoughts?

naveensrinivasan avatar Sep 20 '22 18:09 naveensrinivasan