<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" rel="stylesheet"
        integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/all.min.css"
        integrity="sha512-SzlrxWUlpfuzQ+pcUCosxcglQRNAq/DZjVsC0lE40xsADsfeQoEypE+enwcOiGjk/bSuGGKHEyjSoQ1zVisanQ=="
        crossorigin="anonymous" referrerpolicy="no-referrer" />
</head>
</html>
<?php

declare(strict_types=1);

namespace Automattic\WooCommerce\Api\Attributes;

use Attribute;

/**
 * Adds a description to a query/mutation argument without overriding its type.
 *
 * Sets the description for a query/mutation argument. Can be used both for
 * arguments inferred from the `execute()` method signature and for arguments
 * declared via #[Parameter]. However, a parameter must not have a description
 * in both #[Parameter] and #[ParameterDescription] — that is a build error.
 * This attribute is repeatable: apply it once per argument that needs a
 * description.
 */
#[Attribute( Attribute::TARGET_ALL | Attribute::IS_REPEATABLE )]
final class ParameterDescription {
	/**
	 * Constructor.
	 *
	 * @param string $name        The argument name (must match the `execute()`
	 *                            parameter name).
	 * @param string $description Human-readable description for the schema.
	 */
	public function __construct(
		public readonly string $name,
		public readonly string $description,
	) {
	}
}
