Github user aledsage commented on a diff in the pull request: https://github.com/apache/brooklyn-server/pull/810#discussion_r140315673 --- Diff: rest/rest-api/src/main/java/org/apache/brooklyn/rest/api/TypeApi.java --- @@ -0,0 +1,94 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.brooklyn.rest.api; + +import java.util.List; + +import javax.ws.rs.Consumes; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +import org.apache.brooklyn.rest.domain.TypeDetail; +import org.apache.brooklyn.rest.domain.TypeSummary; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; + +@Path("/types") +@Api("Types") +@Consumes(MediaType.APPLICATION_JSON) +@Produces(MediaType.APPLICATION_JSON) +public interface TypeApi { + + @GET + @ApiOperation(value = "List types registered in the system", + response = TypeSummary.class, + responseContainer = "List") + public List<TypeSummary> list( + @ApiParam(name = "versions", value = "Whether to list 'latest' of each symbolic-name or 'all' versions", + required = false, defaultValue = "latest") + @QueryParam("versions") + String versions, + @ApiParam(name = "regex", value = "Regular expression to search for") + @QueryParam("regex") @DefaultValue("") String regex, + @ApiParam(name = "fragment", value = "Substring case-insensitive to search for") + @QueryParam("fragment") @DefaultValue("") String fragment); + + @Path("/{nameOrAlias}") + @GET + @ApiOperation(value = "Get summaries for all versions and instances of a given type or alias, with best match first", + response = TypeSummary.class, + responseContainer = "List") + public List<TypeSummary> listVersions( --- End diff -- Interesting point about reusing aliases. Hopefully that's not the case!
---