Skip to content

Conversation

@sbarbett
Copy link
Contributor

Description

This PR includes two key changes:

  1. Authorization Folder & Endpoints

    • Added a new Authorization folder to the Postman collection.
    • Includes a request for generating an authentication token and refreshing an existing token.
    • The request includes descriptions and example responses to improve discoverability and clarity in the OpenAPI export.
  2. Postman Collection Validation Improvements (CI)

    • Updated the CI validation process for Postman collections to replace schema-based validation with targeted structural validation.
    • This change addresses false positive failures caused by issues in the published Postman schema while preserving the ability to catch legitimate structural problems.
    • Clearer, more actionable error messages are now provided for real validation issues.

Fixes # TME-136 & TME-137

Type of change

  • New feature (non-breaking change which adds functionality)
  • Documentation update
  • CI/CD changes

How Has This Been Tested?

  • Authorization Folder:

    • Verified new requests execute successfully in Postman and return the expected responses.
  • Validation Update:

    • Ran CI against multiple valid Postman collections to confirm no false positive failures.
    • Intentionally introduced structural errors to confirm real issues are still detected with clear error messages.
    • Tested OpenAPI spec conversion and validated in Swagger Editor

Test Environment:

  • OS: macOS 15.6
  • Postman v11.x
  • OpenAPI export validated with Swagger Editor

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing tests pass locally with my changes
  • I have read and followed the Code of Conduct

Additional Notes

  • The CI validation update is part of a broader effort to improve automation reliability and reduce unnecessary pipeline failures.
  • The Authorization folder is part of the v1.1.1 story.

Related Issues

  • Relates to: TME-434

@sbarbett sbarbett self-assigned this Aug 15, 2025
@sbarbett sbarbett added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 15, 2025
@github-actions
Copy link
Contributor

✅ Postman Files Validation

All Postman files are valid and ready for sanitization.

@sbarbett sbarbett merged commit 3014923 into main Aug 15, 2025
1 check passed
@sbarbett sbarbett deleted the feature/auth-apis branch August 15, 2025 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant