feat: #171 Adding metadata and examples files, adjusting doc

Signed-off-by: Laurent Broudoux <[email protected]>

Author: lbroudoux

cmd/importDir.go

@@ -183,6 +183,7 @@ func NewImportDirCommand(globalClientOpts *connectors.ClientOptions) *cobra.Comm
 					fmt.Printf("✗ Failed: %s - %s\n", file, errorMsg)
 				}
 			} else {
+				fmt.Println("\nImport results:")
 				for _, file := range result.SuccessFiles {
 					fmt.Printf("✓ Imported: %s\n", file)
 				}
@@ -230,12 +231,18 @@ func ImportDirectory(client MicrocksClient, fs FileSystem, dirPath string, confi
 	for _, file := range files {
 		fileType := detectFileType(file)
 
-		_, err := client.UploadArtifact(file, fileType.IsPrimary)
+		msg, err := client.UploadArtifact(file, fileType.IsPrimary)
 		if err != nil {
 			result.FailedCount++
 			result.FailedFiles = append(result.FailedFiles, file)
 			result.Errors = append(result.Errors, fmt.Sprintf("error importing %s: %v", file, err))
 			continue
+		} else {
+			action := "discovered"
+			if !fileType.IsPrimary {
+				action = "completed"
+			}
+			fmt.Printf("Microcks has %s '%s'\n", action, msg)
 		}
 
 		result.SuccessCount++
@@ -308,7 +315,7 @@ func detectFileType(filePath string) FileType {
 	// Default to primary for most files
 	isPrimary := true
 
-	if strings.Contains(fileName, "postman") || strings.Contains(fileName, "collection") {
+	if strings.Contains(fileName, "postman") || strings.Contains(fileName, "collection") || strings.Contains(fileName, "metadata") || strings.Contains(fileName, "examples") {
 		isPrimary = false
 	}
 

documentation/cmd/import.md

@@ -24,7 +24,7 @@ microcks import ./api.yaml \
     --keycloakClientSecret <client-secret> 
 
 # Import specification to microcks running without authentication (ie. local uber instance typically)
-microcks import ./api.yaml --micrcoksURL <microcks-url>
+microcks import ./api.yaml --microcksURL <microcks-url>
 ```
 
 ### Options

documentation/cmd/importDir.md

@@ -4,7 +4,8 @@ The `import-dir` command in Microcks CLI is used to import multiple API specific
 
 📝 Description
 
-The `import-dir` command provides a convenient way to bulk import API specifications from a local directory. It automatically scans for supported file types and imports them into Microcks. This is particularly useful for CI/CD pipelines, bulk operations, and managing large collections of API specifications.
+The `import-dir` command provides a convenient way to bulk import API specifications from a local directory. It automatically scans for supported file types and imports them into Microcks.
+This is particularly useful for CI/CD pipelines, bulk operations, and managing large collections of API specifications.
 
 📌 Usage
 ```bash
@@ -42,6 +43,19 @@ microcks import-dir ./api-specs --pattern "*.yaml"
 microcks import-dir ./api-specs --recursive --pattern "openapi.*"
 ```
 
+- Import specification to microcks without first running `microcks login`
+```bash
+microcks import-dir ./api-spec \
+    --microcksURL <microcks-url> \ 
+    --keycloakClientId <client-id> \
+    --keycloakClientSecret <client-secret> 
+```
+
+- Import specification to microcks running without authentication (ie. local uber instance typically)
+```bash
+microcks import-dir ./api-spec --microcksURL <microcks-url>
+```
+
 📋 Supported File Types
 
 The command automatically detects and imports the following file types:
@@ -53,7 +67,7 @@ The command automatically detects and imports the following file types:
 
 The command automatically determines which files should be marked as primary artifacts:
 - Files containing "openapi" or "swagger" in the filename are marked as primary
-- Files containing "postman" or "collection" in the filename are marked as secondary
+- Files containing "postman", "collection", "metadata" or "examples" in the filename are marked as secondary
 - All other files default to primary
 
 📊 Output