fix(catalog): fix some typo (#426)

Because

there are some typo

This commit

fix the typo

---------

Co-authored-by: droplet-bot <[email protected]>

Author: Yougigun

artifact/artifact/v1alpha/artifact.proto

@@ -35,8 +35,8 @@ message ReadinessResponse {
 
 /*
 
-   This API is under development and, therefore, some of its entitites and
-   entpoints are not implemented yet. This section aims to give context about the
+   This API is under development and, therefore, some of its entities and
+   endpoints are not implemented yet. This section aims to give context about the
    current interface and how it fits in the Artifact vision.
 
    # Artifact
@@ -173,7 +173,7 @@ message Catalog {
   string create_time = 5;
   // The last update time of the catalog.
   string update_time = 6;
-  // The owner/namespaceof the catalog.
+  // The owner/namespace of the catalog.
   string owner_name = 7;
   // The catalog tags.
   repeated string tags = 8;
@@ -195,7 +195,7 @@ message Catalog {
 
 // CreateCatalogRequest represents a request to create a catalog.
 message CreateCatalogRequest {
-  // The catalog's owner(nammespace).
+  // The catalog's owner(namespaces).
   string namespace_id = 1;
   // The catalog name.
   string name = 2;
@@ -277,7 +277,7 @@ enum FileProcessStatus {
 
 // file type
 enum FileType {
-  // upsecifid
+  // unspecified
   FILE_TYPE_UNSPECIFIED = 0;
   // text
   FILE_TYPE_TEXT = 1;
@@ -303,7 +303,7 @@ enum FileType {
   FILE_TYPE_PPTX = 11;
 }
 
-// file mata data
+// file
 message File {
   // file uid
   string file_uid = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -317,11 +317,11 @@ message File {
   string process_outcome = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
   // retrievable(this is reserved for future use)
   bool retrievable = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-  // contect(this is reserved for future use)
+  // content(this is reserved for future use)
   string content = 7 [(google.api.field_behavior) = OPTIONAL];
-  // owner/namespaceuid
+  // owner/namespace uid
   string owner_uid = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-  // cretor uid from authn token
+  // creator uid from authn token
   string creator_uid = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
   // catalog uid
   string catalog_uid = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -388,7 +388,7 @@ message ListCatalogFilesFilter {
 
 // list files request
 message ListCatalogFilesRequest {
-  // The owner/namespaceuid id.
+  // The owner/namespace uid id.
   string namespace_id = 1;
   // The catalog id.
   string catalog_id = 2;

artifact/artifact/v1alpha/artifact_public_service.proto

@@ -127,7 +127,7 @@ service ArtifactPublicService {
   // Similarity chunks search
   rpc SimilarityChunksSearch(SimilarityChunksSearchRequest) returns (SimilarityChunksSearchResponse) {
     option (google.api.http) = {
-      post: "/v1alpha/namespaces/{namespace_id}/catalogs/{catalog_id}/chunks/retreive"
+      post: "/v1alpha/namespaces/{namespace_id}/catalogs/{catalog_id}/chunks/retrieve"
       body: "*"
     };
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {tags: "Catalog"};
@@ -148,7 +148,7 @@ service ArtifactPublicService {
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {tags: "Catalog"};
   }
 
-  // CreateConversaion
+  // CreateConversation
   rpc CreateConversation(CreateConversationRequest) returns (CreateConversationResponse) {
     option (google.api.http) = {
       post: "/v1alpha/namespaces/{namespace_id}/catalogs/{catalog_id}/conversations"

artifact/artifact/v1alpha/chunk.proto

@@ -63,7 +63,7 @@ message GetSourceFileRequest {
 
 // get source file response
 message GetSourceFileResponse {
-  // source file(either orignal file or converted file)
+  // source file(either original file or converted file)
   SourceFile source_file = 1;
 }
 
@@ -75,13 +75,13 @@ message UpdateChunkRequest {
   bool retrievable = 2;
 }
 
-// Updae chunk response
+// update chunk response
 message UpdateChunkResponse {
   // chunk
   Chunk chunk = 1;
 }
 
-// Similar chunnk search request
+// Similar chunk search request
 message SimilarityChunksSearchRequest {
   // owner/namespace id
   string namespace_id = 1;
@@ -93,7 +93,7 @@ message SimilarityChunksSearchRequest {
   uint32 top_k = 4;
 }
 
-// Similar chunnk search response
+// Similar chunk search response
 message SimilarityChunksSearchResponse {
   // chunks
   repeated SimilarityChunk similar_chunks = 1;

artifact/artifact/v1alpha/conversation.proto

@@ -10,13 +10,13 @@ import "google/api/field_behavior.proto";
 
 // Conversation represents a chat conversation
 message Conversation {
-    // conversation id/name
+    // unique identifier of the conversation created by the system
     string uid = 1;
     // namespace id  
     string namespace_id = 2;
     // catalog id  
     string catalog_id = 3;
-    // unique identifier of the conversation created by the system
+    // conversation id/name
     string id = 4;
     // creation time of the conversation
     google.protobuf.Timestamp create_time = 5;
@@ -57,7 +57,7 @@ message CreateConversationRequest {
     string namespace_id = 1 [(google.api.field_behavior) = REQUIRED];
     // catalog id  
     string catalog_id = 2;
-    // conversation id. only allow kabab case
+    // conversation id. only allow kebab case
     string conversation_id = 3 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -96,7 +96,7 @@ message UpdateConversationRequest {
     // conversation id
     string conversation_id = 3;
     // new conversation id
-    string new_conversaion_id = 4;
+    string new_conversation_id = 4;
 }
 
 // UpdateConversationResponse returns the updated conversation

openapiv2/artifact/service.swagger.yaml

@@ -60,7 +60,7 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: namespaceId
-          description: The catalog's owner(nammespace).
+          description: The catalog's owner(namespaces).
           in: path
           required: true
           type: string
@@ -151,7 +151,7 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: namespaceId
-          description: The owner/namespaceuid id.
+          description: The owner/namespace uid id.
           in: path
           required: true
           type: string
@@ -360,7 +360,7 @@ paths:
             $ref: '#/definitions/ArtifactPublicServiceUpdateChunkBody'
       tags:
         - Catalog
-  /v1alpha/namespaces/{namespaceId}/catalogs/{catalogId}/chunks/retreive:
+  /v1alpha/namespaces/{namespaceId}/catalogs/{catalogId}/chunks/retrieve:
     post:
       summary: Similarity chunks search
       operationId: ArtifactPublicService_SimilarityChunksSearch
@@ -508,7 +508,7 @@ paths:
       tags:
         - Catalog
     post:
-      summary: CreateConversaion
+      summary: CreateConversation
       operationId: ArtifactPublicService_CreateConversation
       responses:
         "200":
@@ -809,7 +809,7 @@ definitions:
     properties:
       conversationId:
         type: string
-        title: conversation id. only allow kabab case
+        title: conversation id. only allow kebab case
     title: CreateConversationRequest is used to create a new conversation
     required:
       - conversationId
@@ -848,7 +848,7 @@ definitions:
         type: integer
         format: int64
         title: top k
-    title: Similar chunnk search request
+    title: Similar chunk search request
   ArtifactPublicServiceUpdateCatalogBody:
     type: object
     properties:
@@ -871,7 +871,7 @@ definitions:
   ArtifactPublicServiceUpdateConversationBody:
     type: object
     properties:
-      newConversaionId:
+      newConversationId:
         type: string
         title: new conversation id
     title: UpdateConversationRequest is used to update a conversation
@@ -1022,7 +1022,7 @@ definitions:
         description: The last update time of the catalog.
       ownerName:
         type: string
-        description: The owner/namespaceof the catalog.
+        description: The owner/namespace of the catalog.
       tags:
         type: array
         items:
@@ -1066,7 +1066,7 @@ definitions:
     properties:
       uid:
         type: string
-        title: conversation id/name
+        title: unique identifier of the conversation created by the system
       namespaceId:
         type: string
         title: namespace id
@@ -1075,7 +1075,7 @@ definitions:
         title: catalog id
       id:
         type: string
-        title: unique identifier of the conversation created by the system
+        title: conversation id/name
       createTime:
         type: string
         format: date-time
@@ -1170,14 +1170,14 @@ definitions:
         readOnly: true
       content:
         type: string
-        title: contect(this is reserved for future use)
+        title: content(this is reserved for future use)
       ownerUid:
         type: string
-        title: owner/namespaceuid
+        title: owner/namespace uid
         readOnly: true
       creatorUid:
         type: string
-        title: cretor uid from authn token
+        title: creator uid from authn token
         readOnly: true
       catalogUid:
         type: string
@@ -1213,7 +1213,7 @@ definitions:
         format: int32
         title: total tokens
         readOnly: true
-    title: file mata data
+    title: file
     required:
       - name
       - type
@@ -1335,7 +1335,7 @@ definitions:
     type: object
     properties:
       sourceFile:
-        title: source file(either orignal file or converted file)
+        title: source file(either original file or converted file)
         allOf:
           - $ref: '#/definitions/v1alphaSourceFile'
     title: get source file response
@@ -1556,7 +1556,7 @@ definitions:
           type: object
           $ref: '#/definitions/v1alphaSimilarityChunk'
         title: chunks
-    title: Similar chunnk search response
+    title: Similar chunk search response
   v1alphaSourceFile:
     type: object
     properties:
@@ -1590,7 +1590,7 @@ definitions:
         title: chunk
         allOf:
           - $ref: '#/definitions/artifactv1alphaChunk'
-    title: Updae chunk response
+    title: update chunk response
   v1alphaUpdateConversationResponse:
     type: object
     properties: