chore: API documentation sync#606
Conversation
Greptile SummaryThis automated sync PR adds
Confidence Score: 4/5Safe to merge — the change is a single-line documentation update adding a new enum value. The change is minimal and documentation-only. The only gap worth noting is that POSTGRES is listed as a valid enum value but, unlike elastic and opensearch, there is no corresponding postgres connection settings row in the table, leaving users without guidance on how to configure it. pages/api-reference/kubernetes/management-api-reference.md — the VectorStore section around line 5317 lacks a postgres connection settings entry.
|
| Filename | Overview |
|---|---|
| pages/api-reference/kubernetes/management-api-reference.md | Adds POSTGRES as a valid enum value for VectorStore; no corresponding postgres connection settings field is documented unlike the elastic/opensearch counterparts. |
Reviews (1): Last reviewed commit: "sync docs" | Re-trigger Greptile
| | Field | Description | Default | Validation | | ||
| | --- | --- | --- | --- | | ||
| | `enabled` _boolean_ | Enabled controls whether the vector store is enabled or not.. | false | Optional: \{\} <br /> | | ||
| | `vectorStore` _[VectorStore](#vectorstore)_ | VectorStore is the type of the vector store to use. | | Enum: [ELASTIC OPENSEARCH] <br />Optional: \{\} <br /> | | ||
| | `vectorStore` _[VectorStore](#vectorstore)_ | VectorStore is the type of the vector store to use. | | Enum: [ELASTIC OPENSEARCH POSTGRES] <br />Optional: \{\} <br /> | | ||
| | `elastic` _[ElasticsearchConnectionSettings](#elasticsearchconnectionsettings)_ | Elastic configuration for the vector store. | | Optional: \{\} <br /> | | ||
| | `opensearch` _[OpensearchConnectionSettings](#opensearchconnectionsettings)_ | Opensearch configuration for the vector store. | | Optional: \{\} <br /> | |
There was a problem hiding this comment.
Missing postgres connection settings field
The POSTGRES enum value is added to VectorStore, but the table has no corresponding postgres configuration field — unlike elastic and opensearch, which each have a dedicated connection settings entry. If selecting POSTGRES requires any connection parameters, users will have no documentation on how to provide them. If PostgreSQL uses a built-in or shared secret, a note to that effect would prevent confusion.
4986e3a to
8b39355
Compare
8b39355 to
b45b1c9
Compare
Automated pull request to sync docs for: