-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
36 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
controller/software/hardware_registration_and_configuration/api_reference.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<script setup> | ||
import SwaggerUIBundle from './api_reference.vue' | ||
</script> | ||
|
||
# API Reference | ||
The Swagger documentation below is rendered from the most recent version available on GitHub. You should verify the version shown matches the firmware version on your device. | ||
|
||
A Visual Token can be found on the [OLED screen](/controller/support/OLED_screens/#auth-token), which randomizes the code. Once authorized, the token is usually valid for 1 hour. | ||
|
||
> [!NOTE] | ||
> This page is best viewed in `light` mode. | ||
<SwaggerUIBundle /> |
16 changes: 16 additions & 0 deletions
16
controller/software/hardware_registration_and_configuration/api_reference.vue
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
<script setup lang="ts"> | ||
import { onMounted } from "vue"; | ||
import { SwaggerUIBundle } from "swagger-ui-dist"; | ||
import "swagger-ui-dist/swagger-ui.css"; | ||
onMounted(() => { | ||
SwaggerUIBundle({ | ||
dom_id: "#swaggerContainer", | ||
url: "https://raw.githubusercontent.com/BrentIO/FireFly-Controller/main/Hardware-Registration-and-Configuration/swagger.yaml" | ||
}); | ||
}); | ||
</script> | ||
|
||
<template> | ||
<div class="swagger" id="swaggerContainer" /> | ||
</template> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,5 +6,8 @@ | |
}, | ||
"devDependencies": { | ||
"vitepress": "^1.0.1" | ||
}, | ||
"dependencies": { | ||
"swagger-ui-dist": "^5.17.2" | ||
} | ||
} | ||
} |