Skip to content

Standardize SQL query placeholder formatting to snake_case#32

Merged
jeffreyaven merged 1 commit intomainfrom
claude/update-doc-template-syntax-aQLvq
Feb 23, 2026
Merged

Standardize SQL query placeholder formatting to snake_case#32
jeffreyaven merged 1 commit intomainfrom
claude/update-doc-template-syntax-aQLvq

Conversation

@jeffreyaven
Copy link
Contributor

Description

This PR standardizes the placeholder formatting in SQL query examples across all AWS service documentation files. The changes convert placeholder names from PascalCase (e.g., {{ JobDefinitionName }}) and mixed case formats to consistent snake_case (e.g., {{ job_definition_name }}).

Additionally, the code generator (bin/generate-docs.js) has been updated to produce snake_case placeholders going forward, ensuring consistency in all future documentation generation.

Changes Made

  • Updated SQL query examples in 100+ service documentation files to use snake_case placeholders
  • Modified the documentation generator to output snake_case variable names in SQL templates
  • Standardized both SELECT and INSERT query examples across all services

Services Affected

This change impacts documentation for services including (but not limited to):

  • AWS Batch (job definitions, compute environments, job queues, scheduling policies)
  • AWS AppFlow (flows, connector profiles)
  • AWS Auto Scaling (auto scaling groups, scaling policies, launch configurations)
  • AWS Bedrock (knowledge bases, data sources, agents, guardrails, flows, etc.)
  • AWS AppSync (GraphQL APIs, data sources, resolvers, etc.)
  • AWS API Gateway (REST APIs, stages, methods, domain names, etc.)
  • And many more AWS services

Checklist

  • The PR title is descriptive
  • Changes follow the existing code style and patterns
  • Documentation examples are now consistent across all services

Additional Notes

This is a documentation-only change that improves consistency and readability of SQL query examples. The snake_case format is more aligned with SQL naming conventions and makes the placeholders more intuitive for users. No functional changes to the codebase itself.

https://claude.ai/code/session_01QMBgxzvTuHbfB3F8v52Cts

…on for global services

- Replace angle bracket template syntax (<Anything>) with double brace syntax ({{ anything }}) in all SQL examples and manifest templates
- Convert all property value references to snake_case (e.g., {{ role_name }} instead of {{ RoleName }}) while keeping SQL column names in their original PascalCase form
- Remove global services special case so all services (including iam, route53, cloudfront, etc.) use region = 'us-east-1' in examples
- Add yaml.dump options (lineWidth: -1) and trimEnd() for cleaner manifest YAML output
- Snake_case manifest prop names and nested object keys in stackql-deploy templates

https://claude.ai/code/session_01QMBgxzvTuHbfB3F8v52Cts
@jeffreyaven jeffreyaven merged commit a26cf37 into main Feb 23, 2026
1 check passed
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.

2 participants