Mailing-List: contact dev-help@brooklyn.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@brooklyn.apache.org
From: aledsage <git@git.apache.org>
To: dev@brooklyn.apache.org
Reply-To: dev@brooklyn.apache.org
References: <git-pr-810-brooklyn-server@git.apache.org>
In-Reply-To: <git-pr-810-brooklyn-server@git.apache.org>
Subject: [GitHub] brooklyn-server pull request #810: REST API for bundles, types, and subtypes
Content-Type: text/plain
Message-Id: <20170921175855.B958DF5A62@git1-us-west.apache.org>
Date: Thu, 21 Sep 2017 17:58:55 +0000 (UTC)
archived-at: Thu, 21 Sep 2017 17:58:58 -0000

Github user aledsage commented on a diff in the pull request:

    https://github.com/apache/brooklyn-server/pull/810#discussion_r140313345
  
    --- Diff: rest/rest-api/src/main/java/org/apache/brooklyn/rest/api/SubtypeApi.java ---
    @@ -0,0 +1,96 @@
    +/*
    + * 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 org.apache.brooklyn.rest.domain.TypeSummary;
    +
    +import io.swagger.annotations.Api;
    +import io.swagger.annotations.ApiOperation;
    +import io.swagger.annotations.ApiParam;
    +
    +@Path("/subtypes")
    +@Api("Subtypes")
    +@Consumes(MediaType.APPLICATION_JSON)
    +@Produces(MediaType.APPLICATION_JSON)
    +public interface SubtypeApi {
    +
    +    @Path("/{supertype}")
    +    @GET
    +    @ApiOperation(value = "Get all known types which declare the given argument as a supertype", 
    +            response = TypeSummary.class, responseContainer = "List")
    +    public List<TypeSummary> list(
    +        @ApiParam(name = "supertype", value = "Supertype to query", required = true)
    +        @PathParam("supertype")
    +        String supertype,
    +        @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")
    --- End diff --
    
    No strong feelings, but I wonder if we should err towards the smaller api (simpler to support and for someone to get their head around). You can achieve everything with regex. A UI could offer a fragment search on top of that, escaping things as needed.


---