Skip to content

Commit 6e253b0

Browse files
authored
[CP-207] Fix comments for Cluster.DatabaseConfiguration (and sub-messages) (#146)
* [CP-207] Fix comments for `Cluster.DatabaseConfiguration` (and sub-messages) * Moved 'This is an optional field...' to the end
1 parent 4f2e91f commit 6e253b0

4 files changed

Lines changed: 81 additions & 51 deletions

File tree

gen/go/qdrant/cloud/cluster/v1/cluster.pb.go

Lines changed: 23 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/openapiv2/qdrant/cloud/cluster/v1/cluster.swagger.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@
608608
},
609609
"databaseConfiguration": {
610610
"$ref": "#/definitions/v1DatabaseConfiguration",
611-
"title": "Configuration to setup a qdrant database in a hybrid cloud.\nIt is ignored for managed cloud clusters. This is an optional field"
611+
"description": "Configuration to setup a qdrant database.\nThis is an optional field."
612612
},
613613
"nodeSelector": {
614614
"type": "array",
@@ -871,30 +871,30 @@
871871
"properties": {
872872
"collection": {
873873
"$ref": "#/definitions/v1DatabaseConfigurationCollection",
874-
"title": "The default Qdrant database collection configuration\nThis is an optional field"
874+
"description": "The default Qdrant database collection configuration.\nThis setting is for both managed and hybrid cloud clusters, see sub-messages for more details.\nThis is an optional field."
875875
},
876876
"storage": {
877877
"$ref": "#/definitions/v1DatabaseConfigurationStorage",
878-
"title": "The default Qdrant database storage configuration\nThis is an optional field"
878+
"description": "The default Qdrant database storage configuration.\nThis setting is for both managed and hybrid cloud clusters.\nThis is an optional field."
879879
},
880880
"service": {
881881
"$ref": "#/definitions/v1DatabaseConfigurationService",
882-
"title": "The Qdrant database service configuration\nThis is an optional field"
882+
"title": "The Qdrant database service configuration\nThis setting is for both managed and hybrid cloud clusters, see sub-messages for more details.\nThis is an optional field"
883883
},
884884
"logLevel": {
885885
"$ref": "#/definitions/v1DatabaseConfigurationLogLevel",
886-
"title": "The log level for the database\nThis is an optional field, default is Info.\nQdrant is written in Rust and is using: https://docs.rs/log/latest/log/enum.LevelFilter.html"
886+
"description": "The log level for the database.\nQdrant is written in Rust and is using: https://docs.rs/log/latest/log/enum.LevelFilter.html\nThis setting is for hybrid cloud clusters only, it is ignored for managed cloud clusters.\nThis is an optional field, default is Info."
887887
},
888888
"tls": {
889889
"$ref": "#/definitions/v1DatabaseConfigurationTls",
890-
"title": "The Qdrant database TLS configuration\nThis is an optional field, if not set an unsecure connection is provided"
890+
"description": "The Qdrant database TLS configuration.\nThis setting is for hybrid cloud clusters only, it is ignored for managed cloud clusters.\nThis is an optional field, if not set an unsecure connection is provided."
891891
},
892892
"inference": {
893893
"$ref": "#/definitions/v1DatabaseConfigurationInference",
894-
"title": "The Qdrant database inference configuration\nThis is an optional field, if unset, the database is not configured for cloud inferencing"
894+
"title": "The Qdrant database inference configuration.\nThis setting is for managed cloud clusters only, it is ignored for hybrid cloud clusters.\nThis is an optional field, if unset, the database is not configured for cloud inferencing"
895895
}
896896
},
897-
"description": "Configuration to setup a Qdrant database in a hybrid cloud.\nAll settings apply to hybrid cloud only."
897+
"description": "Configuration to setup a Qdrant database.\nThe settings apply to managed and/or hybrid cloud, see documentation on each message for more details."
898898
},
899899
"v1DatabaseConfigurationCollection": {
900900
"type": "object",
@@ -956,19 +956,19 @@
956956
"properties": {
957957
"apiKey": {
958958
"$ref": "#/definitions/v1SecretKeyRef",
959-
"title": "Set an api-key.\nIf set, all requests must include a header with the api-key.\nexample header: `api-key: \u003cAPI-KEY\u003e`"
959+
"title": "Set an api-key.\nThis setting is for hybrid cloud clusters only, for managed cloud please use qdrant.cloud.cluster.auth.[v1|v2].DatabaseApiKeyService to configure keys.\nIf set, all requests must include a header with the api-key.\nexample header: `api-key: \u003cAPI-KEY\u003e`"
960960
},
961961
"readOnlyApiKey": {
962962
"$ref": "#/definitions/v1SecretKeyRef",
963-
"title": "Set an api-key for read-only operations.\nIf set, all requests must include a header with the api-key.\nexample header: `api-key: \u003cAPI-KEY\u003e`"
963+
"title": "Set an api-key for read-only operations.\nThis setting is for hybrid cloud clusters only, for managed cloud please use qdrant.cloud.cluster.auth.[v1|v2].DatabaseApiKeyService to configure keys.\nIf set, all requests must include a header with the api-key.\nexample header: `api-key: \u003cAPI-KEY\u003e`"
964964
},
965965
"jwtRbac": {
966966
"type": "boolean",
967-
"description": "Enable JWT Role Based Access Control (RBAC).\nIf enabled, you can generate JWT tokens with fine-grained rules for access control.\nUse generated token instead of API key."
967+
"description": "Enable JWT Role Based Access Control (RBAC).\nThis setting is for both managed and hybrid cloud clusters.\nIf enabled, you can generate JWT tokens with fine-grained rules for access control.\nUse generated token instead of API key."
968968
},
969969
"enableTls": {
970970
"type": "boolean",
971-
"title": "Enable HTTPS for the REST and gRPC API"
971+
"description": "Enable HTTPS for the REST and gRPC API\nThis setting is for hybrid cloud clusters only, for managed cloud clusters the platform controls it (and clients need to use a secure connection)."
972972
}
973973
},
974974
"title": "The Qdrant database service configuration"

gen/typescript/qdrant/cloud/cluster/v1/cluster_pb.d.ts

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -577,8 +577,8 @@ export declare type ClusterConfiguration = Message<"qdrant.cloud.cluster.v1.Clus
577577
additionalResources?: AdditionalResources;
578578

579579
/**
580-
* Configuration to setup a qdrant database in a hybrid cloud.
581-
* It is ignored for managed cloud clusters. This is an optional field
580+
* Configuration to setup a qdrant database.
581+
* This is an optional field.
582582
*
583583
* @generated from field: optional qdrant.cloud.cluster.v1.DatabaseConfiguration database_configuration = 7;
584584
*/
@@ -667,55 +667,61 @@ export declare type ClusterConfiguration = Message<"qdrant.cloud.cluster.v1.Clus
667667
export declare const ClusterConfigurationSchema: GenMessage<ClusterConfiguration>;
668668

669669
/**
670-
* Configuration to setup a Qdrant database in a hybrid cloud.
671-
* All settings apply to hybrid cloud only.
670+
* Configuration to setup a Qdrant database.
671+
* The settings apply to managed and/or hybrid cloud, see documentation on each message for more details.
672672
*
673673
* @generated from message qdrant.cloud.cluster.v1.DatabaseConfiguration
674674
*/
675675
export declare type DatabaseConfiguration = Message<"qdrant.cloud.cluster.v1.DatabaseConfiguration"> & {
676676
/**
677-
* The default Qdrant database collection configuration
678-
* This is an optional field
677+
* The default Qdrant database collection configuration.
678+
* This setting is for both managed and hybrid cloud clusters, see sub-messages for more details.
679+
* This is an optional field.
679680
*
680681
* @generated from field: optional qdrant.cloud.cluster.v1.DatabaseConfigurationCollection collection = 1;
681682
*/
682683
collection?: DatabaseConfigurationCollection;
683684

684685
/**
685-
* The default Qdrant database storage configuration
686-
* This is an optional field
686+
* The default Qdrant database storage configuration.
687+
* This setting is for both managed and hybrid cloud clusters.
688+
* This is an optional field.
687689
*
688690
* @generated from field: optional qdrant.cloud.cluster.v1.DatabaseConfigurationStorage storage = 2;
689691
*/
690692
storage?: DatabaseConfigurationStorage;
691693

692694
/**
693695
* The Qdrant database service configuration
696+
* This setting is for both managed and hybrid cloud clusters, see sub-messages for more details.
694697
* This is an optional field
695698
*
696699
* @generated from field: optional qdrant.cloud.cluster.v1.DatabaseConfigurationService service = 3;
697700
*/
698701
service?: DatabaseConfigurationService;
699702

700703
/**
701-
* The log level for the database
702-
* This is an optional field, default is Info.
704+
* The log level for the database.
703705
* Qdrant is written in Rust and is using: https://docs.rs/log/latest/log/enum.LevelFilter.html
706+
* This setting is for hybrid cloud clusters only, it is ignored for managed cloud clusters.
707+
* This is an optional field, default is Info.
704708
*
705709
* @generated from field: optional qdrant.cloud.cluster.v1.DatabaseConfigurationLogLevel log_level = 4;
706710
*/
707711
logLevel?: DatabaseConfigurationLogLevel;
708712

709713
/**
710-
* The Qdrant database TLS configuration
711-
* This is an optional field, if not set an unsecure connection is provided
714+
* The Qdrant database TLS configuration.
715+
* This setting is for hybrid cloud clusters only, it is ignored for managed cloud clusters.
716+
* This is an optional field, if not set an unsecure connection is provided.
712717
*
713718
* @generated from field: optional qdrant.cloud.cluster.v1.DatabaseConfigurationTls tls = 5;
714719
*/
715720
tls?: DatabaseConfigurationTls;
716721

717722
/**
718-
* The Qdrant database inference configuration
723+
* The Qdrant database inference configuration.
724+
* This setting is for managed cloud clusters only, it is ignored for hybrid cloud clusters.
719725
* This is an optional field, if unset, the database is not configured for cloud inferencing
720726
*
721727
* @generated from field: optional qdrant.cloud.cluster.v1.DatabaseConfigurationInference inference = 6;
@@ -848,6 +854,7 @@ export declare const DatabaseConfigurationStoragePerformanceSchema: GenMessage<D
848854
export declare type DatabaseConfigurationService = Message<"qdrant.cloud.cluster.v1.DatabaseConfigurationService"> & {
849855
/**
850856
* Set an api-key.
857+
* This setting is for hybrid cloud clusters only, for managed cloud please use qdrant.cloud.cluster.auth.[v1|v2].DatabaseApiKeyService to configure keys.
851858
* If set, all requests must include a header with the api-key.
852859
* example header: `api-key: <API-KEY>`
853860
*
@@ -857,6 +864,7 @@ export declare type DatabaseConfigurationService = Message<"qdrant.cloud.cluster
857864

858865
/**
859866
* Set an api-key for read-only operations.
867+
* This setting is for hybrid cloud clusters only, for managed cloud please use qdrant.cloud.cluster.auth.[v1|v2].DatabaseApiKeyService to configure keys.
860868
* If set, all requests must include a header with the api-key.
861869
* example header: `api-key: <API-KEY>`
862870
*
@@ -866,6 +874,7 @@ export declare type DatabaseConfigurationService = Message<"qdrant.cloud.cluster
866874

867875
/**
868876
* Enable JWT Role Based Access Control (RBAC).
877+
* This setting is for both managed and hybrid cloud clusters.
869878
* If enabled, you can generate JWT tokens with fine-grained rules for access control.
870879
* Use generated token instead of API key.
871880
*
@@ -875,6 +884,7 @@ export declare type DatabaseConfigurationService = Message<"qdrant.cloud.cluster
875884

876885
/**
877886
* Enable HTTPS for the REST and gRPC API
887+
* This setting is for hybrid cloud clusters only, for managed cloud clusters the platform controls it (and clients need to use a secure connection).
878888
*
879889
* @generated from field: bool enable_tls = 4;
880890
*/

0 commit comments

Comments
 (0)