Github user kevdoran commented on a diff in the pull request:
https://github.com/apache/nifi-registry/pull/22#discussion_r145695492
--- Diff:
nifi-registry-web-api/src/main/java/org/apache/nifi/registry/web/api/FlowResource.java
---
@@ -0,0 +1,69 @@
+/*
+ * 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.nifi.registry.web.api;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import org.apache.nifi.registry.authorization.Authorizer;
+import org.apache.nifi.registry.field.Fields;
+import org.apache.nifi.registry.service.AuthorizationService;
+import org.apache.nifi.registry.service.RegistryService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import java.util.Set;
+
+@Component
+@Path("/flows")
+@Api(
+ value = "/flows",
+ description = "Gets metadata about flows."
+)
+public class FlowResource extends AuthorizableApplicationResource {
+
+ private final RegistryService registryService;
+
+ @Autowired
+ public FlowResource(
+ final RegistryService registryService,
+ final AuthorizationService authorizationService,
+ final Authorizer authorizer) {
+ super(authorizer, authorizationService);
+ this.registryService = registryService;
+ }
+
+ @GET
+ @Path("fields")
+ @Consumes(MediaType.WILDCARD)
+ @Produces(MediaType.APPLICATION_JSON)
+ @ApiOperation(
+ value = "Retrieves the available field names that can be used
for searching or sorting on flows.",
+ response = Fields.class
+ )
+ public Response getAvailableFlowFields() {
+ final Set<String> flowFields = registryService.getFlowFields();
+ final Fields fields = new Fields(flowFields);
+ return Response.status(Response.Status.OK).entity(fields).build();
+ }
+
+}
--- End diff --
I've been thinking this over and am interested in getting your take on
something:
It occurred to me that as we add additional types of BucketItem over times,
each type need its own resource for looking up reference values, etc. That's
not necessarily a problem, but it did prompt me to consider some alternatives.
Perhaps combining all fields into a nested object returned by /fields (or, in
that case, just extending the existing /buckets/fields to include nested
objects holding the fields each bucket item type). I also wondered if we have a
use case for these fields changing dynamically, and if not, should we just
include a static list of valid field values in the documentation? There might
be perfectly valid reasons for making the list dynamic and discoverable, so I'm
not against it. I'm perfectly ok with adding this FlowResource for reference
value look up as is. Just considering how well it will age over time and its
utility.
---
