search

ossf / scorecard-webapp

Website and API for OpenSSF Scorecard
https://scorecard.dev
Apache License 2.0
22 stars 27 forks source link

Include docs for API in the website #209

Open naveensrinivasan opened 2 years ago

naveensrinivasan commented 2 years ago

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

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

naveensrinivasan commented 2 years ago

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

olivekl commented 2 years ago

@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!

azeemshaikh38 commented 2 years ago

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

naveensrinivasan commented 2 years ago

@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?