bbotella commented on code in PR #159: URL: https://github.com/apache/cassandra-sidecar/pull/159#discussion_r1887063434
########## client-common/src/main/java/org/apache/cassandra/sidecar/common/response/GossipStatusResponse.java: ########## @@ -0,0 +1,46 @@ +/* + * 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.cassandra.sidecar.common.response; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * Response for GET gossip status API + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +public class GossipStatusResponse +{ + /** + * Constructs a response with gossip status + * @param gossipRunning running status of gossip + */ + public GossipStatusResponse(@JsonProperty("gossipRunning") boolean gossipRunning) + { + this.gossipRunning = gossipRunning; + } + + @JsonProperty("gossipRunning") + public boolean gossipRunning() + { + return gossipRunning; Review Comment: I meant that a response payload is a bunch of bytes that need to be parsed anyway, even if it is a json payload, it needs to be parsed. The client is in charge of parsing it and interpreting fields as booleans, strings, or anything else. That said, I do agree with @frankgh in which the flexibility added by returning that enum is preferable in this case. On the client side, it is client's responsibility to parse the response correctly. In our current implementation, we control de java client for instance. We are also adding OpenAPI documentation that will help clients parse the given responses as part of this [PR](https://github.com/apache/cassandra-sidecar/pull/164). Long story short, I don't think returning a `"RUNNING"` response is making things harder for the client than returning a `true`, and it gives us flexibility to grow the API in the future. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
