[Azure Monitor Health Models - Azure Monitor Health Models] API Review - Githubissues

Azure / azure-rest-api-specs

The source for REST API specifications for Microsoft Azure.

MIT License

2.52k stars 4.94k forks source link

[Azure Monitor Health Models - Azure Monitor Health Models] API Review #27784

Open azure-sdk opened 5 months ago

azure-sdk commented 5 months ago

New API Review meeting has been requested.

Service Name: Azure Monitor Health Models - Azure Monitor Health Models Review Created By: Vipul Kashyap Review Date: 03/06/2024 09:00 AM PT Onboarding Record: https://dev.azure.com/azure-sdk/Release/_workitems/edit/20249 PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description:

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 5 months ago

Meeting updated by Vipul Kashyap

Service Name: Azure Monitor Health Models - Azure Monitor Health Models Review Created By: Vipul Kashyap Review Date: 03/06/2024 09:00 AM PT Onboarding Record: https://dev.azure.com/azure-sdk/Release/_workitems/edit/20249 PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description:

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 4 months ago

Meeting updated by Vipul Kashyap

Service Name: Azure Monitor Health Models - Azure Monitor Health Models Review Created By: Vipul Kashyap Review Date: 03/06/2024 09:00 AM PT Release Plan: [[Release Plan ID]]([Release Plan Link]) PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description:

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 4 months ago

Meeting updated by Vipul Kashyap

Service Name: Azure Monitor Health Models - Azure Monitor Health Models Review Created By: Vipul Kashyap Review Date: 03/14/2024 04:00 PM PT Release Plan: [[Release Plan ID]]([Release Plan Link]) PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description:

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 4 months ago

Meeting updated by Vipul Kashyap

Service Name: Azure Monitor Health Models - Azure Monitor Health Models Review Created By: Vipul Kashyap Review Date: 03/20/2024 09:00 AM PT Release Plan: 1203 PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description:

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 4 months ago

Meeting updated by Vipul Kashyap

Service Name: Azure Monitor Health Models - Azure Monitor Health Models Review Created By: Vipul Kashyap Review Date: 03/27/2024 09:00 AM PT Release Plan: 1203 PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided

Description:

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

DominikMe commented 3 months ago

Notes from review on 2024/03/27, courtesy of @thsackos

Update timestamp properties to be of the form createdAt or lastTransitionedAt instead of "CreatedTime", "LastTransitionTime" etc. Add UTC to documentation.
Entity name must be case sensitive, because path segments are case sensitive by RFC.
Kind can be set to string Enum. Gives users more predictable experience. The values are open ended, so customers can use it however needed and we can give them some reasonable defaults.
Location id - We need to think about how customers will use it. If users are expected to be able to parse and work with this value, we may need to make the API contract more structured for standard use cases. property state has type HealthStatus we should converge terminology here.
Property state should not be nullable, it can default to unknown.
May make sense for labels to default to empty instead of null. But OK to be nullable (missing when sent over the wire) as well.
Documentation description uses different terminology than the values themselves (e.g. "propegate as is" for value "Standard"). Can converge these values.
For evidence, more examples in the documentation for what expected values and scenarios will be surfaced.
For SDK generation, generic names like "Entity" and "Relationship" should get changed to "HealthModelEntity", "HealthModelRelationship" or similar in the client.tsp (or directly in the model.tsp)

Nothing blocking the private preview. It was discussed to abort the PR and instead keep the data-plane tsp in a feature branch on the private specs repo.