New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ManagedCCF: Resolving mismatches with existing API specification #27826

Open

eddyashton wants to merge 10 commits into Azure:main from eddyashton:update_mccf_spec

Open

ManagedCCF: Resolving mismatches with existing API specification #27826

lol

openapi-pipeline-app / Swagger BreakingChange completed Jul 1, 2024 in 4m 37s

Check `Swagger BreakingChange` detected problems

Detected: 16 Errors, 0 Warnings
The check status is neutral due to the check being suppressed by a label matching pattern BreakingChange-Approved-*.
View Azure DevOps build log for more details.

Important

To see the full list of breaking changes messages, with all the details available:
In the relevant ADO build (see the link above), find the job BreakingChange, then the task within, also called BreakingChange.
In the task's build log, search for Full list of messages.

Details

Compared specs (v0.10.12)	new version	base version
mccfgov.json	2023-06-01-preview(6484eb9)	2023-06-01-preview(main)

`❌` 1017 - ReferenceRedirection

Displaying 2 out of 2 occurrences.

Index	Description
1	The '$ref' property points to different models in the old and new versions. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2000:9 `definitions['ServiceState.ServiceInfo'].properties.previousServiceCreationTransactionId` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1950:9
2	The '$ref' property points to different models in the old and new versions. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2117:11 `definitions['ServiceState.SnpJoinPolicy'].properties.uvmEndorsements.additionalProperties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2067:11

`❌` 1021 - AddedAdditionalProperties

Displaying 1 out of 1 occurrences.

Index	Description
1	The new version adds an 'additionalProperties' element. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2117:11 `definitions['ServiceState.SnpJoinPolicy'].properties.uvmEndorsements.additionalProperties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2067:11

`❌` 1023 - TypeFormatChanged

Displaying 1 out of 1 occurrences.

Index	Description
1	The new version has a different format '' than the previous one 'byte'. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2117:11 `definitions['ServiceState.SnpJoinPolicy'].properties.uvmEndorsements.additionalProperties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2067:11

`❌` 1026 - TypeChanged

Displaying 1 out of 1 occurrences.

Index	Description
1	The new version has a different type 'object' than the previous one 'string'. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2117:11 `definitions['ServiceState.SnpJoinPolicy'].properties.uvmEndorsements.additionalProperties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2067:11

`❌` 1033 - RemovedProperty

Displaying 1 out of 1 occurrences.

Index	Description
1	The new version is missing a property found in the old version. Was 'digest' renamed or removed? New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1166:7 `definitions['Acks.StateDigest'].properties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1166:7

`❌` 1034 - AddedRequiredProperty

Displaying 8 out of 8 occurrences.

Index	Description
1	The new version lists new non-read-only properties as required: 'keys'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1735:5 `definitions['ServiceState.JwkInfo']` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1697:5
2	The new version lists new non-read-only properties as required: 'keys'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1738:7 `definitions['ServiceState.JwkInfo'].properties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1700:7
3	The new version lists new non-read-only properties as required: 'keys'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L856:13 `paths./gov/service/jwk.get.responses.200.schema` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L856:13
4	The new version lists new non-read-only properties as required: 'memberId, stateDigest'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1163:5 `definitions['Acks.StateDigest']` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1163:5
5	The new version lists new non-read-only properties as required: 'memberId, stateDigest'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L431:13 `paths./gov/members/state-digests/{memberId}:update.post.responses.200.schema` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L431:13
6	The new version lists new non-read-only properties as required: 'memberId, stateDigest'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L536:13 `paths./gov/members/state-digests/{memberId}.get.responses.200.schema` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L536:13
7	The new version lists new non-read-only properties as required: 'memberId'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1166:7 `definitions['Acks.StateDigest'].properties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1166:7
8	The new version lists new non-read-only properties as required: 'stateDigest'. These properties were not listed as required in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1166:7 `definitions['Acks.StateDigest'].properties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1166:7

`❌` 1036 - ConstraintChanged

Displaying 1 out of 1 occurrences.

Index	Description
1	The new version has a different 'pattern' value than the previous one. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2000:9 `definitions['ServiceState.ServiceInfo'].properties.previousServiceCreationTransactionId` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1950:9

`❌` 1041 - AddedPropertyInResponse

Displaying 1 out of 1 occurrences.

Index	Description
1	The new version has a new property 'publicEncryptionKey' in response that was not found in the old version. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1823:7 `definitions['ServiceState.Member'].properties` Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1777:7

💬 1001 - NoVersionChange

Displaying 1 out of 1 occurrences.

Index	Description
1	The versions have not changed. New: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1:1 Old: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1:1

View more details on openapi-pipeline-app