# Copyright (C) 2020-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.

global:
  cpp_namespace: "mongo"

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

structs:

  # Follow the MongoDB Drivers API for passing API Version parameters in clients. The drivers API
  # is like MongoClient(uri, api={version: "1", strict: true, deprecationErrors: true}).

  ClientAPIVersionParameters:
    description: "Parser for Versioned API parameters passed to 'new Mongo()' in the mongo shell"
    strict: true
    fields:
      version:
        description: "The requested API version"
        type: string
        # The server requires the apiVersion parameter in commands, leave enforcement to the server.
        optional: true
      strict:
        description: "Whether to restrict the connection to behaviors in the requested API version"
        type: bool
        optional: true
      deprecationErrors:
        description: "Whether to restrict the connection to non-deprecated behaviors in the
          requested API version"
        type: bool
        optional: true