[Defender (RiskIQ) - EASM] Api version 2024-03-01-preview #28322
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
juyoung98
requested review from
weidongxu-microsoft and
mikekistler
and removed request for
a team
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| easm.json | 2024-03-01-preview(d8c7748) | 2023-03-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 13 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| 2024-03-01-preview | 2024-03-01-preview(d8c7748) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L240 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L250 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L351 |
||
value property in pageable response should be requiredLocation: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L379 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L407 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L454 |
||
| OperationId for get method on a collection should contain 'List' Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L455 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L506 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L933 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1110 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1827 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1873 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L7105 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Security definition should have a description. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L43 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L204 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L600 |
|
| 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: 'DataConnections_CreateOrReplaceDataConnection' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L634 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L644 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L696 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L837 |
|
| 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: 'DiscoveryGroups_CreateOrReplaceDiscoGroup' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L871 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L881 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L976 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1028 |
|
value property in pageable response should be requiredLocation: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1035 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1265 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1301 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1434 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1542 |
|
| 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: 'SavedFilters_CreateOrReplaceSavedFilter' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1576 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1586 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1638 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1735 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1781 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L1932 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L2315 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L2382 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L2400 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L2496 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L2589 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L2807 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L2975 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Easm/preview/2024-03-01-preview/easm.json#L3131 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Mar 19, 2024
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
This was referenced Apr 30, 2024
johanste
reviewed
May 2, 2024
specification/riskiq/Easm/models.tsp
Outdated
|
|
||
| @doc("A request body used to retrieve a delta summary.") | ||
| @Versioning.added(Versions.v2024_03_01_preview) | ||
| model DeltaSummaryRequestBody { |
There was a problem hiding this comment.
Let's remove the "body" suffix. Is either value required? What happens if you provide neither?
There was a problem hiding this comment.
removed and also marked value as required
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
JeffreyRichter
added
the
APIStewardshipBoard-SignedOff
JeffreyRichter
approved these changes
May 16, 2024
| @Versioning.added(Versions.v2024_03_01_preview) | ||
| model RecentOnlyParameter { | ||
| @query("recentOnly") | ||
| @doc("If it's recent only.") |
There was a problem hiding this comment.
How "recent" is recent?
There was a problem hiding this comment.
it varies. this recent is a internal term we use, definition is below:
RECENCY
Currently GI API and UI search both default to searching against "recent" data. There is a special dropdown in the UI and a search history API that will search against historical data.
We define recency based on the datasource from which the various asset fields come from and whether the last seen on those fields makes the cutoff.
weidongxu-microsoft
approved these changes
May 21, 2024
…thub.com/juyoung98/azure-rest-api-specs into riskiq/Microsoft.Easm/2024-03-01-preview
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
* adding new and updated endpoints to azure review * update respective swagger file for version 2024-03-01 * fixing Swagger pipeline check failures * update client file with new endpoints, small naming convention changes * update the swagger file * adding examples * files didn't get added * fixing more checks * fixing cspell format * fixing more checks * fixing more examples * adding second set of examples * fixing diffs * changing POST to have request body when needed * ran prettier * ran prettier again * change model names to fit requirements * easm.json * projectedName deprecated * enums deprecated * prettier * updated swagger * test pipeline * sync up with upstream * revert changes in 2023-03-01-preview/easm.json, which shouldn't be touched * update dependecies and the swagger json file * remove dismissSeedChain endpoint * fix swagger spell error * add documentations for newly added models * try adding doc for the Versions enum * add discogroup delete, modify aseetChian realted apis * correct examples for assetChain related endpoints * dismissAssetChain should be resourceCollectionAction * remove word body from request, update some property from optional to required * add doc to enums * fix a typo and update dependecies using npm ci * Updated type to types and daysPrior to priorDays * Updated naming conventions for daysPrior to priorDays and type to types * update daysPrior to priorDays in examples files * update doc for dismiss asset chain --------- Co-authored-by: Juyoung Song <juyoungsong@microsoft.com> Co-authored-by: Adam An <adan@microsoft.com> Co-authored-by: Alex Williams <alewilliams@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
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.
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 ApiViewcomment 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.fix #28855
fix #28855