Skip to content

LCORE-578: info about OpenAPI documentation #514

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

Merged
merged 1 commit into from
Sep 8, 2025
Merged

LCORE-578: info about OpenAPI documentation #514

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: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ The service includes comprehensive user data collection capabilities for various

<!-- vim-markdown-toc GFM -->

* [lightspeed-stack](#lightspeed-stack)
* [About The Project](#about-the-project)
* [Architecture](#architecture)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
Expand All @@ -35,6 +33,7 @@ The service includes comprehensive user data collection capabilities for various
* [Llama Stack version check](#llama-stack-version-check)
* [User data collection](#user-data-collection)
* [System prompt](#system-prompt)
* [Control model/provider overrides via authorization](#control-modelprovider-overrides-via-authorization)
* [Safety Shields](#safety-shields)
* [Authentication](#authentication)
* [K8s based authentication](#k8s-based-authentication)
Expand Down Expand Up @@ -67,6 +66,7 @@ The service includes comprehensive user data collection capabilities for various
* [Utility to generate OpenAPI schema](#utility-to-generate-openapi-schema)
* [Path](#path)
* [Usage](#usage-1)
* [Makefile target to generate OpenAPI specification](#makefile-target-to-generate-openapi-specification)
* [Utility to generate documentation from source code](#utility-to-generate-documentation-from-source-code)
* [Path](#path-1)
* [Usage](#usage-2)
Expand Down Expand Up @@ -813,6 +813,13 @@ This script re-generated OpenAPI schema for the Lightspeed Service REST API.
make schema
```

## Makefile target to generate OpenAPI specification

Use `make openapi-doc` to generate OpenAPI specification in Markdown format.
Resulting documentation is available at [here](docs/openapi.md).



## Utility to generate documentation from source code

This script re-generate README.md files for all modules defined in the Lightspeed Stack Service.
Expand Down