Skip to content

Commit b90d21f

Browse files
Merge pull request #2986 from DeCohen/WI370671-api-fixes-for-docs
changed the word total to approximate & acrolinx fixes
2 parents 0320429 + 9263aa5 commit b90d21f

File tree

6 files changed

+82
-82
lines changed

6 files changed

+82
-82
lines changed

CloudAppSecurityDocs/api-activities-feedback.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ POST /api/v1/activities/<pk>/feedback
3232

3333
### Request
3434

35-
Here is an example of the request.
35+
Here's an example of the request.
3636

3737
```rest
3838
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/activities/<pk>/feedback" -d '{
@@ -49,7 +49,7 @@ Returns a list of activities in JSON format.
4949

5050
```json
5151
{
52-
"total": 5 // total number of records
52+
"total": 5 // approximate number of records
5353
"hasNext": true // whether there is more data to show or not.
5454
"data": [
5555
// returned records

CloudAppSecurityDocs/api-activities-list.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ POST /api/v1/activities/
2424

2525
| Parameter | Description |
2626
| --- | --- |
27-
| filters | Filter objects with all the search filters for the request, see [activity filters](api-activities.md#filters) for more details |
27+
| filters | Filter objects with all the search filters for the request, for more details see [activity filters](api-activities.md#filters) |
2828
| sortDirection | The sorting direction. Possible values are: `asc` and `desc` |
2929
| sortField | Fields used to sort activities. Possible values are: <li> **date**: The date when then the activity happened <li> **created**: The [timestamp](api-introduction.md#timestamps) when the activity was saved |
3030
| skip | Skips the specified number of records |
@@ -34,7 +34,7 @@ POST /api/v1/activities/
3434

3535
### Request
3636

37-
Here is an example of the request.
37+
Here's an example of the request.
3838

3939
```rest
4040
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/activities/" -d '{
@@ -53,7 +53,7 @@ Returns a list of activities in JSON format.
5353

5454
```json
5555
{
56-
"total": 5 // total number of records
56+
"total": 5 // approximate number of records
5757
"hasNext": true // whether there is more data to show or not.
5858
"data": [
5959
// returned records

CloudAppSecurityDocs/api-data-enrichment-list.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ POST /api/v1/subnet/
2424

2525
| Parameter | Description |
2626
| --- | --- |
27-
| filters | Filter objects with all the search filters for the request, see [IP range filters](api-data-enrichment.md#filters) for more details |
27+
| filters | Filter objects with all the search filters for the request, for more details see [IP range filters](api-data-enrichment.md#filters) |
2828
| sortDirection | The sorting direction. Possible values are: `asc` and `desc` |
2929
| sortField | Fields used to sort IP ranges. Possible values are:<br />- **category**: The category of the IP range<br />- **tags**: The tags of the IP range<br />- **name**: The name of the IP range |
3030
| skip | Skips the specified number of records |
@@ -34,7 +34,7 @@ POST /api/v1/subnet/
3434

3535
### Request
3636

37-
Here is an example of the request.
37+
Here's an example of the request.
3838

3939
```rest
4040
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/subnet/" -d '{
@@ -53,7 +53,7 @@ Returns a list of IP ranges in JSON format. For information about the response f
5353

5454
```json
5555
{
56-
"total": 1 // total number of records
56+
"total": 1 // approximate number of records
5757
"hasNext": false // whether there is more data to show or not.
5858
"data": [
5959
{

CloudAppSecurityDocs/api-entities-list.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ POST /api/v1/entities/
2727

2828
| Parameter | Description |
2929
| --- | --- |
30-
| filters | Filter objects with all the search filters for the request, see [entity filters](api-entities.md#filters) for more details |
30+
| filters | Filter objects with all the search filters for the request, for more details see [entity filters](api-entities.md#filters) |
3131
| sortDirection | The sorting direction. Possible values are: `asc` and `desc` |
3232
| sortField | Fields used to sort entities. Possible values are:<br />- **date**: The date when then the entity was created<br />- **severity**: The severity of the entity |
3333
| skip | Skips the specified number of records |
@@ -37,7 +37,7 @@ POST /api/v1/entities/
3737

3838
### Request
3939

40-
Here is an example of the request.
40+
Here's an example of the request.
4141

4242
```rest
4343
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/entities/" -d '{
@@ -56,7 +56,7 @@ Returns a list of activities in JSON format.
5656

5757
```json
5858
{
59-
"total": 5 // total number of records
59+
"total": 5 // approximate number of records
6060
"hasNext": true // whether there is more data to show or not.
6161
"data": [
6262
// returned records

CloudAppSecurityDocs/api-files-list.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.topic: reference
1111
> [!NOTE]
1212
>
1313
> - This API is not available for Microsoft 365 Cloud App Security.
14-
> - This endpoint may time out when filtering and paginating large collections.
14+
> - This endpoint might time out when filtering and paginating large collections.
1515
1616
Run the GET or POST request to fetch a list of files matching the specified filters.
1717

@@ -29,15 +29,15 @@ POST /api/v1/files/
2929

3030
| Parameter | Description |
3131
| --- | --- |
32-
| filters | Filter objects with all the search filters for the request, see [file filters](api-files.md#filters) for more details |
32+
| filters | Filter objects with all the search filters for the request, for more details see [file filters](api-files.md#filters) |
3333
| skip | Skips the specified number of records |
3434
| limit | Maximum number of records returned by the request |
3535

3636
## Example
3737

3838
### Request
3939

40-
Here is an example of the request.
40+
Here's an example of the request.
4141

4242
```rest
4343
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/files/" -d '{
@@ -56,7 +56,7 @@ Returns a list of files in JSON format.
5656

5757
```json
5858
{
59-
"total": 5 // total number of records
59+
"total": 5 // approximate number of records
6060
"hasNext": true // whether there is more data to show or not.
6161
"data": [
6262
// returned records

CloudAppSecurityDocs/toc.yml

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ items:
439439
- name: Reference
440440
items:
441441
- name: Microsoft Graph API reference
442-
href: /graph/api/resources/security-cloudappdiscovery-overview?view=graph-rest-beta
442+
href: /graph/api/resources/security-cloudappdiscovery-overview?view=graph-rest-beta&preserve-view=true
443443
- name: REST API reference
444444
items:
445445
- name: Introduction
@@ -466,72 +466,72 @@ items:
466466
href: api-activities-fetch.md
467467
- name: Feedback on activity
468468
href: api-activities-feedback.md
469-
- name: Alerts
470-
items:
471-
- name: Overview
472-
href: api-alerts.md
473-
- name: List alerts
474-
href: api-alerts-list.md
475-
- name: Close benign
476-
href: api-alerts-close-benign.md
477-
- name: Close false positive
478-
href: api-alerts-close-false-positive.md
479-
- name: Close true positive
480-
href: api-alerts-close-true-positive.md
481-
- name: Fetch alert
482-
href: api-alerts-fetch.md
483-
- name: Mark alert as read
484-
href: api-alerts-mark-read.md
485-
- name: Mark alert as unread
486-
href: api-alerts-mark-unread.md
487-
- name: Cloud Discovery
488-
items:
489-
- name: Overview
490-
href: api-discovery.md
491-
- name: Initiate file upload
492-
href: api-discovery-initiate.md
493-
- name: Perform file upload
494-
href: api-discovery-perform.md
495-
- name: Finalize file upload
496-
href: api-discovery-finalize.md
497-
- name: List continuous reports
498-
href: api-discovery-list-streams.md
499-
- name: List continuous report categories
500-
href: api-discovery-list-categories.md
501-
- name: Generate block script
502-
href: api-discovery-script.md
503-
- name: Data Enrichment
504-
items:
505-
- name: Overview
506-
href: api-data-enrichment.md
507-
- name: Manage IP address ranges using the API
508-
href: api-data-enrichment-manage-script.md
509-
- name: List IP ranges
510-
href: api-data-enrichment-list.md
511-
- name: Create IP address range
512-
href: api-data-enrichment-create.md
513-
- name: Update IP address range
514-
href: api-data-enrichment-update.md
515-
- name: Delete IP address range
516-
href: api-data-enrichment-delete.md
517-
- name: Entities
518-
items:
519-
- name: Overview
520-
href: api-entities.md
521-
- name: List entities
522-
href: api-entities-list.md
523-
- name: Fetch entity
524-
href: api-entities-fetch.md
525-
- name: Fetch entity tree
526-
href: api-entities-fetch-tree.md
527-
- name: Files
528-
items:
529-
- name: Overview
530-
href: api-files.md
531-
- name: List Files
532-
href: api-files-list.md
533-
- name: Fetch File
534-
href: api-files-fetch.md
469+
- name: Alerts
470+
items:
471+
- name: Overview
472+
href: api-alerts.md
473+
- name: List alerts
474+
href: api-alerts-list.md
475+
- name: Close benign
476+
href: api-alerts-close-benign.md
477+
- name: Close false positive
478+
href: api-alerts-close-false-positive.md
479+
- name: Close true positive
480+
href: api-alerts-close-true-positive.md
481+
- name: Fetch alert
482+
href: api-alerts-fetch.md
483+
- name: Mark alert as read
484+
href: api-alerts-mark-read.md
485+
- name: Mark alert as unread
486+
href: api-alerts-mark-unread.md
487+
- name: Cloud Discovery
488+
items:
489+
- name: Overview
490+
href: api-discovery.md
491+
- name: Initiate file upload
492+
href: api-discovery-initiate.md
493+
- name: Perform file upload
494+
href: api-discovery-perform.md
495+
- name: Finalize file upload
496+
href: api-discovery-finalize.md
497+
- name: List continuous reports
498+
href: api-discovery-list-streams.md
499+
- name: List continuous report categories
500+
href: api-discovery-list-categories.md
501+
- name: Generate block script
502+
href: api-discovery-script.md
503+
- name: Data Enrichment
504+
items:
505+
- name: Overview
506+
href: api-data-enrichment.md
507+
- name: Manage IP address ranges using the API
508+
href: api-data-enrichment-manage-script.md
509+
- name: List IP ranges
510+
href: api-data-enrichment-list.md
511+
- name: Create IP address range
512+
href: api-data-enrichment-create.md
513+
- name: Update IP address range
514+
href: api-data-enrichment-update.md
515+
- name: Delete IP address range
516+
href: api-data-enrichment-delete.md
517+
- name: Entities
518+
items:
519+
- name: Overview
520+
href: api-entities.md
521+
- name: List entities
522+
href: api-entities-list.md
523+
- name: Fetch entity
524+
href: api-entities-fetch.md
525+
- name: Fetch entity tree
526+
href: api-entities-fetch-tree.md
527+
- name: Files
528+
items:
529+
- name: Overview
530+
href: api-files.md
531+
- name: List Files
532+
href: api-files-list.md
533+
- name: Fetch File
534+
href: api-files-fetch.md
535535
- name: Resources
536536
items:
537537
- name: Licensing datasheet

0 commit comments

Comments
 (0)