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

fix: Add type names to custom parameter types #5620

Merged
merged 5 commits into from
Jul 27, 2023

Conversation

Leo10Gama
Copy link
Member

Why is this change necessary?

Since the SAM CLI uses custom types without names, we had to create a constant to map the name of the parameter to its set of possible values. This creates additional overhead when creating new custom parameter types.

How does it address the issue?

The name fields of each of these types have now been populated, and as such, they are able to be read by the schema parser. This means we can include the expected type (or types) of the parameter to be read.

What side effects does this change have?

The name field of each SAM CLI custom type has been populated instead of being an empty string (not that it was being used to begin with).

Mandatory Checklist

PRs will only be reviewed after checklist is complete

  • Add input/output type hints to new functions/methods
  • Write design document if needed (Do I need to write a design document?)
  • Write/update unit tests
  • Write/update integration tests
  • Write/update functional tests if needed
  • make pr passes
  • make update-reproducible-reqs if dependencies were changed
  • Write documentation

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

@Leo10Gama Leo10Gama requested a review from a team as a code owner July 26, 2023 16:45
@Leo10Gama Leo10Gama requested review from lucashuy and jfuss July 26, 2023 16:45
@github-actions github-actions bot added pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. labels Jul 26, 2023
schema/make_schema.py Outdated Show resolved Hide resolved
Also regenerate schema
@lucashuy lucashuy merged commit b15ab88 into aws:feat/json-schema Jul 27, 2023
73 checks passed
@Leo10Gama Leo10Gama deleted the fix-param-names branch July 27, 2023 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants