wazuh/wazuh-indexer-plugins
1
0
Fork 0
mirror of https://github.com/wazuh/wazuh-indexer-plugins.git synced 2025-12-10 14:32:28 -06:00
Code Issues Packages Projects Releases Wiki Activity
wazuh-indexer-plugins/docs
History
Jorge Sánchez 0ee82a3cca
Indexer's Content Manager Rest API implementation (#662) 
* First version of Indexer content manager API

* Include TODOs and make responses clearer

* Add Changelog entry and improve error logic

* Refactor clases and add models

* Add tests and small improvements

* Add basicAuth to OpenAPI file

* Add documentation

* Apply changes from code review

* Change models from singleton to normal clases

* Change models to use Jackson, Change Credentials class for Token class

* Add documentation about the new roles

* Apply changes from code review

* Refactoring

* Refactoring

* Update documentation to the latests refactors

* Refactor PlanService to use the Token model

* Refactor AuthService to use the Token model

* Refactor AuthService to use the Subscription model

* Reorganize code

* Refactor RestPostSubscriptionAction

* Small fixes on RestPostSubscription

* Refactor RestGetSubscription

* Remove unnused imports

* Refactor RestDeleteSubscription

* Start the refactor of RestPostUpdate

* Refactor RestPostUpdate

* Add Tests

* Add javadocs and improve documentation

* Apply changes from code review

* Add Content Manager docs

* Update documentation

* Fix Documentation

---------

Signed-off-by: Jorge Sánchez <jorge.sanchez@wazuh.com>
Co-authored-by: Alex Ruiz <alejandro.ruiz.becerra@wazuh.com>
2025-11-26 15:00:15 +01:00
..
dev
Indexer's Content Manager Rest API implementation (#662)
2025-11-26 15:00:15 +01:00
img
Correct review sugestions, add img folder
2025-07-22 12:39:49 +02:00
ref
Indexer's Content Manager Rest API implementation (#662)
2025-11-26 15:00:15 +01:00
.gitignore
Initialize technical documentation system (#273)
2025-02-12 19:02:21 +01:00
book.toml
Fix mdbook to version 0.4.x (#627)
2025-10-31 09:31:01 +01:00
build.sh
Add technical documentation (#320)
2025-03-13 15:18:22 +01:00
mermaid-init.js
Add technical documentation (#320)
2025-03-13 15:18:22 +01:00
mermaid.min.js
Implement content update using Json Patch operations (#362)
2025-04-22 18:53:13 +02:00
README.md
Add install instructions for cargo, mdbook and mdbook-mermaid (#332)
2025-03-19 17:07:39 +01:00
server.sh
Add technical documentation (#320)
2025-03-13 15:18:22 +01:00
SUMMARY.md
Indexer's Content Manager Rest API implementation (#662)
2025-11-26 15:00:15 +01:00

README.md

Wazuh Indexer Technical Documentation

This folder contains the technical documentation for the Wazuh Indexer. The documentation is organized into the following guides:

  • Development Guide: Instructions for building, testing, and packaging the Indexer.
  • Reference Manual: Detailed information on the Indexer’s architecture, configuration, and usage.

Requirements

To work with this documentation, you need mdBook installed.

  • Get the latest cargo (hit enter when prompted for a default install)

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  • Install mdbook and mdbook-mermaid

    cargo install mdbook
cargo install mdbook-mermaid

Usage

  • To build the documentation, run:

    ./build.sh

    The output will be generated in the book directory.

  • To serve the documentation locally for preview, run:

    ./server.sh

    The documentation will be available at http://127.0.0.1:3000.