azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
ManagedCCF: Resolving mismatches with existing API specification
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.
- Link to API Spec engagement record issue: #23157
Is this review for (select one):
- [ ] a private preview
- [X] a public preview
- [ ] GA release
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.
- Design Document: Issue tracking mismatches https://github.com/microsoft/CCF/issues/5691
- Previous API Spec Doc: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json
- Updated paths:
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 ofmemberId
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment 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.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
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.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 16 Errors, 0 Warnings failed [Detail]
| 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 |
|---|---|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L80 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L134 |
| :warning: PageableOperation | 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 |
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L178 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L185 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L239 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L247 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L305 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L313 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L416 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L473 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L524 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L575 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L622 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L941 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1038 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength). Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1089 |
| :warning: PropertyType | Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1320 |
| :warning: EnumInsteadOfBoolean | 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 |
| :warning: EnumInsteadOfBoolean | 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 |
| :warning: PropertyType | Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1832 |
| :warning: PropertyType | Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L1904 |
| :warning: EnumInsteadOfBoolean | 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 |
| :warning: PropertyType | Property should have a defined type. Location: Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json#L2004 |
| :warning: AvoidNestedProperties | 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
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.ManagedCcf | https://apiview.dev/Assemblies/Review/b8a30467546b46f6a4b1b0a63e1e3172?revisionId=2ed4a8823dfd412ca939ce7fe1139a1b |
| TypeSpec | Microsoft.ManagedCcf | https://apiview.dev/Assemblies/Review/4c726bdc52174b5bae13c71b69fac649?revisionId=123bd4b117064f419f88c7254b2898ef |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}