From 5ae40ed73642c8effac97323aa18f4664f807645 Mon Sep 17 00:00:00 2001
From: rjhornsby <rhornsby@ktzr.net>
Date: Thu, 23 Feb 2023 15:12:26 -0600
Subject: [PATCH] Describe aws_iam route parameter

---
 lib/vault/api/auth.rb | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lib/vault/api/auth.rb b/lib/vault/api/auth.rb
index 472d144..d21840c 100644
--- a/lib/vault/api/auth.rb
+++ b/lib/vault/api/auth.rb
@@ -203,6 +203,7 @@ def aws_ec2(role, pkcs7, nonce = nil, route = nil)
     # @param [String] sts_endpoint optional
     #   https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
     # @param [String] route optional
+    #   The full api path to the auth method's login endpoint, ie `/v1/auth/aws/mycorp/myorg/login`
     # @return [Secret]
     def aws_iam(role, credentials_provider, iam_auth_header_value = nil, sts_endpoint = 'https://sts.amazonaws.com', route = nil)
       require "aws-sigv4"