Skip to content

Commit

Permalink
link through from API to schema sections
Browse files Browse the repository at this point in the history
  • Loading branch information
Charlie-Farrar committed Jul 31, 2023
1 parent 92fcceb commit bd79ba7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/sections/API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,18 @@ found `here <http://api.oasislmfdev.org/swagger/>`_. An evaluation version of th
using the `Oasis evaluation repository <https://github.com/OasisLMF/OasisEvaluation>`_. This includes a Jupyter notebook
that illustrates the basic operation of the API, using the Python API client.

The API schemas can be found here:

:doc:`../sections/platform_1`

:doc:`../sections/platform_2`

This is useful for more technical users who are looking to create their own UI or integrate Oasis with an existing
system. The v1 schema hierarchy is shown in json format in right column of the page. An interactive version of the
schema, with descriptions and examples, can be found below:



|
.. _oasis_api:
Expand Down

0 comments on commit bd79ba7

Please sign in to comment.