Fixing error in lastModifiedAt description #12854

jennyhunter-msft · 2021-02-04T17:42:52Z

In response to Issue #12712, fixing the error in the description of the lastModifiedAt systemData property

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify: Fixing error in RPC property description
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet. N/A
When you expect to publish swagger? N/A
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
[N/A] I have reviewed the documentation for the workflow.
[N/A ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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.

In response to Issue Azure#12712, fixing the error in the description of the lastModifiedAt systemData property

openapi-workflow-bot · 2021-02-04T17:42:54Z

Hi, @jennyhunter-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-02-04T17:42:56Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

Compared Swaggers (Based on Oad v0.8.6)
- original: resource-management/v1/types.json <---> new: resource-management/v1/types.json
- original: resource-management/v2/types.json <---> new: resource-management/v2/types.json

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️❌Avocado: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: specification/common-types/resource-management/v1
`❌` MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: specification/common-types/resource-management/v2

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-02-04T17:42:56Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

openapi-workflow-bot · 2021-02-04T17:44:54Z

Hi @jennyhunter-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

jennyhunter-msft · 2021-02-04T17:56:11Z

This change does not include any new or change any existing APIs and should not need a Swagger.

jennyhunter-msft · 2021-02-04T18:30:38Z

@ArcturusZhang, Let me know if you need anything more from my side.

ArcturusZhang

LGTM

ArcturusZhang · 2021-02-08T06:39:38Z

@ruowan could you take a look at the Avocado failure? It looks like an expected failure, do we need to force-merge this?

akning-ms · 2021-02-08T07:51:51Z

specification/common-types/resource-management/v2/types.json

@@ -496,7 +496,7 @@
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time",
-          "description": "The type of identity that last modified the resource."
+          "description": "The timestamp when the resource was last modified (UTC)."


Hi @jennyhunter-msft, Can you also fix the same error in v1/types.json?

Updated the description for lastModifiedAt to address a typo

Updated the lastModifiedAt text to align with other documented sources

jennyhunter-msft · 2021-02-08T18:47:21Z

Updated the v1 description and updated the v2 to use the same wording found in other documentation about this property

…into fix_resource_multiapi_submodule * 'master' of https://github.com/Azure/azure-rest-api-specs: (452 commits) Dev cost management microsoft.cost management 2020 12 01 preview new (Azure#12259) Edit securityContact swagger for 2020-01-01 (Azure#12265) [Hub Generated] Review request for Microsoft.Insights to add version stable/2020-10-01 (Azure#11579) [Hub Generated] Review request for Microsoft.Media to add version stable/2020-05-01 (Azure#12681) Fix TimeSeriesInsights swagger issues (Azure#12204) Fixing error in lastModifiedAt description (Azure#12854) Update comment.yml (Azure#12910) Fixing RI s360 Flagged corrections in 2019-10-01 version (Azure#12777) [Hub Generated] Review request for Microsoft.Web to add version stable/2020-10-01 (Azure#11636) [Ready For Review] New version 20210101 (Azure#12111) Update scheduledQueryRule_API.json (Azure#12895) Remove UserAssigned MSI (Azure#12900) Update library.json (Azure#12922) KeyVault: Feature/update security domain spec (Azure#12863) Fixes ExampleId type and incorrect ArmTokenParameter name (Azure#12896) Update contract for anomaly detector (Azure#12487) [NetAppFiles] Urgent bug fix, backup response, remove systemData(not in response yet) (Azure#12852) [AML] Add PipelineEndpoint with version and DataPathAssignments fields in AzureMLExecutePipeline (Azure#12744) remove duplicated schema (Azure#12779) [Web] Add Swagger for Service Principal (Azure#12780) ...

* Fixing error in lastModifiedAt description In response to Issue Azure#12712, fixing the error in the description of the lastModifiedAt systemData property * Updated v1 types.json to fix lastModifiedAt typo Updated the description for lastModifiedAt to address a typo * Updated lastModifiedAt text for alignment Updated the lastModifiedAt text to align with other documented sources

Fixing error in lastModifiedAt description

298dfe4

In response to Issue Azure#12712, fixing the error in the description of the lastModifiedAt systemData property

openapi-assignment-bot bot assigned ArcturusZhang Feb 4, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Feb 4, 2021

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Feb 4, 2021

ArcturusZhang approved these changes Feb 8, 2021

View reviewed changes

akning-ms reviewed Feb 8, 2021

View reviewed changes

jennyhunter-msft added 2 commits February 8, 2021 10:44

Updated v1 types.json to fix lastModifiedAt typo

d5e07c4

Updated the description for lastModifiedAt to address a typo

Updated lastModifiedAt text for alignment

5f65245

Updated the lastModifiedAt text to align with other documented sources

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Feb 8, 2021

akning-ms assigned akning-ms and unassigned ArcturusZhang Feb 10, 2021

akning-ms merged commit 56a09bd into Azure:master Feb 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing error in lastModifiedAt description #12854

Fixing error in lastModifiedAt description #12854

jennyhunter-msft commented Feb 4, 2021

openapi-workflow-bot bot commented Feb 4, 2021

openapi-pipeline-app bot commented Feb 4, 2021 •

edited

Loading

openapi-pipeline-app bot commented Feb 4, 2021 •

edited

Loading

openapi-workflow-bot bot commented Feb 4, 2021

jennyhunter-msft commented Feb 4, 2021

jennyhunter-msft commented Feb 4, 2021

ArcturusZhang left a comment

ArcturusZhang commented Feb 8, 2021

akning-ms Feb 8, 2021 •

edited

Loading

jennyhunter-msft Feb 8, 2021

jennyhunter-msft commented Feb 8, 2021

Fixing error in lastModifiedAt description #12854

Fixing error in lastModifiedAt description #12854

Conversation

jennyhunter-msft commented Feb 4, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Feb 4, 2021

openapi-pipeline-app bot commented Feb 4, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Feb 4, 2021 • edited Loading

openapi-workflow-bot bot commented Feb 4, 2021

jennyhunter-msft commented Feb 4, 2021

jennyhunter-msft commented Feb 4, 2021

ArcturusZhang left a comment

Choose a reason for hiding this comment

ArcturusZhang commented Feb 8, 2021

akning-ms Feb 8, 2021 • edited Loading

Choose a reason for hiding this comment

jennyhunter-msft Feb 8, 2021

Choose a reason for hiding this comment

jennyhunter-msft commented Feb 8, 2021

openapi-pipeline-app bot commented Feb 4, 2021 •

edited

Loading

openapi-pipeline-app bot commented Feb 4, 2021 •

edited

Loading

akning-ms Feb 8, 2021 •

edited

Loading