Skip to content

Conversation

@hoegertn
Copy link
Member

@hoegertn hoegertn commented Nov 20, 2025

  • Introduced a new query getSeasonExportRBW to export season data in RBW format.
  • Added corresponding argument types QueryGetSeasonExportRbwArgs for associationId and seasonId.
  • Updated GraphQL schema and documentation to reflect these changes.

Summary by CodeRabbit

  • New Features

    • Added new GraphQL query to support season export functionality in RBW format with authenticated access.
  • Documentation

    • Updated API documentation with current schema and type definitions.

✏️ Tip: You can customize this high-level summary in your review settings.

- Introduced a new query `getSeasonExportRBW` to export season data in RBW format.
- Added corresponding argument types `QueryGetSeasonExportRbwArgs` for `associationId` and `seasonId`.
- Updated GraphQL schema and documentation to reflect these changes.
@amazon-inspector-frankfurt
Copy link

⏳ I'm reviewing this pull request for security vulnerabilities and code quality issues. I'll provide an update when I'm done

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 20, 2025

Walkthrough

A new GraphQL query getSeasonExportRBW is added to enable exporting seasons in RBW format, with corresponding auto-generated documentation and updates to navigation/search asset data.

Changes

Cohort / File(s) Summary
GraphQL Schema
schema.graphql
Added new query getSeasonExportRBW(associationId: ID!, seasonId: ID!): String to the Query type with AWS Cognito user pools authorization
Generated Documentation
docs/types/QueryGetSeasonExportRbwArgs.html
New auto-generated HTML documentation page for the QueryGetSeasonExportRbwArgs type alias, documenting properties associationId and seasonId
Documentation Assets
docs/assets/navigation.js, docs/assets/search.js
Updated base64-encoded JSON data in global variables window.navigationData and window.searchData to reflect schema and documentation changes

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Schema correctness: Verify the new GraphQL query follows naming conventions, argument types, and authorization directives are correctly applied
  • Generated documentation: Confirm the auto-generated HTML page accurately reflects the type definition and properties
  • Data synchronization: Ensure navigation and search asset data are properly updated and consistent across both files

Possibly related PRs

Suggested reviewers

  • hoegerma

Poem

🐰 A new query hops into place,
RBW exports now embrace,
The schema grows, docs follow suit,
Navigation updated—smooth as a boot! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. It lacks the required template sections, including what kind of change this is, behavior explanation, breaking change assessment, and confirmation of added tests/documentation. Update the description to follow the provided template structure, explicitly addressing each required section such as change type, current/new behavior, breaking changes, and test/documentation additions.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a new GraphQL query called getSeasonExportRBW, which aligns with the schema.graphql modifications and overall PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch rbw-export

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot requested a review from hoegerma November 20, 2025 20:30
@taimos-projen taimos-projen bot enabled auto-merge November 20, 2025 20:30
@amazon-inspector-frankfurt
Copy link

✅ I finished the code review, and didn't find any security or code quality issues.

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
schema.graphql (1)

567-568: Query definition looks good, but return type could be clearer.

The new query is correctly added to the schema with proper syntax and authentication directive. However, the comment and return type String don't explicitly document the expected format (RBW, JSON, CSV, etc.). Consider clarifying the documentation:

- # Export the season in RBW format
- getSeasonExportRBW(associationId: ID!, seasonId: ID!): String @aws_cognito_user_pools
+ # Export the season in RBW format (returns RBW-formatted string)
+ getSeasonExportRBW(associationId: ID!, seasonId: ID!): String @aws_cognito_user_pools

Alternatively, if the format varies or is client-determined, document that expectation. This is optional but improves API clarity.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6fadccf and d71631c.

⛔ Files ignored due to path filters (1)
  • src/generated/graphql.model.generated.ts is excluded by !**/generated/**
📒 Files selected for processing (4)
  • docs/assets/navigation.js (1 hunks)
  • docs/assets/search.js (1 hunks)
  • docs/types/QueryGetSeasonExportRbwArgs.html (1 hunks)
  • schema.graphql (1 hunks)
🔇 Additional comments (3)
docs/assets/search.js (1)

1-1: Auto-generated search index data update.

This appears to be an auto-generated search index for documentation. The data string replacement is expected as part of adding new documentation for the getSeasonExportRBW query.

docs/assets/navigation.js (1)

1-1: Auto-generated navigation index data update.

This is an auto-generated navigation index for the documentation. The data string update is expected as part of adding documentation for the new getSeasonExportRBW query.

docs/types/QueryGetSeasonExportRbwArgs.html (1)

1-3: Auto-generated documentation page.

This is a properly generated HTML documentation page for the QueryGetSeasonExportRbwArgs type. The properties (associationId and seasonId) correctly match the GraphQL query arguments defined in schema.graphql. The documentation is properly integrated with the navigation and search indexes.

@taimos-projen taimos-projen bot added this pull request to the merge queue Nov 20, 2025
Merged via the queue into main with commit c3cef67 Nov 20, 2025
6 checks passed
@taimos-projen taimos-projen bot deleted the rbw-export branch November 20, 2025 20:36
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.

3 participants