Skip to content

Commit

Permalink
refactor(docs): gather all API documentation into a single page with …
Browse files Browse the repository at this point in the history
…try-it editor and cURL generator
  • Loading branch information
jeromefellus-sekoia committed Sep 25, 2024
1 parent 30a324a commit 0cd6095
Show file tree
Hide file tree
Showing 14 changed files with 1,677 additions and 250 deletions.
6 changes: 0 additions & 6 deletions .github/workflows/deploy-public-website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,6 @@ jobs:
- name: Make destination directory for compiled CSS
run: mkdir -vp docs/stylesheets/

- name: Compile CSS from SCSS files
uses: gha-utilities/[email protected]
with:
source: src/sekoiaio.scss
destination: docs/stylesheets/sekoiaio.css

- name: Install Poetry
run: |
pip install poetry
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/preview.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,6 @@ jobs:
- name: Make destination directory for compiled CSS
run: mkdir -vp docs/stylesheets/

- name: Compile CSS from SCSS files
uses: gha-utilities/[email protected]
with:
source: src/sekoiaio.scss
destination: docs/stylesheets/sekoiaio.css

- name: Install Poetry
run: |
pip install poetry
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.idea
site
docs/stylesheets/sekoiaio.css
docs/stylesheets/openapi.css
venv
*~
redoc.egg-info
Expand Down
24 changes: 24 additions & 0 deletions docs/developer/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: overrides/openapi.html
---

# Sekoia.io API documentation

<div class="ui-spinner"></div>
<div id="openapi">
<section style="display:none;">
https://app.sekoia.io/api/v1/dashboard/swagger.json?context=public
https://app.sekoia.io/api/v1/telemetry/openapi.json?context=public
https://app.sekoia.io/api/v1/notebooks/openapi.json?context=public
https://app.sekoia.io/api/v1/sic/conf/swagger.json?context=public
https://app.sekoia.io/api/v1/swagger.json?context=public
https://app.sekoia.io/api/v1/ingest/swagger.json?context=public
https://app.sekoia.io/api/v1/sic/swagger.json?context=public
https://app.sekoia.io/api/v1/symphony/swagger.json?context=public
https://app.sekoia.io/api/v1/enricher/swagger.json?context=tip
https://app.sekoia.io/api/v1/swagger.json?context=public
https://app.sekoia.io/api/v2/asset-management/openapi.json?context=public
https://app.sekoia.io/api/v1/edl-gateway/openapi.json
https://app.sekoia.io/api/v2/inthreat/swagger.json?context=public
</section>
</div>
Loading

0 comments on commit 0cd6095

Please sign in to comment.