[FE] comparison between oas 3.1 and 3.0 Priority 1 features

[zloiadil]

Here the compatibility suite for oas 3.1 vs 3.0 of all Priority 1 features in oas 3.1

Cases for compatibility suite - compatibility-suite-oas3.0vsoas3.1-1-priority.xlsx

test data - oas 3.0 vs oas 3.1.zip

[b41ex]

Most of the cases duplicates existing cases in the compatiblity suite, with added twist that openapi version itself is changed.
I really don't like the idea of manually creating a copies of corresponding cases just for this purpose, it will add a lot of work, will be a constant source of discrepancies and will quickly become unmanageable.

I propose following approach for handling OAS 3.0 to 3.1 comparison:

1. For base cases that make sense to test in different combinations of OAS versions- let's explicitly document it in this way, i.e. add a column with before/after versions combinations that should be tested for this samples (e.g. 3.0.0/3.0.0, 3.0.0/3.1.0). If more than one combination should be tested- there should be several entries.
2. By default, if no separate version combinations are provided, we will use the versions specified in the samples themselves.
3. If version combinations are explicitly provided- we will come up with the automated way to test all specified OAS version combinations for corresponding case (i.e. we will replace openapi property values in the samples to a given ones and perform tests). I assume that for any given combination the ER should be the same, don't know cases that contradict this assumption.
4. In context of 3.0 to 3.1 comparison new cases should be added to compatibility suite only for very specific situations where it is essential that we are comparing specifically 3.0 to 3.1. I envision it will only be cases of different language construct equivalency between 3.0 and 3.1 (example is nullable-equivalent-to-null)

So, given the above we need to do the following:

1. Add additional version combination information for existing cases in compatibility suite. Given the default behaviour (item 2 above), it is not necessary to add this information for all cases at once, let us start with existing cases for OAS 3.1 in comatibility suite and add version combination information for them.
2. Add specific 3.0 to 3.1 cases to the compatibility suite. For the OAS priority 1 features, I actually see just 2 cases to be added: nullable-equivalent-to-null and union-type-equivalent-to-any-of.

General notes:

1. Name the files with the samples just before.yaml and after.yaml, no need to include case name (we will have to remove it anywhay, when copying to compatibility suite).
2. Try to minimize samples- non need to include 2 identical changes in the compatibility suite spec.

compatibility-suite-oas3.0vsoas3.1-1-priority_albo.xlsx

[zloiadil]

Hi @b41ex
Updated cases and test data

1 priority metadata.zip
1_priority.xlsx

[vOrigins]

Finalization Plan

• Remove incorrect metadata combinations
• Fix samples for specific cases: nullable-equivalent-to-null and union-type-equivalent-to-any-of
• Add deletion of old test and story files before generating new ones in apispec-view
• Align test and story file names with screenshot names in apispec-view
• Ensure there are no failing tests in api-diff and regenerate screenshots in apispec-view
• Rework compareFilesArgs[3]
• Create wrapper/replacement for test.each
• Remove bin and LICENSE from publishing and postinstall from scripts in compatibility-suites
• Verify that tests run correctly on CI
  • api-diff (only unit no compatibility suiets): 92 skipped, 5146 passed, 5238 total https://github.com/Netcracker/qubership-apihub-api-diff/actions/runs/20750866947
  • doc-viewer: 149 passed, 149 total https://github.com/Netcracker/qubership-apihub-api-doc-viewer/actions/runs/20751631146
  • apispec-view: 639 passed, 639 total https://github.com/Netcracker/qubership-apihub-apispec-view/actions/runs/20759030130 ⚠️sometimes Snapshots: 581 passed, 581 total (fixed in [FE] Fix CI screenshot tests: snapshot counter mismatch on retries + false-green (exit code 0 on failures) #486)
• Ensure the UI builds successfully https://github.com/Netcracker/qubership-apihub-ui/actions/runs/20752242138
• Run UI tests https://github.com/Netcracker/qubership-apihub/actions/runs/20788797599
• Review and refactoring

[vOrigins]

Additional Changes

• Added 36 missing metadata files for 3.1-3.1 cases
• Removed 3.0-3.0 combinations for add-union-type
• Removed 3.0-3.1 and 3.1-3.1 combinations for mark-schema-value-as-non-nullable and mark-schema-value-as-nullable