Add documentation generation tools and enhance client models #257
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
 Warning |
SAST | 3 1 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
🛡️ The following SAST misconfigurations have been detected
| NAME | FILE | ||
|---|---|---|---|
|
Use of Vulnerable Python XML Libraries Susceptible to XXE | ...ate-docs-markdown.py | View in code |
|
Use of Vulnerable Python XML Libraries Susceptible to XXE | ...ate-docs-markdown.py | View in code |
|
Avoid using Python's native XML library to prevent XXE attacks | ...ate-docs-markdown.py | View in code |
|
Use of xml.etree package poses XML parsing vulnerabilities | ...ate-docs-markdown.py | View in code |
Note: The scan should have failed if no policies were configured in warn-only mode.
mpartipilo
force-pushed
the
recursing-hawking
branch
from
6cc41e8 to
b2220ac
Compare
Summary - Weaviate C# Client CoverageSummary
CoverageWeaviate.Client - 58.5%
Weaviate.Client.Analyzers - 0%
|
- Introduced DOCUMENTATION_TOOLS.md to compare various C# documentation generation tools, including DocFX, xmldocmd, and others. - Created api/index.md for Weaviate C# Client API documentation overview and key namespaces. - Configured docfx.json for DocFX documentation generation. - Added scripts for generating HTML and Markdown documentation, including generate-docs-html.sh, generate-docs-html.ps1, generate-docs-markdown.py, and their respective PowerShell and Bash scripts. - Implemented xmldocmd scripts for Markdown documentation generation, including generate-docs-xmldocmd.sh and generate-docs-xmldocmd.ps1. - Updated README files in scripts directory to provide usage instructions and prerequisites for documentation generation.
…atures - Added comprehensive XML documentation comments to the Move class, ObjectMetadata, Property, and various result models to improve clarity and usability. - Introduced new properties in ObjectMetadata for better metadata handling, including CreationTime, LastUpdateTime, Distance, Certainty, Score, ExplainScore, IsConsistent, and RerankScore. - Expanded the Property class with additional tokenization strategies and factory methods for various data types, enhancing property creation flexibility. - Implemented new GroupByResult and WeaviateGroup classes to support grouping in query results, along with generative AI capabilities in results. - Enhanced the WeaviateObject model with detailed properties for better data representation, including UUID, Collection, Metadata, Tenant, Properties, References, and Vectors. - Introduced HybridNearVector and HybridNearText records for hybrid search configurations, allowing for combined vector and text-based queries. - Updated ShardingConfig with detailed sharding strategies and functions, improving data distribution management. - Enhanced VectorConfig and VectorIndex classes with detailed documentation and new configurations for vector indexing and multi-vector search behavior.
mpartipilo
force-pushed
the
recursing-hawking
branch
from
b2220ac to
676f56c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce comprehensive documentation generation tools and scripts, including support for Markdown and XML documentation. Enhance Weaviate Client models with detailed XML comments and new properties for improved usability and functionality. Update configuration for better documentation management and sharding strategies.