Skip to content

Conversation

@dguisinger
Copy link
Member

  • Add OpenApiDocumentSorter utility to enforce consistent ordering of all OpenAPI collections (paths, schemas, operations, responses, etc.)
  • Implement deterministic sorting rules: alphabetical for most collections, HTTP method order for operations, numeric for status codes
  • Update OpenApiMerger to sort documents before returning merged results
  • Update OpenApiSpecGenerator with sorting logic in separate partial class for maintainability
  • Add --force flag to MergeCommand to allow overwriting unchanged files
  • Implement skip-unchanged logic in merge tool to prevent unnecessary file writes when content hasn't changed
  • Add comprehensive property-based tests for deterministic output validation
  • Add tests for skip-unchanged behavior in merge operations
  • Add design specification and requirements documentation for deterministic output feature
  • Ensures identical OpenAPI output across multiple runs with identical input, improving build reproducibility

- Add OpenApiDocumentSorter utility to enforce consistent ordering of all OpenAPI collections (paths, schemas, operations, responses, etc.)
- Implement deterministic sorting rules: alphabetical for most collections, HTTP method order for operations, numeric for status codes
- Update OpenApiMerger to sort documents before returning merged results
- Update OpenApiSpecGenerator with sorting logic in separate partial class for maintainability
- Add --force flag to MergeCommand to allow overwriting unchanged files
- Implement skip-unchanged logic in merge tool to prevent unnecessary file writes when content hasn't changed
- Add comprehensive property-based tests for deterministic output validation
- Add tests for skip-unchanged behavior in merge operations
- Add design specification and requirements documentation for deterministic output feature
- Ensures identical OpenAPI output across multiple runs with identical input, improving build reproducibility
- Add deterministic output documentation with comprehensive sorting details
- Paths, schemas, properties, tags, and security schemes now sorted alphabetically
- Operations sorted by HTTP method order for consistency
- Responses sorted by status code in ascending order
- Examples sorted alphabetically by name
- Add skip unchanged output feature documentation for merge tool
- New `--force` flag to override skip behavior
- Verbose logging for skipped files
- Document API changes to `OpenApiMerger.Merge()` for sorted output
- Document source generator sorting behavior for deterministic serialization
@dguisinger dguisinger merged commit a3f1df4 into develop Dec 30, 2025
6 of 7 checks passed
@dguisinger dguisinger deleted the feature/deterministic-openapi-specs branch December 30, 2025 07:10
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