Skip to content

Commit

Permalink
docs: remove duplicated /select endpoint from api spec (#3614)
Browse files Browse the repository at this point in the history
  • Loading branch information
ndr-brt authored Nov 16, 2023
1 parent 1a92799 commit 209f33d
Showing 1 changed file with 3 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@
import jakarta.json.JsonObject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import org.eclipse.edc.api.model.ApiCoreSchema;
import org.eclipse.edc.connector.dataplane.selector.api.v2.schemas.DataPlaneInstanceSchema;
import org.eclipse.edc.connector.dataplane.selector.api.v2.schemas.SelectionRequestSchema;

@OpenAPIDefinition
@Tag(name = "Dataplane Selector")
public interface DataplaneSelectorApi {

@Operation(method = "POST",
description = "Finds the best fitting data plane instance for a particular query",
requestBody = @RequestBody(content = @Content(schema = @Schema(implementation = SelectionRequestSchema.class))),
Expand All @@ -45,12 +45,10 @@ public interface DataplaneSelectorApi {
content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiCoreSchema.ApiErrorDetailSchema.class))))
})
@POST
@Path("select")
JsonObject find(JsonObject request);


@Operation(method = "POST",
description = "Adds one datatplane instance to the internal database of the selector",
description = "Adds one dataplane instance to the internal database of the selector",
requestBody = @RequestBody(content = @Content(schema = @Schema(implementation = DataPlaneInstanceSchema.class))),
responses = {
@ApiResponse(responseCode = "200", description = "Entry was added successfully to the database", content = @Content(schema = @Schema(implementation = ApiCoreSchema.IdResponseSchema.class))),
Expand All @@ -64,12 +62,10 @@ public interface DataplaneSelectorApi {
description = "Returns a list of all currently registered data plane instances",
responses = {
@ApiResponse(responseCode = "200", description = "A (potentially empty) list of currently registered data plane instances",
content = @Content(array = @ArraySchema(schema = @Schema(implementation = DataPlaneInstanceSchema.class)))),
@ApiResponse(responseCode = "400", description = "Request body was malformed", content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiCoreSchema.ApiErrorDetailSchema.class))))
content = @Content(array = @ArraySchema(schema = @Schema(implementation = DataPlaneInstanceSchema.class))))
}
)
@GET
JsonArray getAll();


}

0 comments on commit 209f33d

Please sign in to comment.