github.com/binkynet/BinkyNet@v1.12.1-0.20240421190447-da4e34c20be0/apis/v1/discovery.proto (about)

     1  // Copyright 2019 Ewout Prangsma
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  // 
    15  // Author Ewout Prangsma
    16  // 
    17  
    18  syntax = "proto3";
    19  
    20  package binkynet.v1;
    21  
    22  option go_package = "github.com/binkynet/BinkyNet/apis/v1";
    23  option csharp_namespace = "BinkyNet.Apis.V1";
    24  
    25  // ServiceInfo is used to standardize service description information.
    26  message ServiceInfo {
    27    // API version of the service.
    28    // Currently v1.
    29    // This is mapped to text field "api_version" in the zeroconf service entry.
    30    string api_version = 1;
    31    // Version of the component providing the service in semantic versioning format.
    32    // E.g. 1.0.4
    33    // This is mapped to text field "version" in the zeroconf service entry.
    34    string version = 2;
    35    // Port number on which the service is offered.
    36    // This is mapped to the standard port field of the zeroconf service entry.
    37    int32 api_port = 3;
    38    // Address (hostname / IP address) of the service.
    39    // This is mapped to the standard hostname + address fields of the zeroconf service entry.
    40    string api_address = 4;
    41    // If set, the API is served over TLS.
    42    // This is mapped to text field "secure" in the zeroconf service entry.
    43    bool secure = 5;
    44  }