including all json files and examples for system topics introduced by ARN#25848
Merged
lmazuel merged 35 commits intoAzure:mainfrom Sep 29, 2023
Supriya-R-Dixit:sdixit/azureResourceNotifications
Merged
including all json files and examples for system topics introduced by ARN#25848lmazuel merged 35 commits intoAzure:mainfrom Supriya-R-Dixit:sdixit/azureResourceNotifications
lmazuel merged 35 commits intoAzure:mainfrom
Supriya-R-Dixit:sdixit/azureResourceNotifications
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| compared tags (via openapi-validator v2.1.5) | new version | base version |
|---|---|---|
| package-2023-06-01-preview | package-2023-06-01-preview(d253b82) | package-2023-06-01-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Property should have a defined type. Location: Microsoft.ResourceNotifications/stable/2018-01-01/common.json#L37 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️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
|
Generated ApiView
|
|
Hi @Supriya-R-Dixit! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
…m/Supriya-R-Dixit/azure-rest-api-specs into sdixit/azureResourceNotifications
.../eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json
Outdated
Show resolved
Hide resolved
...stable/2018-01-01/examples/event-grid-schema/MaintenanceResources_ScheduledEventEmitted.json
Outdated
Show resolved
Hide resolved
...tgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/MaintenanceResources.json
Outdated
Show resolved
Hide resolved
...cation/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json
Outdated
Show resolved
Hide resolved
...cation/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json
Outdated
Show resolved
Hide resolved
| - $(this-folder)/Microsoft.ResourceNotifications/stable/2018-01-01/Resources.json | ||
| - $(this-folder)/Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json | ||
| - $(this-folder)/Microsoft.ResourceNotifications/stable/2018-01-01/MaintenanceResources.json | ||
|
|
Member
There was a problem hiding this comment.
nit: remove extra line breaks
...ification/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/common.json
Outdated
Show resolved
Hide resolved
...ification/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/common.json
Outdated
Show resolved
Hide resolved
...ification/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/common.json
Show resolved
Hide resolved
...ification/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/common.json
Outdated
Show resolved
Hide resolved
are not going public preview by 9/30
| "swagger": "2.0", | ||
| "info": { | ||
| "version": "2018-01-01", | ||
| "title": "Schema of Azure Resource Management events published to Azure Event Grid via Azure Resource Notifications", |
There was a problem hiding this comment.
this should be pointing to health resources.
.../eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json
Show resolved
Hide resolved
...ification/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/common.json
Outdated
Show resolved
Hide resolved
...ification/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/common.json
Outdated
Show resolved
Hide resolved
...ification/eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/common.json
Outdated
Show resolved
Hide resolved
not currently needed
.../eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json
Outdated
Show resolved
Hide resolved
.../eventgrid/data-plane/Microsoft.ResourceNotifications/stable/2018-01-01/HealthResources.json
Outdated
Show resolved
Hide resolved
JoshLove-msft
approved these changes
Sep 29, 2023
Member
JoshLove-msft
left a comment
JoshLove-msft
left a comment
There was a problem hiding this comment.
Looks great! Thanks @Supriya-R-Dixit!
Kishp01
approved these changes
Sep 29, 2023
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
… ARN (#25848) * including all json and examples for system topics introduced by ARN * amended the readme file to include the json files for topic types * including all json files * included references to example json files * corrected the examles folder name * made changes to resources.json * included common.json for common properties across all ARN event types * testing $ref * testing $ref * changed $ref and braces around apiVersion * changed "DateTime" to "dateTime" * fixed dateTime * dateTime need a pattern with string * included format property for resourceeventtime * created a common properties event for deleted events * corrected the extra comma * fixed prettier formatting * corrected additionalproperties * added cloud event schema samples * renamed cloud events schema folder * changes to cloud event schema folder * included example for availability status changed under cloud events schema folder * ensured the eventdata has a verb in it * removed "azure" from the common events naming * changed names of the base event defintions * removed the type filed under additional properties * updated base event type names as suggested by reviewer * removed files related to resources and maintenance resources as they are not going public preview by 9/30 * removed references to maintenance and resources jsons * modified the base event structure according to feedback * fixed formatting issues. * edited description an description and removed few base events which are not currently needed * changed naming of the base event type as per feedback from Josh Love
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
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.
Is this review for (select one):
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.
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 ApiViewcomment 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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links