Add Swagger docs for Optimization Engine
[optf/osdf.git] / docs / sections / offeredapis.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. _offeredapis:
4
5 Offered APIs
6 =============================================
7
8 This document describes the OSDF HAS (Homing and Allocation Service) API
9
10
11 To view API documentation in the interactive swagger UI download the following and
12 paste into the swagger tool here: https://editor.swagger.io
13
14 .. csv-table::
15    :header: "API name", "Swagger JSON"
16    :widths: 10,5
17
18    "OOF OSDF HAS API", ":download:`link <./swaggerdoc/oof-osdf-has-api.json>`"
19    "OOF OPTENG API", ":download:`link <./swaggerdoc/oof-optf-opteng-api.json>`"
20
21 OOF OSDF HAS API
22 ................
23 .. swaggerv2doc:: ./swaggerdoc/oof-osdf-has-api.json
24
25
26 OOF OPTENG API
27 ..............
28 .. swaggerv2doc:: ./swaggerdoc/oof-optf-opteng-api.json
29
30