// Copyright 2026 Google LLC
//
// 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 google.cloud.ces.v1;

import "google/api/field_behavior.proto";
import "google/cloud/ces/v1/auth.proto";
import "google/cloud/ces/v1/common.proto";

option go_package = "cloud.google.com/go/ces/apiv1/cespb;cespb";
option java_multiple_files = true;
option java_outer_classname = "OpenApiToolProto";
option java_package = "com.google.cloud.ces.v1";

// A remote API tool defined by an OpenAPI schema.
message OpenApiTool {
  // Required. The OpenAPI schema in JSON or YAML format.
  string open_api_schema = 1 [(google.api.field_behavior) = REQUIRED];

  // Optional. The name of the tool. If not provided, the name of the tool will
  // be derived from the OpenAPI schema, from `operation.operationId`.
  string name = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The description of the tool. If not provided, the description of
  // the tool will be derived from the OpenAPI schema, from
  // `operation.description` or `operation.summary`.
  string description = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Authentication information required by the API.
  ApiAuthentication api_authentication = 4
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. The TLS configuration. Includes the custom server certificates
  // that the client will trust.
  TlsConfig tls_config = 5 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Service Directory configuration.
  ServiceDirectoryConfig service_directory_config = 6
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. If true, the agent will ignore unknown fields in the API
  // response.
  bool ignore_unknown_fields = 7 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The server URL of the Open API schema.
  // This field is only set in tools in the environment dependencies during the
  // export process if the schema contains a server url. During the import
  // process, if this url is present in the environment dependencies and the
  // schema has the $env_var placeholder, it will replace the placeholder in the
  // schema.
  string url = 8 [(google.api.field_behavior) = OPTIONAL];
}