Skip to content
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.

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

docs: #377 update mdbook rest info #1121

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

miguelcsx
Copy link
Contributor

Description

This PR updates the mdbook documentation for REST-related information.

Changes:

  • Updated the REST documentation to reflect the latest information.
  • Specified the usage of the web module and its command-line options.
  • Included examples of HTTP requests and responses for better clarity.

Related Issue

Closes #377

Motivation and Context

The previous documentation lacked detailed explanations and examples for the REST API. These updates aim to improve understanding and usage by providing clear instructions and practical examples for the web module and HTTP interactions.

miguelcsx and others added 2 commits September 18, 2024 10:38
- updated rest documentation

- specified the usage of the web module and it's command line options

- displayed examples of http request and responses
@Angel-Dijoux
Copy link

This is really useful!! Thank

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document cli module
2 participants