Skip to content

Latest commit

 

History

History

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Generating Wazuh API Reference documentation

Environment

It is necessary to set up a Docker environment for generating the API documentation. There are Docker environments in this repository. Please, follow the next steps for setting up a Docker environment:

$ cd {WAZUH_API_PATH}/test/environment/docker/centos
$ docker-compose up -d
$ docker exec -it centos_wazuh-master_1 bash

Generate documentation:

Inside the container, execute the following commands and the .rst file will be generated:

# cd /wazuh-api/doc
# ./generate_api_doc.sh
# cd /wazuh-documentation
# make html

Review /wazuh-documentation/source/user-manual/api/reference.rst, specially Example Response section.