Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create temp REST API reference #766

Merged
merged 5 commits into from
Mar 15, 2024
Merged

Create temp REST API reference #766

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1b3eff4
:sparkles: Create static HTML for REST API reference
pavithraes Feb 13, 2024
12e5fde
:memo: Add a note about api reference
pavithraes Feb 13, 2024
ecabfb6
:wrench: Fix typos
pavithraes Feb 13, 2024
66c574c
Merge branch 'main' into rest-api-temp
pavithraes Feb 13, 2024
72deb65
Merge branch 'main' into rest-api-temp
pavithraes Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions docusaurus-docs/conda-store/references/api.md
View file
Open in desktop

This file was deleted.

16 changes: 16 additions & 0 deletions docusaurus-docs/conda-store/references/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
description: REST API reference
---

# REST API reference

conda-store-server includes a REST API created using FastAPI.
The API reference is available at [conda.store/rest-api.html](/rest-api.html),
and it is embedded below as an inline frame.

<iframe
title="conda-store-ui components"
src={`/rest-api.html`}
width="100%"
height="600"
></iframe>
1 change: 1 addition & 0 deletions docusaurus-docs/static/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

31 changes: 31 additions & 0 deletions docusaurus-docs/static/rest-api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!--
Generated using static/openapi.json - a copy of the autogenerated spec by FastAPI, ref: https://fastapi.tiangolo.com/features/#automatic-docs
Presented using Swagger UI, ref: https://swagger.io/tools/swagger-ui/
-->

<html>
<head>
<title>conda-store REST API</title>
<link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css">
<script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
</head>
<body>
<!-- Render the Swagger UI -->
<div id="swagger-ui"></div>

<!-- https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/ -->
<script>
const ui = SwaggerUIBundle({
url: `openapi.json`,
dom_id: '#swagger-ui',
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIBundle.SwaggerUIStandalonePreset
],
layout: "BaseLayout",
tryItOutEnabled: false,
supportedSubmitMethods: [],
});
</script>
</body>
</html>
Loading