Revision 47676
Added by Claudio Atzori almost 7 years ago
| DatasourcesApi.java | ||
|---|---|---|
| 5 | 5 |
import eu.dnetlib.datasource.publisher.model.BrowseTerm; |
| 6 | 6 |
import eu.dnetlib.datasource.publisher.model.DatasourceResponse; |
| 7 | 7 |
import eu.dnetlib.datasource.publisher.model.Response; |
| 8 |
import eu.dnetlib.datasource.publisher.model.db.Api; |
|
| 9 |
import eu.dnetlib.datasource.publisher.model.db.Datasource; |
|
| 8 | 10 |
import eu.dnetlib.datasource.publisher.model.db.SearchInterfacesEntry; |
| 9 |
import io.swagger.annotations.*; |
|
| 11 |
import io.swagger.annotations.ApiOperation; |
|
| 12 |
import io.swagger.annotations.ApiResponse; |
|
| 13 |
import io.swagger.annotations.ApiResponses; |
|
| 10 | 14 |
|
| 11 |
@Api(value = "datasources", description = "the datasource manager API") |
|
| 15 |
@io.swagger.annotations.Api(value = "datasources", description = "the datasource manager API")
|
|
| 12 | 16 |
public interface DatasourcesApi {
|
| 13 | 17 |
|
| 14 | 18 |
@ApiOperation(value = "list identifiers", notes = "List the Datasource identifiers.", response = List.class) |
| 15 | 19 |
@ApiResponses(value = {
|
| 16 |
@ApiResponse(code = 200, message = "OK", response = List.class),
|
|
| 20 |
@ApiResponse(code = 200, message = "OK", response = String[].class),
|
|
| 17 | 21 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
| 18 | 22 |
List<String> listIds(int page, int size) throws ApiException; |
| 19 | 23 |
|
| 20 | 24 |
@ApiOperation(value = "get datasource by id", notes = "Returns Datasource details.", response = DatasourceResponse.class) |
| 21 | 25 |
@ApiResponses(value = {
|
| 22 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse.class), |
|
| 26 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse[].class),
|
|
| 23 | 27 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
| 24 | 28 |
DatasourceResponse getDs(String id); |
| 25 | 29 |
|
| 26 |
@ApiOperation(value = "search datasources by name", notes = "Returns list of Datasource details.", response = DatasourceResponse.class) |
|
| 30 |
@ApiOperation(value = "search datasources by name", notes = "Returns list of Datasource details.", response = DatasourceResponse[].class)
|
|
| 27 | 31 |
@ApiResponses(value = {
|
| 28 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse.class), |
|
| 32 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse[].class),
|
|
| 29 | 33 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
| 30 | 34 |
List<DatasourceResponse> searchByName(String name, int page, int size); |
| 31 | 35 |
|
| 32 |
@ApiOperation(value = "search datasources by contact email", notes = "Returns list of Datasource details.", response = DatasourceResponse.class) |
|
| 36 |
@ApiOperation(value = "search datasources by contact email", notes = "Returns list of Datasource details.", response = DatasourceResponse[].class)
|
|
| 33 | 37 |
@ApiResponses(value = {
|
| 34 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse.class), |
|
| 38 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse[].class),
|
|
| 35 | 39 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
| 36 | 40 |
List<DatasourceResponse> searchByContactemail(String contactemail, int page, int size); |
| 37 | 41 |
|
| 38 |
@ApiOperation(value = "search datasources by country", notes = "Returns list of Datasource details.", response = DatasourceResponse.class) |
|
| 42 |
@ApiOperation(value = "search datasources by country", notes = "Returns list of Datasource details.", response = DatasourceResponse[].class)
|
|
| 39 | 43 |
@ApiResponses(value = {
|
| 40 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse.class), |
|
| 44 |
@ApiResponse(code = 200, message = "OK", response = DatasourceResponse[].class),
|
|
| 41 | 45 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
| 42 | 46 |
List<DatasourceResponse> searchByCountry(String country, int page, int size); |
| 43 | 47 |
|
| 44 |
@ApiOperation(value = "search among datasource APIs", notes = "Returns Datasource Api details.", response = SearchInterfacesEntry.class) |
|
| 48 |
@ApiOperation(value = "search among datasource APIs", notes = "Returns Datasource Api details.", response = SearchInterfacesEntry[].class)
|
|
| 45 | 49 |
@ApiResponses(value = {
|
| 46 |
@ApiResponse(code = 200, message = "OK", response = SearchInterfacesEntry.class), |
|
| 50 |
@ApiResponse(code = 200, message = "OK", response = SearchInterfacesEntry[].class),
|
|
| 47 | 51 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
| 48 | 52 |
List<SearchInterfacesEntry> searchInterface(String field, String value); |
| 49 | 53 |
|
| 50 |
@ApiOperation(value = "terms and count for the given field", notes = "Returns the list of BrowseTerms.", response = BrowseTerm.class) |
|
| 54 |
@ApiOperation(value = "terms and count for the given field", notes = "Returns the list of BrowseTerms.", response = BrowseTerm[].class)
|
|
| 51 | 55 |
@ApiResponses(value = {
|
| 52 |
@ApiResponse(code = 200, message = "OK", response = BrowseTerm.class), |
|
| 56 |
@ApiResponse(code = 200, message = "OK", response = BrowseTerm[].class),
|
|
| 53 | 57 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
| 54 | 58 |
List<? extends BrowseTerm> browseField(String field) throws ApiException; |
| 55 | 59 |
|
| 60 |
@ApiOperation(value = "get the list of API for a given datasource", notes = "Returns the list of API for a given datasource.", httpMethod = "GET", response = Api[].class) |
|
| 61 |
@ApiResponses(value = {
|
|
| 62 |
@ApiResponse(code = 200, message = "OK", response = Api[].class), |
|
| 63 |
@ApiResponse(code = 500, message = "unexpected error", response = Response.class) }) |
|
| 64 |
List<Api> getApi(String dsId) throws ApiException; |
|
| 65 |
|
|
| 66 |
@ApiOperation(value = "delete an API", notes = "delete an API", httpMethod = "DELETE") |
|
| 67 |
@ApiResponses(value = {
|
|
| 68 |
@ApiResponse(code = 200, message = "OK"), |
|
| 69 |
@ApiResponse(code = 500, message = "unexpected error") }) |
|
| 70 |
void deleteApi(String apiId) throws ApiException; |
|
| 71 |
|
|
| 72 |
@ApiOperation(value = "adds an API to one Datasource", notes = "adds an API to one Datasource", httpMethod = "POST") |
|
| 73 |
@ApiResponses(value = {
|
|
| 74 |
@ApiResponse(code = 200, message = "OK"), |
|
| 75 |
@ApiResponse(code = 500, message = "unexpected error") }) |
|
| 76 |
void addApi(Api api) throws ApiException; |
|
| 77 |
|
|
| 56 | 78 |
@ApiOperation(value = "set the managed status for a given datasource", notes = "set the managed status for a given datasource", httpMethod = "POST") |
| 57 | 79 |
@ApiResponses(value = {
|
| 58 | 80 |
@ApiResponse(code = 200, message = "OK"), |
| 59 | 81 |
@ApiResponse(code = 500, message = "unexpected error") }) |
| 60 | 82 |
void setManaged(String id, boolean managed); |
| 61 | 83 |
|
| 84 |
@ApiOperation(value = "adds a new datasource", notes = "adds a new datasource", httpMethod = "POST") |
|
| 85 |
@ApiResponses(value = {
|
|
| 86 |
@ApiResponse(code = 200, message = "OK"), |
|
| 87 |
@ApiResponse(code = 500, message = "unexpected error") }) |
|
| 88 |
void saveDatasource(Datasource datasource) throws ApiException; |
|
| 89 |
|
|
| 90 |
@ApiOperation(value = "updates a datasource official name", notes = "updates a datasource official name", httpMethod = "POST") |
|
| 91 |
@ApiResponses(value = {
|
|
| 92 |
@ApiResponse(code = 200, message = "OK"), |
|
| 93 |
@ApiResponse(code = 500, message = "unexpected error") }) |
|
| 94 |
void updateOfficialname(String dsId, String officialname) throws ApiException; |
|
| 95 |
|
|
| 96 |
@ApiOperation(value = "updates a datasource english name", notes = "updates a datasource english name", httpMethod = "POST") |
|
| 97 |
@ApiResponses(value = {
|
|
| 98 |
@ApiResponse(code = 200, message = "OK"), |
|
| 99 |
@ApiResponse(code = 500, message = "unexpected error") }) |
|
| 100 |
void updateEnglishname(String dsId, String english) throws ApiException; |
|
| 101 |
|
|
| 102 |
@ApiOperation(value = "updates a datasource latitude", notes = "updates a datasource latitude", httpMethod = "POST") |
|
| 103 |
@ApiResponses(value = {
|
|
| 104 |
@ApiResponse(code = 200, message = "OK"), |
|
| 105 |
@ApiResponse(code = 500, message = "unexpected error") }) |
|
| 106 |
void updateLatitude(String dsId, Double latitude) throws ApiException; |
|
| 107 |
|
|
| 108 |
@ApiOperation(value = "updates a datasource longitude", notes = "updates a datasource longitude", httpMethod = "POST") |
|
| 109 |
@ApiResponses(value = {
|
|
| 110 |
@ApiResponse(code = 200, message = "OK"), |
|
| 111 |
@ApiResponse(code = 500, message = "unexpected error") }) |
|
| 112 |
void updateLongitude(String dsId, Double longitude) throws ApiException; |
|
| 113 |
|
|
| 62 | 114 |
} |
Also available in: Unified diff
fine grained operations