Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code examples: update validation list and IDs of enhanced actions #351

Closed
wants to merge 1 commit into from

Conversation

Laren-AWS
Copy link

Description

  • Add entry to allow list to pass validation.
  • Use the sdk_action name instead of the underlying REST API action name to form the example ID and service.action entry for enhanced actions. An enhanced action is one that adds additional features to an underlying client action.

Motivation and Context

The enhanced action change is needed to avoid multiple examples with the same ID. Because the ID is used as a key to merge examples, multiple examples with the same ID meant that they were overwriting each other. By using the SDK-specific action name in both the ID and the services.action list, they are each treated as individual actions.

Testing

  • Ran the -tools validator and everything passes.
  • Built and internal cloud desktop build.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

We require a second engineer to validate the PR before merging

  • My code builds in Gamma and passes backward compatibility validation (required)
  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have read the README document
  • I have added tests to cover my changes
  • All new and existing tests passed

New/existing dependencies impact assessment, if applicable

Note to reviewers: Please follow runbook to update the internal open source attribution tool

License

  • I confirm that this pull request can be released under the Apache 2 license

Use sdk_action for example ID and service.action in enhanced actions.
@Laren-AWS Laren-AWS changed the title Code exampels: update validation list and IDs of enhanced actions Code examples: update validation list and IDs of enhanced actions Jun 1, 2024
@jnunn-aws
Copy link
Contributor

@jnunn-aws
Copy link
Contributor

This has been merged.

@jnunn-aws jnunn-aws closed this Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants