Skip to content

feat: integrate LAPI swagger UI inline #980

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

Open
LaurenceJJones wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: integrate LAPI swagger UI inline #980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions crowdsec-docs/docs/local_api/api_reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: api_reference
title: API Reference
sidebar_position: 2
---

import SwaggerUI from "swagger-ui-react";
import "swagger-ui-react/swagger-ui.css";

<SwaggerUI url="https://raw.githubusercontent.com/crowdsecurity/crowdsec/master/pkg/models/localapi_swagger.yaml" />

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/local_api/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Local API (LAPI) is one of the core components of the Security Engine to :
- Allow Remediation Components to consume said alerts & decisions from database
- Allow `cscli` to manage the database (list, delete, etc)

You can find the swagger documentation [here](https://crowdsecurity.github.io/api_doc/lapi/).
You can find the API reference documentation [here](local_api/api_reference.mdx).

This allows you to create [multi-machines architectures](https://crowdsec.net/multi-server-setup/) around CrowdSec or leverage [orchestration technologies](https://crowdsec.net/secure-docker-compose-stacks-with-crowdsec/).

Expand Down
6 changes: 1 addition & 5 deletions crowdsec-docs/sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,11 +203,7 @@ const sidebarsConfig: SidebarConfig = {
"local_api/authentication",
"local_api/tls_auth",
"local_api/centralized_allowlists",
{
type: "link",
label: "Swagger",
href: "https://crowdsecurity.github.io/api_doc/lapi/",
},
"local_api/api_reference",
],
},
{
Expand Down