search

grnhse / greenhouse-api-docs

Documentation for Greenhouse Software's APIs
https://developers.greenhouse.io
Apache License 2.0
109 stars 74 forks source link

Harvest API "Custom Fields" docs missing "Headers" section for some "Custom Fields Options" endpoints #536

Open jehrenzweig-pi opened 9 months ago

jehrenzweig-pi commented 9 months ago

Documentation for endpoints in the "Custom Fields" page's "The custom field options object" section contain example requests that describe the need for an HTTP On-Behalf-Of header, when submitting an HTTP request. For example:

curl 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

Several endpoints already include a "Headers" section, which provides a description of the On-Behalf-Of header like so: image

However, other endpoints in that same section do NOT contain a "Headers" section: image

The list of endpoints in the "The custom field options object" section that are missing a "Headers" section:

FWIW I didn't do an exhaustive audit of the other sections on the "Custom Fields" page. However, the first few that I spot checked -- "Activity Feed", "Applications", "Approvals", "Candidates" -- looked fine.