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.

Sign up for GitHub

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

Jump to bottom

Add Swagger for Defender for Storage new on-demand malware scan API #30786

Merged
merged 29 commits into from
Oct 28, 2024
Merged

Add Swagger for Defender for Storage new on-demand malware scan API #30786

merged 29 commits into from
Oct 28, 2024

Conversation

akrabi
Copy link
Contributor

@akrabi akrabi commented Sep 29, 2024

Add Swagger for Defender for Storage new on-demand malware scan API

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • 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.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@akrabi
Copy files from preview/2022-12-01-preview
ec2e932 
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
@akrabi
Update version to preview/2024-10-01-preview
8b9df35 
Updated the API version from preview/2022-12-01-preview to preview/2024-10-01-preview.
@akrabi
Added tag for 2024-10-01-preview in readme file
4cb887e
@akrabi
Add Swagger for Defender for Storage new on-demand malware scan API
ee2b692
@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 29, 2024 •
edited
Loading

Next Steps to Merge

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

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 29, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/security/armsecurity https://apiview.dev/Assemblies/Review/88de20a29c604e9cbb6f756102580913?revisionId=4f09e7a408e2472aa60938af5b26e239
JavaScript @azure/arm-security https://apiview.dev/Assemblies/Review/7b0611da161f46f58e9bb08f96d69207?revisionId=683d3b0c5ba049389fa39ca69dcef2e1
Java azure-resourcemanager-security https://apiview.dev/Assemblies/Review/4bbce61669f64b1bb4b00043576ed1e7?revisionId=65b530ca76ed4179b556df33213ca659
Swagger Microsoft.Security https://apiview.dev/Assemblies/Review/0be86090d4af4a1abff7bcf36507d1ab?revisionId=e425f70753ae48479c3bfce8ab5b8ba7

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 29, 2024
This was referenced Sep 29, 2024
Closed
Closed
Closed
@akrabi akrabi added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Sep 30, 2024
This was referenced Sep 30, 2024
Closed
Closed
@azure-sdk azure-sdk mentioned this pull request Sep 30, 2024
Closed
@akrabi akrabi added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Oct 14, 2024
@mentat9 mentat9 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 14, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 14, 2024
@akrabi akrabi force-pushed the akrabi/malware-ondemand-scans branch from 5b18b4d to 6cfda8d Compare October 15, 2024 06:31
@akrabi akrabi force-pushed the akrabi/malware-ondemand-scans branch from 6cfda8d to cd874b3 Compare October 15, 2024 06:38
@akrabi akrabi added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Oct 15, 2024
@akrabi akrabi requested a review from mentat9 October 15, 2024 18:44
@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 15, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 15, 2024
@akrabi akrabi merged commit 697d0fc into Azure:main Oct 28, 2024
27 of 30 checks passed
@akrabi akrabi deleted the akrabi/malware-ondemand-scans branch October 28, 2024 10:36
markcowl pushed a commit to markcowl/azure-rest-api-specs that referenced this pull request Oct 29, 2024
@akrabi @markcowl
Add Swagger for Defender for Storage new on-demand malware scan API (A…
1f1738d 
…zure#30786)

* Copy files from preview/2022-12-01-preview

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to preview/2024-10-01-preview

Updated the API version from preview/2022-12-01-preview to preview/2024-10-01-preview.

* Added tag for 2024-10-01-preview in readme file

* Add Swagger for Defender for Storage new on-demand malware scan API

* Update api-version in examples

* Run prettier on swagger files

* Fix defintions

* Fix BlobsScanSummary definition

* Remove scanRequestTime (will be removed from API)

* Camel casing

* Add get to malwareScanStatus operation name

* Remove extra underscore from operation ids

* Fix MalwareScanStatus top level properties

* Fix examples to match properties

* Extract MalwareScanStatusProperties

* Remove resource reference

* Remove scanId from Cancel and remove get from ScanStatus path

* Change the API structure to include a collection of scans

* Add 'malware' to cancel operation name

* Copy operations API to new api version

* Add opeations example

* Limit example size

* run prettier

* Move example to correct folder

* modify example

* Add opeartions file to readme

* Use common types for operation results
haagha pushed a commit that referenced this pull request Nov 19, 2024
@akrabi @haagha
Add Swagger for Defender for Storage new on-demand malware scan API (#…
fb449ab 
…30786)

* Copy files from preview/2022-12-01-preview

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to preview/2024-10-01-preview

Updated the API version from preview/2022-12-01-preview to preview/2024-10-01-preview.

* Added tag for 2024-10-01-preview in readme file

* Add Swagger for Defender for Storage new on-demand malware scan API

* Update api-version in examples

* Run prettier on swagger files

* Fix defintions

* Fix BlobsScanSummary definition

* Remove scanRequestTime (will be removed from API)

* Camel casing

* Add get to malwareScanStatus operation name

* Remove extra underscore from operation ids

* Fix MalwareScanStatus top level properties

* Fix examples to match properties

* Extract MalwareScanStatusProperties

* Remove resource reference

* Remove scanId from Cancel and remove get from ScanStatus path

* Change the API structure to include a collection of scans

* Add 'malware' to cancel operation name

* Copy operations API to new api version

* Add opeations example

* Limit example size

* run prettier

* Move example to correct folder

* modify example

* Add opeartions file to readme

* Use common types for operation results
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@salambashir salambashir salambashir approved these changes

@eliagrady eliagrady Awaiting requested review from eliagrady

@yoavfr yoavfr Awaiting requested review from yoavfr

@eswatad eswatad Awaiting requested review from eswatad

@rwishahy rwishahy Awaiting requested review from rwishahy

@mentat9 mentat9 Awaiting requested review from mentat9

Assignees
No one assigned
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@akrabi @rkmanda @raosuhas @mentat9 @salambashir @AzureRestAPISpecReview