Skip to content

[FFS-4381] switch to an autogenerated swagger approach#73

Open
iannorriswork wants to merge 2 commits into
mainfrom
swagger-experiment
Open

[FFS-4381] switch to an autogenerated swagger approach#73
iannorriswork wants to merge 2 commits into
mainfrom
swagger-experiment

Conversation

@iannorriswork
Copy link
Copy Markdown
Contributor

@iannorriswork iannorriswork commented May 14, 2026

Jira Ticket

Description

This is a PR trying to move away from handcrafted swagger towards something that actually lives in the code.

  • generate the swagger from Rails
  • uses tests to enforce that the swagger is being updated continuously
  • if this looks good, will apply to the other endpoints as well.
  • the one annoying thing in this is having to switch from minitest to Rspec, though I do think Rspec is superior anyway.

Submitter Checklist

  • Jira Ticket: The relevant Jira ticket is linked in the header.
  • Evidence of Testing: I have included evidence of bench testing (e.g., terminal output, screenshots, logs) below.
  • Security Boundary: I have checked if any security boundaries are changing.
  • Backwards Compatibility: I have verified that these changes do not introduce any backwards compatibility issues.
  • I've updated the Confluence documentation, content in the /docs folder, and any API spec docs

Reviewer Checklist

  • Verification: I have verified that the changes work as intended.
  • Backwards Compatibility: I have confirmed that the code does not introduce any backwards compatibility issues.
  • Security & Privacy: I have reviewed the changes for potential security or privacy risks (e.g., PII handling).
  • Contract Compliance: If the public API contract changed, I have verified that it is reflected in api-spec/ and follows the organization's standards.
  • Code Quality: The code is clean, well-tested, and follows the established patterns in the codebase.
  • Code Quality: The code has unit and integration tests that cover relevant code changes.

Evidence of Testing

Paste test results here

@iannorriswork iannorriswork requested a review from a team May 14, 2026 17:33
Copy link
Copy Markdown

@tdooner tdooner left a comment

Choose a reason for hiding this comment

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

Seems legit but, oh man, what is going on with all that stubbing in rails_helper.rb?

def inject_into_connection_string(conninfo); conninfo; end
end
end
end
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Huh what, is there really no better way to stub out whatever AWS is necessary for (publishing the swagger file?) than this? Can we just disable the AWS related thing in test?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah, that was the AI fighting against some defaults i need to fix...i'll yank that out and go fix that seperately.

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