mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-03 09:53:45 +00:00
5fe6098350
# What does this PR do? This PR improves type hint cleanup in auto-generated provider documentation by adding regex logic. **Issues Fixed:** - Type hints with missing closing brackets (e.g., `list[str` instead of `list[str]`) - Types showing as `<class 'bool'>`, `<class 'str'>` instead of `bool`, `str` - The multi-line YAML frontmatter in index documentation files wasn't ideal, so we now add the proper `|` character. **Changes:** 1. Replaced string replacement (`.replace`) with regex-based type cleaning to preserve the trailing bracket in case of `list` and `dict`. 2. Adds the `|` character for multi-line YAML descriptions. 3. I have regenerated the docs. However, let me know if that's not needed. ## Test Plan 1. Ran uv run python scripts/provider_codegen.py - successfully regenerated all docs 2. We can see that the updated docs handle correctly type hint cleanup and multi-line yaml descriptions have now the `|` character. ### Note to the reviewer(s) This is my first contribution to your lovely repo! Initially I was going thourgh docs (wanted to use `remote::gemini` as provider) and realized the issue. I've read the [CONTRIBUTING.md](https://github.com/llamastack/llama-stack/blob/main/CONTRIBUTING.md) and decided to open the PR. Let me know if there's anything I did wrong and I'll update my PR! --------- Signed-off-by: thepetk <thepetk@gmail.com> Co-authored-by: Ashwin Bharambe <ashwin.bharambe@gmail.com>
37 lines
1.4 KiB
Text
37 lines
1.4 KiB
Text
---
|
|
description: "AWS S3-based file storage provider for scalable cloud file management with metadata persistence."
|
|
sidebar_label: Remote - S3
|
|
title: remote::s3
|
|
---
|
|
|
|
# remote::s3
|
|
|
|
## Description
|
|
|
|
AWS S3-based file storage provider for scalable cloud file management with metadata persistence.
|
|
|
|
## Configuration
|
|
|
|
| Field | Type | Required | Default | Description |
|
|
|-------|------|----------|---------|-------------|
|
|
| `bucket_name` | `str` | No | | S3 bucket name to store files |
|
|
| `region` | `str` | No | us-east-1 | AWS region where the bucket is located |
|
|
| `aws_access_key_id` | `str \| None` | No | | AWS access key ID (optional if using IAM roles) |
|
|
| `aws_secret_access_key` | `str \| None` | No | | AWS secret access key (optional if using IAM roles) |
|
|
| `endpoint_url` | `str \| None` | No | | Custom S3 endpoint URL (for MinIO, LocalStack, etc.) |
|
|
| `auto_create_bucket` | `bool` | No | False | Automatically create the S3 bucket if it doesn't exist |
|
|
| `metadata_store` | `SqlStoreReference` | No | | SQL store configuration for file metadata |
|
|
|
|
## Sample Configuration
|
|
|
|
```yaml
|
|
bucket_name: ${env.S3_BUCKET_NAME}
|
|
region: ${env.AWS_REGION:=us-east-1}
|
|
aws_access_key_id: ${env.AWS_ACCESS_KEY_ID:=}
|
|
aws_secret_access_key: ${env.AWS_SECRET_ACCESS_KEY:=}
|
|
endpoint_url: ${env.S3_ENDPOINT_URL:=}
|
|
auto_create_bucket: ${env.S3_AUTO_CREATE_BUCKET:=false}
|
|
metadata_store:
|
|
table_name: s3_files_metadata
|
|
backend: sql_default
|
|
```
|