Skip to content

Update catalog-api.md#1009

Open
SueValente wants to merge 6 commits into
mainfrom
SueValente-patch-1
Open

Update catalog-api.md#1009
SueValente wants to merge 6 commits into
mainfrom
SueValente-patch-1

Conversation

@SueValente
Copy link
Copy Markdown
Contributor

Pull Request

Related to harvester-api update effort

@jpyuda - This is an example of the catalog-api edits that we can make to represent the additional functionality provided by api.data.gov layering

@SueValente SueValente requested a review from jpyuda May 5, 2026 23:06
Comment thread pages/catalog-api.md Outdated
**Request:**
```
GET https://catalog.data.gov/api/organizations
GET https://api.gsa.gov/technology/datagov/v4/api/organizations
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple issues with the API calls:

  • The path is not v4/api, but just v4/ -- including the api gives an error
  • we need to show the API key
  • I'm fond of using curl for documentation like this so people can just cut and paste to their terminal but that's ultimately not necessary. But the command should be approximately curl -H 'X-Api-Key: DEMO_KEY' https://api.gsa.gov/technology/datagov/v4/organizations

Copy link
Copy Markdown

@jpyuda jpyuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think your assistant mangled some of the api calls here. I can go through one at a time late today / tomorrow and test everything/make updates if that works for you.

documentation had a few cases of `/v4/api/` when it should just be `/v4/`
Copy link
Copy Markdown

@jpyuda jpyuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, I fixed (I think) all the URLs so this should be good to go.

Copy link
Copy Markdown
Contributor Author

@SueValente SueValente left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unverified commit. Need to replace with verified commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants