Adding IAM Action name trait to override using the API operation name #1665

0xjjoyy · 2023-03-07T20:11:41Z

Issue #, if available:

Description of changes:
Adds the ActionName trait to override using the API operation name as the IAM action name. Also, allows adding additional actions using the input member field if the value is not null in the request.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

kstich

This will need updates to the specification, that'd be in aws-iam.rst in the docs folder.
Java files should use the short-form license header (see Prefer short-form license header #1614)

kstich · 2023-03-07T23:41:35Z

smithy-aws-iam-traits/.gitignore

@@ -0,0 +1,3 @@
+gradle/


Can remove this, the top level .gitignore should handle these.

kstich · 2023-03-07T23:41:53Z

...traits/src/main/resources/META-INF/services/software.amazon.smithy.model.traits.TraitService

@@ -5,3 +5,4 @@ software.amazon.smithy.aws.iam.traits.DisableConditionKeyInferenceTrait$Provider
 software.amazon.smithy.aws.iam.traits.RequiredActionsTrait$Provider
 software.amazon.smithy.aws.iam.traits.SupportedPrincipalTypesTrait$Provider
 software.amazon.smithy.aws.iam.traits.IamResourceTrait$Provider
+software.amazon.smithy.aws.iam.traits.ActionNameTrait$Provider


nit: should have a trailing newline.

smithy-aws-iam-traits/src/main/java/software/amazon/smithy/aws/iam/traits/ActionNameTrait.java

kstich · 2023-03-07T23:48:02Z

smithy-aws-iam-traits/src/main/resources/META-INF/smithy/aws.iam.json

+            },
+            "traits": {
+                "smithy.api#trait": {
+                    "selector": ":test(operation, member)"


Sounds like this should be "operation", given the documentation. Tests should be updated to reflect this as well.

kstich · 2023-03-07T23:50:59Z

...m-traits/src/test/resources/software/amazon/smithy/aws/iam/traits/actionname-override.smithy

@@ -0,0 +1,17 @@
+$version: "1.0"


Should be a v2 model.

0xjjoyy · 2023-03-08T04:45:04Z

Thanks, made updates.

This will need updates to the specification, that'd be in aws-iam.rst in the docs folder.

updated

Java files should use the short-form license header (see #1614)

updated

kstich · 2023-03-13T04:45:16Z

docs/source-2.0/aws/aws-iam.rst

+.. smithy-trait:: aws.iam#actionName
+.. _aws.iam#actionName-trait:
+
+-------------------------------


The - wrapping needs to be the same length as the header content.

kstich · 2023-03-13T04:45:43Z

docs/source-2.0/aws/aws-iam.rst

+-------------------------------
+
+Summary
+    Provides the ability to override the default action name for the operation. By convention, the action name is the same as the operation name.


Can you wrap the new contents at 80 chars like the rest of the spec?

Simplify the summary to "Provides a custom IAM action name." since the rest is duplicate information with somewhere else in the spec.

kstich · 2023-03-13T04:54:22Z

docs/source-2.0/aws/aws-iam.rst

+Summary
+    Provides the ability to override the default action name for the operation. By convention, the action name is the same as the operation name.
+Trait selector
+    ``:test(operation)``


Doesn't need to be wrapped in :test().

kstich · 2023-03-13T04:54:46Z

smithy-aws-iam-traits/src/main/resources/META-INF/smithy/aws.iam.json

+                "smithy.api#trait": {
+                    "selector": "operation"
+                },
+                "smithy.api#documentation": "Provides the ability to override the default action name for the operation. By convention, the action name is the same as the operation name."


s/convention/default

Replace the first sentence with the one recommended for the spec.

kstich · 2023-03-13T05:03:29Z

docs/source-2.0/aws/aws-iam.rst

+Value type
+    ``string``
+
+Operations not annotated with the ``actionName`` trait use the operation name as the action name.


Defaults to the :ref:`shape name of the shape ID ` of the targeted operation.

kstich · 2023-03-13T05:11:11Z

docs/source-2.0/aws/aws-iam.rst

+
+The following example defines two operations:
+
+* OperationA is not annoated with the ``actionName`` trait, so has the action name ``OperationA`` which is the same as the operation name.


The first OperationA should be in double backticks.

s/annoated/annotated

"so has the action name OperationA which is the same as the operation name." -> and resolves the action name of OperationA.

kstich · 2023-03-13T05:11:31Z

docs/source-2.0/aws/aws-iam.rst

+The following example defines two operations:
+
+* OperationA is not annoated with the ``actionName`` trait, so has the action name ``OperationA`` which is the same as the operation name.
+* OperationB has the ``actionName`` trait, so has the action name ``OverridingActionName``.


OperationB should be in double backticks.

0xjjoyy requested a review from a team as a code owner March 7, 2023 20:11

kstich requested changes Mar 7, 2023

View reviewed changes

kstich self-assigned this Mar 7, 2023

Adding IAM Action name trait to override using the API operation name

f05d465

0xjjoyy force-pushed the main branch from 97bc457 to f05d465 Compare March 8, 2023 04:09

0xjjoyy added 2 commits March 7, 2023 23:13

use short-form license header smithy-lang#1614

e6b2dfe

adding actionName doc updates

1439027

0xjjoyy requested a review from kstich March 8, 2023 04:56

kstich reviewed Mar 13, 2023

View reviewed changes

0xjjoyy added 3 commits March 13, 2023 01:54

updating text

67fde56

wrapping length

d6e5843

word wrap

91f96e2

kstich approved these changes Mar 29, 2023

View reviewed changes

kstich merged commit 91d0af9 into smithy-lang:main Mar 29, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding IAM Action name trait to override using the API operation name #1665

Adding IAM Action name trait to override using the API operation name #1665

0xjjoyy commented Mar 7, 2023

kstich left a comment

kstich Mar 7, 2023

0xjjoyy Mar 8, 2023

kstich Mar 7, 2023

0xjjoyy Mar 8, 2023

kstich Mar 7, 2023

0xjjoyy Mar 8, 2023

kstich Mar 7, 2023

0xjjoyy Mar 8, 2023

0xjjoyy commented Mar 8, 2023

kstich Mar 13, 2023

0xjjoyy Mar 13, 2023

kstich Mar 13, 2023

kstich Mar 13, 2023

0xjjoyy Mar 13, 2023

kstich Mar 13, 2023

kstich Mar 13, 2023

0xjjoyy Mar 13, 2023

kstich Mar 13, 2023

0xjjoyy Mar 13, 2023

kstich Mar 13, 2023

0xjjoyy Mar 13, 2023

kstich Mar 13, 2023

0xjjoyy Mar 13, 2023


		The following example defines two operations:

		* OperationA is not annoated with the ``actionName`` trait, so has the action name ``OperationA`` which is the same as the operation name.

Adding IAM Action name trait to override using the API operation name #1665

Adding IAM Action name trait to override using the API operation name #1665

Conversation

0xjjoyy commented Mar 7, 2023

kstich left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xjjoyy commented Mar 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment