# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# 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
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

# Document source list sessions stage IDL file

global:
   cpp_namespace: "mongo"

imports:
    - "mongo/db/basic_types.idl"

structs:

  ListSessionsUser:
    description: "A struct representing a $listSessions/$listLocalSessions User"
    strict: true
    generate_comparison_operators: true
    query_shape_component: true
    fields:
      user: 
        type: string
        query_shape: anonymize
      db: 
        type: string
        query_shape: anonymize

  ListSessionsSpec:
    description: "$listSessions and $listLocalSessions pipeline spec"
    strict: true
    query_shape_component: true
    fields:
      allUsers:
        type: bool
        default: false
        # This boolean parameterizes the stage rather than representing user input, so do not abstract the literal.
        query_shape: parameter
      users:
        type: array<ListSessionsUser>
        optional: true
        query_shape: literal
      $_internalPredicate:
        cpp_name: predicate
        type: object
        optional: true
        query_shape: literal  # This is a MatchExpression predicate and could be shape-ified rather than completely abstracted.