-
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
Valentin Kao
committed
Mar 22, 2024
1 parent
cd3513c
commit bb6c447
Showing
25 changed files
with
29,606 additions
and
202 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
docs/api/**/*.api.mdx | ||
.github |
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,39 @@ | ||
--- | ||
id: {{{id}}} | ||
title: "{{{title}}}" | ||
description: "{{{frontMatter.description}}}" | ||
{{^api}} | ||
sidebar_label: Introduction | ||
{{/api}} | ||
{{#api}} | ||
sidebar_label: "{{{title}}}" | ||
{{/api}} | ||
{{^api}} | ||
sidebar_position: 0 | ||
{{/api}} | ||
hide_title: true | ||
{{#api}} | ||
hide_table_of_contents: true | ||
{{/api}} | ||
{{#json}} | ||
api: {{{json}}} | ||
{{/json}} | ||
{{#api.method}} | ||
sidebar_class_name: "{{{api.method}}} api-method" | ||
{{/api.method}} | ||
{{#infoPath}} | ||
info_path: {{{infoPath}}} | ||
{{/infoPath}} | ||
custom_edit_url: null | ||
{{#frontMatter.proxy}} | ||
proxy: {{{frontMatter.proxy}}} | ||
{{/frontMatter.proxy}} | ||
{{#frontMatter.hide_send_button}} | ||
hide_send_button: true | ||
{{/frontMatter.hide_send_button}} | ||
{{#frontMatter.show_extensions}} | ||
show_extensions: true | ||
{{/frontMatter.show_extensions}} | ||
--- | ||
|
||
{{{markdown}}} |
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,30 @@ | ||
--- | ||
id: authentication | ||
title: "Authentication" | ||
description: "Authentication" | ||
sidebar_label: Authentication | ||
sidebar_position: 0 | ||
hide_title: true | ||
custom_edit_url: null | ||
--- | ||
|
||
import ApiLogo from "@theme/ApiLogo"; | ||
import SchemaTabs from "@theme/SchemaTabs"; | ||
import TabItem from "@theme/TabItem"; | ||
import Export from "@theme/ApiExplorer/Export"; | ||
|
||
<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 1.0.0</span> | ||
|
||
<Export url={"https://github.com/infodeck/docs.infodeck.io/blob/main/examples/api.json"} proxy={undefined}></Export> | ||
|
||
<h1 className={"openapi__heading"}>Infodeck.io</h1> | ||
|
||
|
||
|
||
Infodeck.io - API documentation | ||
|
||
<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"HTTP: Bearer Auth"} value={"user"}> | ||
|
||
Get your API token via POST /authentications/tokens | ||
|
||
<div><table><tbody><tr><th>Security Scheme Type:</th><td>http</td></tr><tr><th>HTTP Authorization Scheme:</th><td>bearer</td></tr><tr><th>Bearer format:</th><td>JWT</td></tr></tbody></table></div></TabItem></SchemaTabs></div> |
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,27 @@ | ||
--- | ||
id: introduction | ||
title: "Quickstart" | ||
description: "Quickstart" | ||
sidebar_label: Quickstart | ||
sidebar_position: 0 | ||
hide_title: true | ||
custom_edit_url: null | ||
--- | ||
|
||
## Introduction | ||
|
||
Welcome to the Infodeck.io Developer Documentation! | ||
This guide will help you get started with integrating our platform into your projects and accessing our APIs | ||
|
||
## Prerequisites | ||
|
||
Before you begin, make sure you have: | ||
|
||
- An Infodeck.io developer account. If you don't have one yet, you can sign up [here](https://app.infodeck.io). | ||
- Basic knowledge of web development and RESTful APIs. | ||
|
||
### API Integration | ||
|
||
If you prefer direct API integration, you can make HTTP requests to our endpoints. Refer to our [API documentation](/docs/rest/api) for detailed information on endpoints, parameters, and responses. | ||
|
||
Happy coding! |
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 @@ | ||
--- | ||
id: pagination | ||
title: "Pagination" | ||
description: "Pagination" | ||
sidebar_label: Pagination | ||
sidebar_position: 0 | ||
hide_title: true | ||
custom_edit_url: null | ||
--- | ||
|
||
|
||
## Pagination |
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,30 @@ | ||
--- | ||
id: infodeck-io | ||
title: "Infodeck.io" | ||
description: "Infodeck.io - API documentation" | ||
sidebar_label: Introduction | ||
sidebar_position: 0 | ||
hide_title: true | ||
custom_edit_url: null | ||
--- | ||
|
||
import ApiLogo from "@theme/ApiLogo"; | ||
import SchemaTabs from "@theme/SchemaTabs"; | ||
import TabItem from "@theme/TabItem"; | ||
import Export from "@theme/ApiExplorer/Export"; | ||
|
||
<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 1.0.0</span> | ||
|
||
<Export url={"https://github.com/infodeck/docs.infodeck.io/blob/main/examples/api.json"} proxy={undefined}></Export> | ||
|
||
<h1 className={"openapi__heading"}>Infodeck.io</h1> | ||
|
||
|
||
|
||
Infodeck.io - API documentation | ||
|
||
<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"HTTP: Bearer Auth"} value={"user"}> | ||
|
||
Get your API token via POST /authentications/tokens | ||
|
||
<div><table><tbody><tr><th>Security Scheme Type:</th><td>http</td></tr><tr><th>HTTP Authorization Scheme:</th><td>bearer</td></tr><tr><th>Bearer format:</th><td>JWT</td></tr></tbody></table></div></TabItem></SchemaTabs></div> |
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.