/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * Licensed 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.
 *
*/

syntax = "proto3";
package gz.msgs;
option java_package = "com.gz.msgs";
option java_outer_classname = "RestResponseProtos";

/// \ingroup gz.msgs
/// \interface RestResponse
/// \brief A message for reporting a response from a REST service call

import "gz/msgs/header.proto";

message RestResponse
{
  enum Type
  {
    /// \brief Rest service call was successful
    SUCCESS = 0;

    /// \brief Error calling rest service
    ERR    = 1;

    /// \brief Response to a login request
    LOGIN    = 2;

    /// \brief Response to a logout request
    LOGOUT   = 3;
  }

  /// \brief Optional header data
  Header header = 1;

  /// \brief ID of the response message
  uint32 id   = 2;

  /// \brief Type of response
  Type type   = 3;

  /// \brief Message describing the response
  string msg  = 4;
}