search

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.
MIT License
2.69k stars 5.12k forks source link

[Microsoft Azure Data Manager for Agriculture - Microsoft Azure Data Manager for Agriculture] API Review #24637

Open azure-sdk opened 1 year ago

azure-sdk commented 1 year ago

New API Review meeting has been requested.

Service Name: Microsoft Azure Data Manager for Agriculture - Microsoft Azure Data Manager for Agriculture Review Created By: Amita Pradhan Review Date: 07/13/2023 04:00 PM PT Onboarding Record: https://dev.azure.com/azure-sdk/Release/_workitems/edit/12545 PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description: We are introducing a new API Version to introduce GeoSpatial capability for resources. Few highlights on the same: 1) GeoSpatial CDM changes. 2) Breaking changes from previous API versions. 3) Removal of few APIs from previous versions. 4) Introduction of Geospatial search APIs.

Detailed meeting information and documents provided can be accessed here For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

azure-sdk commented 1 year ago

Meeting updated by Amita Pradhan

Service Name: Microsoft Azure Data Manager for Agriculture - Microsoft Azure Data Manager for Agriculture Review Created By: Amita Pradhan Review Date: 07/13/2023 04:00 PM PT Onboarding Record: https://dev.azure.com/azure-sdk/Release/_workitems/edit/12545 PR: https://github.com/Azure/azure-rest-api-specs/pull/24755 Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description: We are introducing a new API Version to introduce GeoSpatial capability for resources. Few highlights on the same: 1) GeoSpatial CDM changes. 2) Breaking changes from previous API versions. 3) Removal of few APIs from previous versions. 4) Introduction of Geospatial search APIs.

Detailed meeting information and documents provided can be accessed here For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

weidongxu-microsoft commented 1 year ago

Meeting notes:

For search API, suggest move maxPageSize and skipToken to query parameters. Then user can POST with same body, just changing the query parameter on each request URL, when they query next page. Note that in SDK you will need to write the customization for the paging implementation.

For overlap API, suggest POST /parties:overlap Body is for service to design, one possible schema below, another possibility be an array instead of first/second (so it can be extended to overlap of multiple items)

{
  first: {
    partyId,
    resourceType,
    resourceId
  },
  second: {
    partyId,
    resourceType,
    resourceId
  }
}

Suggest for consistency: /weather-data/:fetch to /weather-data:fetch.