Hide flow api from swagger

Thomasr · Thomasr · commit aa6a9f6d1c5d · 2024-09-12T05:33:39.000-04:00
Deactivate npm repository endpoint
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/misc/ApiFlowEndpoints.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/misc/ApiFlowEndpoints.java
@@ -1,8 +1,6 @@
 package org.lowcoder.api.misc;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
-import io.swagger.v3.oas.annotations.Operation;
-import jakarta.annotation.Nullable;
+import io.swagger.v3.oas.annotations.Hidden;
 import org.lowcoder.infra.constant.NewUrl;
 import org.lowcoder.infra.constant.Url;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -17,14 +15,7 @@
 @RequestMapping(value = {Url.FLOW_URL, NewUrl.FLOW_URL})
 public interface ApiFlowEndpoints
 {
-	String TAG_SERVER_SETTING_MANAGEMENT = "Flow APIs";
-	
-	@Operation(
-			tags = TAG_SERVER_SETTING_MANAGEMENT,
-		    operationId = "flow",
-		    summary = "Call flow api",
-		    description = "Call flow api."
-	)
+	@Hidden
     @PostMapping
 	Mono<String> flow(@RequestBody FlowRequest flowRequest);
 	public record FlowRequest(String path,
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/npm/PrivateNpmRegistryEndpoint.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/npm/PrivateNpmRegistryEndpoint.java
@@ -21,7 +21,7 @@ public interface PrivateNpmRegistryEndpoint {
             summary = "Get NPM registry Metadata",
             description = "Retrieve the metadata of private NPM registry package within Lowcoder."
     )
-    @GetMapping("/registry/{name}")
+//    @GetMapping("/registry/{name}")
     public Mono<ResponseEntity<Resource>> getNpmPackageMeta(@PathVariable String name);
 
     @Operation(
@@ -30,6 +30,6 @@ public interface PrivateNpmRegistryEndpoint {
             summary = "Get NPM registry asset",
             description = "Retrieve the asset of private NPM registry package within Lowcoder."
     )
-    @GetMapping("/package/{path}")
+//    @GetMapping("/package/{path}")
     public Mono<ResponseEntity<Resource>> getNpmPackageAsset(@PathVariable String path);
 }

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public interface PrivateNpmRegistryEndpoint {`
`21`	`21`	`summary = "Get NPM registry Metadata",`
`22`	`22`	`description = "Retrieve the metadata of private NPM registry package within Lowcoder."`
`23`	`23`	`)`
`24`		`- @GetMapping("/registry/{name}")`
	`24`	`+// @GetMapping("/registry/{name}")`
`25`	`25`	`public Mono<ResponseEntity<Resource>> getNpmPackageMeta(@PathVariable String name);`
`26`	`26`
`27`	`27`	`@Operation(`
`@@ -30,6 +30,6 @@ public interface PrivateNpmRegistryEndpoint {`
`30`	`30`	`summary = "Get NPM registry asset",`
`31`	`31`	`description = "Retrieve the asset of private NPM registry package within Lowcoder."`
`32`	`32`	`)`
`33`		`- @GetMapping("/package/{path}")`
	`33`	`+// @GetMapping("/package/{path}")`
`34`	`34`	`public Mono<ResponseEntity<Resource>> getNpmPackageAsset(@PathVariable String path);`
`35`	`35`	`}`