/*
 * Copyright 2025 the original author or authors.
 *
 * 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
 *
 *      https://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.
 */

package com.alibaba.cloud.ai.studio.runtime.domain.tool;

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * Represents API parameter information.
 *
 * @since 1.0.0.3
 */

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class ApiParameter implements Serializable {

	/**
	 * Parameter name
	 */
	private String key;

	/**
	 * Parameter type
	 */
	private String type;

	/**
	 * Parameter description
	 */
	private String description;

	/**
	 * Parameter location
	 */
	private String location;

	/**
	 * Default value
	 */
	@JsonProperty("default_value")
	private String defaultValue;

	/**
	 * Whether the parameter is required
	 */
	private boolean required;

	/**
	 * Whether the parameter requires user input
	 */
	@JsonProperty("user_input")
	private boolean userInput;

	/**
	 * Enum values for the parameter
	 */
	private List enums;

	/**
	 * Sub-properties for object type parameters
	 */
	private List<ApiParameter> properties;

	/**
	 * Adds a sub-parameter to the properties list
	 */
	public void addSubParam(ApiParameter subParam) {
		if (properties == null) {
			properties = new ArrayList<>();
		}
		properties.add(subParam);
	}

}
