-
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
Microsoft.HealthcareApis EventGrid Spec #17400
Conversation
Hi, @kannanMSFT 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. [email protected] |
[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 |
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 |
️❌
Avocado: 3 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/fhir_resource_created.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/fhir_resource_deleted.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/fhir_resource_updated.json |
️️✔️
~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
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).
Swagger Generation Artifacts
|
Hi @kannanMSFT, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...fication/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json
Outdated
Show resolved
Hide resolved
...id/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/fhir_resource_created.json
Outdated
Show resolved
Hide resolved
...id/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/fhir_resource_created.json
Outdated
Show resolved
Hide resolved
...fication/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json
Outdated
Show resolved
Hide resolved
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.
Looks good overall, put a few minor comments.
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.
Looks good to me.
Hi, @kannanMSFT. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Keeping PR alive. |
Hi, @kannanMSFT. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
* Swagger spec for HealthcareApi Events * Fix style issues with prettier * Add entry for Microsoft.HealthcareApis * Fix entry for Microsoft.HealthcareApis * Change property type names to camelcase in HealthcareApis.json * Chance the properties to camelCase * Changed the schema version for HealthcareApis.json to match the event grid * Modify readme * Rename example resource created file * Rename example files * Revert package-lock.json to earlier version * Address PR review comments-1 * Move common properties to FhirResourceEventBaseProperties
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
What's the purpose of the update?
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
Mar 2022
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
Feb 2022
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.