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

Updated CompletedAt to LastUpdatedAt for all terminal states #28349

Conversation

GrahamMThomas
Copy link
Member

@GrahamMThomas GrahamMThomas commented Mar 20, 2024

Data Plane API - Pull Request

  • Renaming from completedAt to lastUpdatedAt.
    • This field was being used for canceled and failed states and wasn't intuitive.
  • Updates "File" model
    • Adds a subObject "FileLocation", allows for both the input and output file locations
  • Default Operation -> Surrogate
  • Removes "Unknown" Datatype

No customers are onboarded yet, API still in development, therefore no breaking changes.

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

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.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

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 ApiView comment 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

Checks stuck in `queued` state? If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.

Copy link

openapi-pipeline-app bot commented Mar 20, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Mar 20, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.0) new version base version
package-2024-01-31-preview package-2024-01-31-preview(8464c4a) package-2024-01-31-preview(release-healthdataaiservices-deidentification-2024-01-31-preview)

The following errors/warnings exist before current PR submission:

Rule Message
⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Jobs_Create' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema'
Location: HealthDataAIServices.Deidentification/preview/2024-01-31-preview/HealthDataAIServices.Deidentification.json#L213
⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: HealthDataAIServices.Deidentification/preview/2024-01-31-preview/HealthDataAIServices.Deidentification.json#L214
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️❌TypeSpecAPIView: 0 Errors, 1 Warnings failed [Detail]
Rule Message
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Mar 20, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed [Logs] Generate from 48bca3d. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g npm@10.5.0` to update!
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 141 | �[0m               �[36;1mGeneratePackage `�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 141 | �[0m               �[36;1mGeneratePackage `�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mFailed to packe sdk. exit code: False�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 807 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mCannot find path�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m�[31;1m�[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m�[31;1m�[36;1m�[31;1m�[36;1m     | �[31;1mit does not exist.�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 141 | �[0m               �[36;1mGeneratePackage `�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact�[0m
  • Azure.HealthDataAIServices.Deid [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 48bca3d. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/healthdataaiservices/HealthDataAIServices.Deidentification/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.5.0` to update!
    cmderr	[automation_generate.sh] npm notice
    warn	No file changes detected after generation
    warn	No package detected after generation
️❌ azure-sdk-for-java failed [Detail]
  • Failed [Logs] Generate from 48bca3d. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] erage Speed   Time    Time     Time  Current
    cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
    cmderr	[init.sh] 
      0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0  0   914k      0 --:--:-- --:--:-- --:--:--  914k
    cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
    cmderr	[init.sh] Computing checksum with sha256sum
    cmderr	[init.sh] Checksums matched!
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	No package detected after generation
  • azure-healthdataaiservices-deid [View full logs]  [Preview SDK Changes]
️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs] Generate from 48bca3d. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	No package detected after generation
  • ️✔️@azure-rest/azure-healthdataaiservices-deid-rest [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning [Logs] Generate from 48bca3d. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    warn		specification/healthdataaiservices/HealthDataAIServices.Deidentification/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
  • ⚠️Az.healthdataaiservices.DefaultTag [View full logs]  [Preview SDK Changes]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs] Generate from 48bca3d. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/healthdataaiservices/data-plane/HealthDataAIServices.Deidentification/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.5.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️azure-healthdataaiservices-deid [View full logs]  [Preview SDK Changes]
    info	[Changelog] data-plan skip changelog generation temporarily
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Mar 20, 2024

@GrahamMThomas GrahamMThomas requested a review from a team as a code owner March 20, 2024 16:53
@GrahamMThomas GrahamMThomas requested review from vicancy and MushMal and removed request for a team March 20, 2024 16:53
@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Mar 20, 2024
@GrahamMThomas GrahamMThomas enabled auto-merge (squash) March 21, 2024 17:07
@konrad-jamrozik
Copy link
Member

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@GrahamMThomas
Copy link
Member Author

/pr requestMerge

@GrahamMThomas GrahamMThomas merged commit 7f8c1c3 into Azure:release-healthdataaiservices-deidentification-2024-01-31-preview Mar 29, 2024
24 of 27 checks passed
GrahamMThomas added a commit to GrahamMThomas/azure-rest-api-specs that referenced this pull request May 2, 2024
…8349)

* Updated CompletedAt to LastUpdatedAt for all terminal states

* Updates examples; Moves error order

* Set examples to more realistic value

* Updates File model for future expansion

* Adds Input FileLocation

---------

Co-authored-by: Graham Thomas <gthomas@microsoft.com>
GrahamMThomas added a commit to GrahamMThomas/azure-rest-api-specs that referenced this pull request May 8, 2024
…8349)

* Updated CompletedAt to LastUpdatedAt for all terminal states

* Updates examples; Moves error order

* Set examples to more realistic value

* Updates File model for future expansion

* Adds Input FileLocation

---------

Co-authored-by: Graham Thomas <gthomas@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data-plane TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants