Skip to content

Commit

Permalink
general/api: Add link to OCDS guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Feb 21, 2024
1 parent 0b6c139 commit 0462c09
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/general/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ Follow best practices for authoring APIs. Some tips:

- Use hyphens as separators in paths.
- Use status codes. Do not return JSON responses like ``{"status": "ok", "data": {...}}``. See `Choosing an HTTP Status Code — Stop Making It Hard <https://www.codetinkerer.com/2015/12/04/choosing-an-http-status-code.html>`__.

.. seealso::

OCDS documentation `API access <https://standard.open-contracting.org/latest/en/guidance/build/hosting/#api-access>`__ guidance

0 comments on commit 0462c09

Please sign in to comment.