brooklyn-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aledsage <...@git.apache.org>
Subject [GitHub] brooklyn-server pull request #810: REST API for bundles, types, and subtypes
Date Thu, 21 Sep 2017 17:58:55 GMT
Github user aledsage commented on a diff in the pull request:

    https://github.com/apache/brooklyn-server/pull/810#discussion_r140307822
  
    --- Diff: rest/rest-api/src/main/java/org/apache/brooklyn/rest/api/BundleApi.java ---
    @@ -0,0 +1,158 @@
    +/*
    + * 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.validation.Valid;
    +import javax.ws.rs.Consumes;
    +import javax.ws.rs.DELETE;
    +import javax.ws.rs.DefaultValue;
    +import javax.ws.rs.GET;
    +import javax.ws.rs.POST;
    +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.BundleInstallationRestResult;
    +import org.apache.brooklyn.rest.domain.BundleSummary;
    +
    +import io.swagger.annotations.Api;
    +import io.swagger.annotations.ApiOperation;
    +import io.swagger.annotations.ApiParam;
    +import io.swagger.annotations.ApiResponse;
    +import io.swagger.annotations.ApiResponses;
    +
    +@Path("/bundles")
    +@Api("Bundles")
    +@Consumes(MediaType.APPLICATION_JSON)
    +@Produces(MediaType.APPLICATION_JSON)
    +public interface BundleApi {
    +
    +    @GET
    +    @ApiOperation(value = "List bundles registered in the system including their types",

    +            response = BundleSummary.class,
    +            responseContainer = "List")
    +    public List<BundleSummary> list(
    --- End diff --
    
    Feels like this will return a huge amount of data (giving all the types that are inside
the bundle).
    
    Do we want a way to just list the bundles? I think we want to have a `BundleSummary` and
a `BundleDetail`, where only the latter includes all the types. The `list` method could include
support for `?detail=true` if we think that's important for a UI to retrieve everything it
needs to show in one go.


---

Mime
View raw message