Catalog API Docs

[cmhedrickREI]

Pull Request

Related to GSA/data.gov#5523

About

• Documents our current API Endpoints in the new Catalog
  • /search
  • /harvest_record/<record_id>
  • /harvest_record/<record_id>/raw
  • /harvest_record/<record_id>/transformed
  • /api/keywords

URL: https://cg-f5a56614-c88e-470c-9f06-ff5fe2d4c98a.sites.pages.cloud.gov/preview/gsa/resources.data.gov/5523-document-api/catalog-api/

PR TASKS

• The actual code changes.
• Tests written and passed.
• Any changes to docs?
• Any new
  Gemfile
  or
  package.json
  updates to pull in?

[jbrown-xentity]

All the content changes look good, however it doesn't seem discoverable. I know we may have links on catalog directly to this page, but can we include it in the Guidance (or some other category) so it shows up in some types of search? Maybe with keywords as well? An example would be

resources.data.gov/pages/_summaries/privacy-act-call-detail-2.md

Line 15 in 24abc84

category: Guidance

[cmhedrickREI]

All the content changes look good, however it doesn't seem discoverable. I know we may have links on catalog directly to this page, but can we include it in the Guidance (or some other category) so it shows up in some types of search? Maybe with keywords as well? An example would be

resources.data.gov/pages/_summaries/privacy-act-call-detail-2.md

Line 15 in 24abc84

category: Guidance

That was a good idea @jbrown-xentity I made a summary for it so it should now appear in the Guidance section. I hope the tags are okay, they sounded applicable. Also CC @tdlowden for any input and weigh in to.

https://cg-f5a56614-c88e-470c-9f06-ff5fe2d4c98a.sites.pages.cloud.gov/preview/gsa/resources.data.gov/5523-document-api/categories/guidance/

[tdlowden]

thanks @cmhedrickREI. In this case "Guidance" is a term with a pretty narrow definition of things from OMB about how to implement memos or laws. So I think putting it under "data tools" might be the the best course of action. Then, we should think about a good place to link to it from the catalog itself. Maybe in the TBD new user guide? i will think on it. But for now can you move to that other section?

[cmhedrickREI]

thanks @cmhedrickREI. In this case "Guidance" is a term with a pretty narrow definition of things from OMB about how to implement memos or laws. So I think putting it under "data tools" might be the the best course of action. Then, we should think about a good place to link to it from the catalog itself. Maybe in the TBD new user guide? i will think on it. But for now can you move to that other section?

Sorry for the delay for the quick fix @tdlowden! But I edited the summary category so that way the link appears in the Data Tools section.