Skip to content

Add Regex Pattern to documentation #596

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

Merged
merged 2 commits into from
May 22, 2025

Conversation

knottnt
Copy link
Contributor

@knottnt knottnt commented May 20, 2025

Issue #, if available: 930

Description of changes:

  • Read smithy.api#pattern from aws-sdk-go-v2 JSON models
  • Add Regex pattern to documentation string if exists
  • Add test to verify pattern string is added when present

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

@ack-prow ack-prow bot requested review from jlbutler and rushmash91 May 20, 2025 00:06
@ack-prow ack-prow bot added the approved label May 20, 2025
- Read smithy.api#pattern from aws-sdk-go-v2 JSON models

- Add Regex pattern to documentation string if exists

- Add test to verify pattern string is added when present
@knottnt knottnt force-pushed the document-regex-pattern branch from 26f687f to 1b9720d Compare May 20, 2025 16:57
@knottnt
Copy link
Contributor Author

knottnt commented May 20, 2025

/retest

Copy link

ack-prow bot commented May 20, 2025

@knottnt: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
verify-attribution 669edbd link false /test verify-attribution
s3-olm-test 669edbd link false /test s3-olm-test

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

Copy link
Member

@michaelhtm michaelhtm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great @knottnt 👍

// this is being added for type union specifically. We want to generate
// api as struct and handle setSDK and setResource differently
RealType string
RealType string
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice gofmt

@knottnt
Copy link
Contributor Author

knottnt commented May 22, 2025

Example of yaml produced by this change.

 agentName:
    description: |-
      A name for the agent that you create.
    
      Regex Pattern: `^([0-9a-zA-Z][_-]?){1,100}$`
    type: string

@michaelhtm
Copy link
Member

/lgtm

@ack-prow ack-prow bot added the lgtm Indicates that a PR is ready to be merged. label May 22, 2025
Copy link

ack-prow bot commented May 22, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: knottnt, michaelhtm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ack-prow ack-prow bot merged commit cfe9477 into aws-controllers-k8s:main May 22, 2025
17 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants