Skip to content
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

Fixing error in lastModifiedAt description #12854

Merged
merged 3 commits into from
Feb 10, 2021

Conversation

jennyhunter-msft
Copy link
Member

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.

  1. 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
  2. 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
  3. When you expect to publish swagger? N/A
  4. 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:

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
Copy link

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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 4, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️️✔️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
    Copy link

    openapi-pipeline-app bot commented Feb 4, 2021

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

    @openapi-workflow-bot
    Copy link

    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.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @jennyhunter-msft
    Copy link
    Member Author

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

    @jennyhunter-msft
    Copy link
    Member Author

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

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM

    @ArcturusZhang
    Copy link
    Member

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

    @@ -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)."
    Copy link
    Contributor

    @akning-ms akning-ms Feb 8, 2021

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

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

    Copy link
    Member Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Done

    Updated the description for lastModifiedAt to address a typo
    Updated the lastModifiedAt text to align with other documented sources
    @jennyhunter-msft
    Copy link
    Member Author

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

    @akning-ms akning-ms assigned akning-ms and unassigned ArcturusZhang Feb 10, 2021
    @akning-ms akning-ms merged commit 56a09bd into Azure:master Feb 10, 2021
    iscai-msft added a commit to iscai-msft/azure-rest-api-specs that referenced this pull request Feb 10, 2021
    …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)
      ...
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * 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
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants