-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Channel Archive Heartbeat event #15885
Add Channel Archive Heartbeat event #15885
Conversation
Hi, @Sanjidhalim Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
R2056 - RequiredReadOnlyProperties |
Property 'channelLatencyMs' is a required property. It should not be marked as 'readonly'. Location: Microsoft.Media/stable/2018-01-01/MediaServices.json#L993 |
R2056 - RequiredReadOnlyProperties |
Property 'latencyResultCode' is a required property. It should not be marked as 'readonly'. Location: Microsoft.Media/stable/2018-01-01/MediaServices.json#L998 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Id', for definition: 'KeyVaultCertificateNewVersionCreatedEventData' must follow camelCase style. Example: 'id'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L14 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'VaultName', for definition: 'KeyVaultCertificateNewVersionCreatedEventData' must follow camelCase style. Example: 'vaultName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L18 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectType', for definition: 'KeyVaultCertificateNewVersionCreatedEventData' must follow camelCase style. Example: 'objectType'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L22 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectName', for definition: 'KeyVaultCertificateNewVersionCreatedEventData' must follow camelCase style. Example: 'objectName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L26 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Version', for definition: 'KeyVaultCertificateNewVersionCreatedEventData' must follow camelCase style. Example: 'version'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L30 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'NBF', for definition: 'KeyVaultCertificateNewVersionCreatedEventData' must follow camelCase style. Example: 'nbf'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L34 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'EXP', for definition: 'KeyVaultCertificateNewVersionCreatedEventData' must follow camelCase style. Example: 'exp'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L38 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Id', for definition: 'KeyVaultCertificateNearExpiryEventData' must follow camelCase style. Example: 'id'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L48 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'VaultName', for definition: 'KeyVaultCertificateNearExpiryEventData' must follow camelCase style. Example: 'vaultName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L52 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectType', for definition: 'KeyVaultCertificateNearExpiryEventData' must follow camelCase style. Example: 'objectType'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L56 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectName', for definition: 'KeyVaultCertificateNearExpiryEventData' must follow camelCase style. Example: 'objectName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L60 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Version', for definition: 'KeyVaultCertificateNearExpiryEventData' must follow camelCase style. Example: 'version'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L64 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'NBF', for definition: 'KeyVaultCertificateNearExpiryEventData' must follow camelCase style. Example: 'nbf'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L68 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'EXP', for definition: 'KeyVaultCertificateNearExpiryEventData' must follow camelCase style. Example: 'exp'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L72 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Id', for definition: 'KeyVaultCertificateExpiredEventData' must follow camelCase style. Example: 'id'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L82 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'VaultName', for definition: 'KeyVaultCertificateExpiredEventData' must follow camelCase style. Example: 'vaultName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L86 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectType', for definition: 'KeyVaultCertificateExpiredEventData' must follow camelCase style. Example: 'objectType'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L90 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectName', for definition: 'KeyVaultCertificateExpiredEventData' must follow camelCase style. Example: 'objectName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L94 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Version', for definition: 'KeyVaultCertificateExpiredEventData' must follow camelCase style. Example: 'version'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L98 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'NBF', for definition: 'KeyVaultCertificateExpiredEventData' must follow camelCase style. Example: 'nbf'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L102 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'EXP', for definition: 'KeyVaultCertificateExpiredEventData' must follow camelCase style. Example: 'exp'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L106 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Id', for definition: 'KeyVaultKeyNewVersionCreatedEventData' must follow camelCase style. Example: 'id'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L116 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'VaultName', for definition: 'KeyVaultKeyNewVersionCreatedEventData' must follow camelCase style. Example: 'vaultName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L120 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectType', for definition: 'KeyVaultKeyNewVersionCreatedEventData' must follow camelCase style. Example: 'objectType'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L124 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'ObjectName', for definition: 'KeyVaultKeyNewVersionCreatedEventData' must follow camelCase style. Example: 'objectName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L128 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Version', for definition: 'KeyVaultKeyNewVersionCreatedEventData' must follow camelCase style. Example: 'version'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L132 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'NBF', for definition: 'KeyVaultKeyNewVersionCreatedEventData' must follow camelCase style. Example: 'nbf'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L136 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'EXP', for definition: 'KeyVaultKeyNewVersionCreatedEventData' must follow camelCase style. Example: 'exp'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L140 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Id', for definition: 'KeyVaultKeyNearExpiryEventData' must follow camelCase style. Example: 'id'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L150 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'VaultName', for definition: 'KeyVaultKeyNearExpiryEventData' must follow camelCase style. Example: 'vaultName'. Location: Microsoft.KeyVault/stable/2018-01-01/KeyVault.json#L154 |
️❌
Avocado: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
UNREFERENCED_JSON_FILE |
The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: stable/2018-01-01/examples/MediaLiveEventChannelArchiveHeartbeatEvent.json |
UNREFERENCED_JSON_FILE |
The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: stable/2018-01-01/examples/MediaLiveEventIngestHeartbeatEvent.json |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️❌
SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
OAV131 |
discriminator must be a required property. |
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️🔄
CredScan inProgress [Detail]
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
AutorestCore/Exception |
"readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"Error: Semantic validation failed. There was some errors" |
️❌
[Staging] PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Code style issues found path: Microsoft.Media/stable/2018-01-01/MediaServices.json |
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
Hi @Sanjidhalim, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @Sanjidhalim, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json
Outdated
Show resolved
Hide resolved
Please add an example for the new event as per https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/data-plane#guidelines-for-defining-a-new-event |
* Add Channel Archive Heartbeat event * Removed added "required" field which caused validation errors. * Added examples for the new/updated events. Co-authored-by: Xueping Deng <xuepingd@microsoft.com>
@@ -924,7 +944,7 @@ | |||
} | |||
}, | |||
"type": "object", | |||
"description": "Ingest fragment dropped event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeat event." | |||
"description": "Ingest heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeatEventData event." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need some clarity here -
Did the event name change from LiveEventIngestHeartbeat
to LiveEventIngestHeartbeatEventData
? Or, is it just a documentation error?
cc: @Sanjidhalim
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Event name should not have changed. Seems like a documentation error. @xuepingd is driving the PR right now. She can correct this
* Add Channel Archive Heartbeat event * Removed added "required" field which caused validation errors. * Added examples for the new/updated events. Co-authored-by: Xueping Deng <xuepingd@microsoft.com>
Add Channel Archive Heartbeat event and sync with swagger at https://msazure.visualstudio.com/DefaultCollection/One/_git/AAPT-Media-Telemetry?path=%2Fsrc%2FEventGridContracts%2FMediaServices.json