[CI][API][Docs] Added API docs freshness check

[igormukhingmailcom]

Fixes #9223
Related: #9197

Screenshots

When openemr-api.yml is in sync with codebase

When openemr-api.yml is not in sync with codebase - job fail

Short description of what this resolves:

Fails when docs not refreshed after code changes.

Does your code include anything generated by an AI Engine? No

[kojiromike]

See #9351

[igormukhingmailcom]

@kojiromike Thanks for that fix :)
Now this PR is ready for merging

[kojiromike]

I don't understand why there's so much whitespace here.

[igormukhingmailcom]

Looks good to me. What exactly wrong?

[kojiromike]

@igormukhingmailcom there's a - for a list entry, then a newline and a bunch more indentation, then { for object entry, then a bunch of space, then }. IMO it should be:

          - openemr_auth: {}

[igormukhingmailcom]

The only issue here is that array ([]) somehow converted to object ({}) during normalization, but http://localhost:8300/swagger/ still renders well even with that issue.

New lines are not an issue - it was like that before (normalizer was introduced) as well. Just the way formatter formats things to have same level keys aligned.

See diff at https://github.com/openemr/openemr/pull/9197/files when normalization was introduced:

[codecov]

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
1393	1	1392	49

View the full list of 2 ❄️ flaky test(s)

OpenEMR.Tests.Unit.Common.Crypto.CryptoGenTest::testCustomPasswordHmacFailure

Flake rate in main: 14.29% (Passed 6 times, Failed 1 times)

Stack Traces | 0.364s run time

OpenEMR\Tests\Unit\Common\Crypto\CryptoGenTest::testCustomPasswordHmacFailure
Failed asserting that 'test data' is false.

.../Common/Crypto/CryptoGenTest.php:565

OpenEMR.Tests.Unit.Common.Crypto.CryptoGenTest::testHmacValidationFailure

Flake rate in main: 50.00% (Passed 1 times, Failed 1 times)

Stack Traces | 0.00193s run time

OpenEMR\Tests\Unit\Common\Crypto\CryptoGenTest::testHmacValidationFailure
Failed asserting that 'test data' is false.

.../Common/Crypto/CryptoGenTest.php:545

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}