Add swagger for UploadIndicatorsAPI (Data Plane)

[ni-bhandari]

Swagger for Threat Intelligence - Upload Indicators API

This PR adds the swagger for the Upload Indicators API for Threat Intelligence (Microsoft Sentinel). This API is a data plane API and is currently in private preview.

fix https://github.com/Azure/azure-rest-api-specs/issues/22096

[openapi-workflow-bot[bot]]

Hi, @ni-bhandari 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[bot]]

Swagger Validation Report

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

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 3 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.1)	new version	base version
package-2022-12	package-2022-12(fbfbd41)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
:warning: PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json#L14
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json#L33
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json#L57

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️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).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

[openapi-pipeline-app[bot]]

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

[openapi-pipeline-app[bot]]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.SecurityInsights	https://apiview.dev/Assemblies/Review/7b73c493ceac494ba5ff6c91cee2578a

[openapi-workflow-bot[bot]]

Hi @ni-bhandari, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

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

[ruowan]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[openapi-workflow-bot[bot]]

Hi @ni-bhandari, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.

[ni-bhandari]

Hi, @tg-msft and @johanste, We require suppression of some ARM violations; they are mentioned in the readme and I have submitted the suppression request form as well. Please let us know if there is anything else you need! Thanks!

[ghost]

Hi, @ni-bhandari. 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 no-recent-activity label.

[ghost]

Hi, @ni-bhandari. 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 no-recent-activity label.

[ghost]

Hi, @ni-bhandari. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

[ni-bhandari]

@anuchandy We are finalizing changes for the swagger, so this PR was inactive for a while. Could you please open the PR up again? I will update the changes shortly.

[anuchandy]

@mikekistler Could you help with one more review? After the last api-board approval, there are two commits -

• Adds a string property to error schema
• Change the operation id from "ThreatIntelligence_UploadIndicators" to "threat-intelligence/indicators:upload". But I wonder "ThreatIntelligence_UploadIndicators" is the right one, given the text before "_" is the client class name and text after it is the method name.