azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Purview - API Scanning] API Review 2022-07-02-preview
[Purview - API Scanning] API Review
PR #19797 Planning on reservice this time slot. I will send a meeting invite to azureapirbcore and azure-restapi-int if you don’t see any issues with the time slots. Other information regarding the PR/Service
- Service name: Purview-Scanning
- Key Contact(s): @Phani Kumar Vadali, @Cala Zubair
- New or Existing API: New API endpoints to an existing service
- Deployment: Service is already deployed, and these new endpoints are in use in production from UX
- This change facilitates UX and customers to execute CRUD operations for IntegrationRuntimes and ManagedVirtualNetworks. Right now, UI calls a different Azure service (Azure Data Factory) for executing these operations. Switching over to calling Purview-Scanning will allow us to intercept request/response routing to Azure Data Factory and return Purview specific models/json-responses to the caller
- Link to PR: https://github.com/Azure/azure-rest-api-specs/pull/19797 Please let me know if anything else is missing.
API REVIEWS
- [x] Review session 27-07-2022
- [ ] Review session 18-08-2022
Status update on 7/27 I just had my review meeting with @Mark Weitzel and team. • API paths are not consistent across the service. • Polymorphic types do not follow pattern that needs to be followed. • Long running jobs such as InteractiveQuery do not return correct HTTP status. • Overall, there is a need for a full revisit of Scanning (and other Purview) services.
Next steps: I will reserve another slot with the stewardship team with all the stakeholders involved, once @Naga Krishna Yenamandra arrives, i.e, with @Shawn Xiao (IM)’ s team, @Philip Liu’s team, @Naga Krishna Yenamandra and myself.
@pvadali-az -- Please review the Azure REST API Style Guidelines. In those guidelines you find a helpful utility that we've been experimenting with, Spectral. Running this within VS Code will help you identify many of the correctness issues that should be addressed, e.g.
- Schema should have a description or title
- Parameter should have a description.
- value property in pageable response should be required
