18F / data-inventory

18F's contributions to the GSA enterprise data inventory and public data listing
4 stars 3 forks source link

Midas/Open Opportunities #13

Open harrisj opened 9 years ago

harrisj commented 9 years ago

URL: https://openopps.digitalgov.gov/api Docs: https://pages.18f.gov/midas/developer/

harrisj commented 9 years ago

Current problems with this entry:

The docs are at a different location, but that isn't an issue. But the requirements for the APIs in data.json, state this about the accessURL

Since an API provides indirect access to a dataset and the primary URL that a user needs in order to access the API is the API documentation, all web APIs should be referenced using the primary API documentation URL as an accessURL with the format specified as “API”

I could set the AccessURL to point to the Midas API docs, but then there is no way to figure out where the API is actually located. This might seem pedantic, but data.gov is interested in beefing up their scanning for dead links and they will flag this API as broken unless this is resolved by either putting documentation at the https://openopps.digitalgov.gov/api URL or adding a local openopps doc page that references the proper root URL for the API and links to Midas docs

ultrasaurus commented 9 years ago

point of contact should be openopps@gsa.gov

gbinal commented 9 years ago

Thanks, @ultrasaurus. The Open Data Plan schema specifies the need for a human point of contact. Who would work for that?

ultrasaurus commented 9 years ago

That would be me; however, can we use the team email as the contact for me? then people will get a response even if I'm on vacation or something

ultrasaurus commented 9 years ago

Also, we're about to change the repo name this week so maybe we should update the record next week. I know github does a redirect, but I think it would be less confusing that way.