ManagedCCF: Resolving mismatches with existing API specification #27826
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eddyashton
requested review from
bexxx and
mikekistler
and removed request for
a team
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| mccfgov.json | 2023-06-01-preview(6484eb9) | 2023-06-01-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2023-06-01-preview-mccf | package-2023-06-01-preview-mccf(6484eb9) | package-2023-06-01-preview-mccf(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L80 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L134 |
|
| Based on the response model schema, operation 'Proposals_GetActions' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L178 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L178 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L185 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L239 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L247 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L305 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L313 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L416 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L473 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L524 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L575 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L622 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L941 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1038 |
|
| Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1089 |
|
| Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1320 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1361 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1782 |
|
| Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1832 |
|
| Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1904 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1911 |
|
| Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2004 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2007 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
microsoft-github-policy-service
bot
added
the
customer-reported
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
eddyashton
changed the title
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
…into update_mccf_spec
…into update_mccf_spec
eddyashton
added
Versioning-Approved-BugFix
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
We've been tracking some minor discrepancies between the API as reported by this spec and the actual implementation. This resolves all known places where they diverge, so that this OpenAPI document (and the TypeSpec, though we're still not using that directly) accurately describes the responses produced by the service.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
GET /gov/service/info- corrected type ofpreviousServiceCreationTransactionIdresponse field (pem -> transactionId)GET /gov/service/join-policy- corrected type ofuvmEndorsementsresponse field (Record -> Record<Record>)GET /gov/membersandGET /gov/members/{memberId}- documentpublicEncryptionKeyfield in response objectGET /gov/jwk- documentkeysfield in response objectGET /gov/members/state-digests/{memberId}- corrected name of response field, and visibility ofmemberIdViewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.