Revision 46876
Added by Claudio Atzori about 7 years ago
DatasourcesApi.java | ||
---|---|---|
1 | 1 |
package eu.dnetlib.datasource.publisher; |
2 | 2 |
|
3 |
import eu.dnetlib.datasource.publisher.model.*;
|
|
3 |
import java.util.List;
|
|
4 | 4 |
|
5 |
import eu.dnetlib.datasource.publisher.model.DatasourceResponse; |
|
6 |
import eu.dnetlib.datasource.publisher.model.Response; |
|
7 |
import eu.dnetlib.datasource.publisher.model.db.SearchInterfacesEntry; |
|
5 | 8 |
import io.swagger.annotations.*; |
6 |
import io.swagger.annotations.Api; |
|
7 |
import io.swagger.annotations.ApiResponse; |
|
8 |
import org.springframework.http.ResponseEntity; |
|
9 | 9 |
import org.springframework.web.bind.annotation.PathVariable; |
10 |
import org.springframework.web.bind.annotation.RequestMapping; |
|
11 |
import org.springframework.web.bind.annotation.RequestMethod; |
|
10 |
import org.springframework.web.bind.annotation.RequestParam; |
|
12 | 11 |
|
13 | 12 |
@Api(value = "datasources", description = "the datasource manager API") |
14 | 13 |
public interface DatasourcesApi { |
15 | 14 |
|
16 |
@ApiOperation(value = "list identifiers", notes = "List the Datasource identifiers.", response = IdentifiersResponse.class, tags = { })
|
|
15 |
@ApiOperation(value = "list identifiers", notes = "List the Datasource identifiers.", response = List.class, tags = { })
|
|
17 | 16 |
@ApiResponses(value = { |
18 |
@ApiResponse(code = 200, message = "OK", response = IdentifiersResponse.class),
|
|
17 |
@ApiResponse(code = 200, message = "OK", response = List.class),
|
|
19 | 18 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
20 |
@RequestMapping(value = "/ds/list", |
|
21 |
produces = { "application/json" }, |
|
22 |
method = RequestMethod.GET) |
|
23 |
ResponseEntity<IdentifiersResponse> listIds(); |
|
19 |
List<String> listIds(int page, int size) throws ApiException; |
|
24 | 20 |
|
25 |
|
|
26 |
@ApiOperation(value = "get datasource", notes = "Returns Datasource details.", response = DatasourceResponse.class, tags = { }) |
|
21 |
@ApiOperation(value = "get datasource by id", notes = "Returns Datasource details.", response = DatasourceResponse.class, tags = { }) |
|
27 | 22 |
@ApiResponses(value = { |
28 | 23 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse.class), |
29 | 24 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
30 |
@RequestMapping(value = "/ds/get/{id}", |
|
31 |
produces = { "application/json" }, |
|
32 |
method = RequestMethod.GET) |
|
33 |
ResponseEntity<DatasourceResponse> getDs(@ApiParam(value = "ID of datasource to fetch", required = true) @PathVariable("id") String id); |
|
25 |
DatasourceResponse getDs(String id); |
|
34 | 26 |
|
27 |
@ApiOperation(value = "search among datasource APIs", notes = "Returns Datasource Api details.", response = SearchInterfacesEntry.class, tags = { }) |
|
28 |
@ApiResponses(value = { |
|
29 |
@ApiResponse(code = 200, message = "OK", response = SearchInterfacesEntry.class), |
|
30 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
|
31 |
List<SearchInterfacesEntry> searchInterface( |
|
32 |
@ApiParam(value = "field", required = true) @PathVariable("field") final String field, |
|
33 |
@ApiParam(value = "value", required = true) @RequestParam("value") final String value); |
|
35 | 34 |
} |
Also available in: Unified diff
cleanup, added method to search among apis