..
    #
    # This file is a part of the CaosDB Project.
    #
    # Copyright (C) 2021 Timm Fitschen <t.fitschen@indiscale.com>
    # Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
    #
    # This program is free software: you can redistribute it and/or modify
    # it under the terms of the GNU Affero General Public License as
    # published by the Free Software Foundation, either version 3 of the
    # License, or (at your option) any later version.
    #
    # This program is distributed in the hope that it will be useful,
    # but WITHOUT ANY WARRANTY; without even the implied warranty of
    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    # GNU Affero General Public License for more details.
    #
    # You should have received a copy of the GNU Affero General Public License
    # along with this program. If not, see <https://www.gnu.org/licenses/>.
    #
    #



.. _package_caosdb.info.v1:


#######################################
caosdb.info.v1
#######################################

.. toctree::
    :hidden:




.. _ref_caosdb/info/v1/main.proto:

caosdb/info/v1/main.proto
==================================================================

This is the main file of the caosdb.info.v1 package.



.. _ref_caosdb.info.v1.GetSessionInfoRequest:

GetSessionInfoRequest
------------------------------------------------------------------

Request message for the GetSessionInfo RPC








.. _ref_caosdb.info.v1.GetSessionInfoResponse:

GetSessionInfoResponse
------------------------------------------------------------------

Response message for the GetSessionInfo RPC



.. csv-table:: GetSessionInfoResponse type fields
   :header: "Field", "Type", "Label", "Description"
   :widths: auto

   "realm", ":ref:`string<ref_string>`", "", "The realm of the user who owns this session"
   "username", ":ref:`string<ref_string>`", "", "The name of the user who owns this session"
   "roles", ":ref:`string<ref_string>`", "repeated", "The roles of the user who owns this session"
   "expires", ":ref:`int64<ref_int64>`", "", "Seconds until this sessions expires (approximately)."
   "permissions", ":ref:`string<ref_string>`", "repeated", "The permissions of the user who owns this sessions"







.. _ref_caosdb.info.v1.GetVersionInfoRequest:

GetVersionInfoRequest
------------------------------------------------------------------

Request message for the GetVersionInfo RPC








.. _ref_caosdb.info.v1.GetVersionInfoResponse:

GetVersionInfoResponse
------------------------------------------------------------------

Response message for the GetVersionInfo RPC



.. csv-table:: GetVersionInfoResponse type fields
   :header: "Field", "Type", "Label", "Description"
   :widths: auto

   "version_info", ":ref:`VersionInfo<ref_caosdb.info.v1.VersionInfo>`", "", "The version of the server"







.. _ref_caosdb.info.v1.VersionInfo:

VersionInfo
------------------------------------------------------------------

The version of an agent (following SemVer 2.0.0)



.. csv-table:: VersionInfo type fields
   :header: "Field", "Type", "Label", "Description"
   :widths: auto

   "major", ":ref:`int32<ref_int32>`", "", "Major version number"
   "minor", ":ref:`int32<ref_int32>`", "", "Minor version number"
   "patch", ":ref:`int32<ref_int32>`", "", "Patch version"
   "pre_release", ":ref:`string<ref_string>`", "", "Pre-release version"
   "build", ":ref:`string<ref_string>`", "", "Build metadata"













.. _ref_caosdb.info.v1.GeneralInfoService:

GeneralInfoService
------------------------------------------------------------------

A service which provides general information about the server.

.. csv-table:: GeneralInfoService service methods
   :header: "Method Name", "Request Type", "Response Type", "Description"
   :widths: auto

   "GetVersionInfo", ":ref:`ref_caosdb.info.v1.GetVersionInfoRequest`", ":ref:`ref_caosdb.info.v1.GetVersionInfoResponse`", "Request the detailed version information from the server."
   "GetSessionInfo", ":ref:`ref_caosdb.info.v1.GetSessionInfoRequest`", ":ref:`ref_caosdb.info.v1.GetSessionInfoResponse`", "Request information about the current session (user, roles, timeout...)."