Skip to content

Commit 6ab5a8e

Browse files
change description on default security endpoints
1 parent 95ecfe9 commit 6ab5a8e

File tree

10 files changed

+20
-10
lines changed

10 files changed

+20
-10
lines changed

dataset/src/main/openapi/dataset.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1090,7 +1090,9 @@ paths:
10901090
- dataset
10911091
summary: Set the Dataset default security
10921092
requestBody:
1093-
description: the new Dataset default security.
1093+
description: This change the dataset default security.
1094+
The default security is the role assigned to any person not on the Access Control List.
1095+
If the default security is None, then nobody outside of the ACL can access the dataset.
10941096
required: true
10951097
content:
10961098
application/json:

doc/Apis/DatasetApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ Name | Type | Description | Notes
596596
------------- | ------------- | ------------- | -------------
597597
**organization\_id** | **String**| the Organization identifier | [default to null]
598598
**dataset\_id** | **String**| the Dataset identifier | [default to null]
599-
**DatasetRole** | [**DatasetRole**](../Models/DatasetRole.md)| the new Dataset default security. |
599+
**DatasetRole** | [**DatasetRole**](../Models/DatasetRole.md)| This change the dataset default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the dataset. |
600600

601601
### Return type
602602

doc/Apis/OrganizationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ Set the Organization default security
286286
Name | Type | Description | Notes
287287
------------- | ------------- | ------------- | -------------
288288
**organization\_id** | **String**| the Organization identifier | [default to null]
289-
**OrganizationRole** | [**OrganizationRole**](../Models/OrganizationRole.md)| the new Organization default security. |
289+
**OrganizationRole** | [**OrganizationRole**](../Models/OrganizationRole.md)| This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization. |
290290

291291
### Return type
292292

doc/Apis/ScenarioApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ Name | Type | Description | Notes
562562
**organization\_id** | **String**| the Organization identifier | [default to null]
563563
**workspace\_id** | **String**| the Workspace identifier | [default to null]
564564
**scenario\_id** | **String**| the Scenario identifier | [default to null]
565-
**ScenarioRole** | [**ScenarioRole**](../Models/ScenarioRole.md)| the new Scenario default security. |
565+
**ScenarioRole** | [**ScenarioRole**](../Models/ScenarioRole.md)| This change the scenario default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the scenario. |
566566

567567
### Return type
568568

doc/Apis/SolutionApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ Name | Type | Description | Notes
492492
------------- | ------------- | ------------- | -------------
493493
**organization\_id** | **String**| the Organization identifier | [default to null]
494494
**solution\_id** | **String**| the Solution identifier | [default to null]
495-
**SolutionRole** | [**SolutionRole**](../Models/SolutionRole.md)| the new Solution default security. |
495+
**SolutionRole** | [**SolutionRole**](../Models/SolutionRole.md)| This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution. |
496496

497497
### Return type
498498

doc/Apis/WorkspaceApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ Name | Type | Description | Notes
435435
------------- | ------------- | ------------- | -------------
436436
**organization\_id** | **String**| the Organization identifier | [default to null]
437437
**workspace\_id** | **String**| the Workspace identifier | [default to null]
438-
**WorkspaceRole** | [**WorkspaceRole**](../Models/WorkspaceRole.md)| the new Workspace default security. |
438+
**WorkspaceRole** | [**WorkspaceRole**](../Models/WorkspaceRole.md)| This change the workspace default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the workspace. |
439439

440440
### Return type
441441

organization/src/main/openapi/organization.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,9 @@ paths:
396396
- organization
397397
summary: Set the Organization default security
398398
requestBody:
399-
description: the new Organization default security.
399+
description: This change the organization default security.
400+
The default security is the role assigned to any person not on the Access Control List.
401+
If the default security is None, then nobody outside of the ACL can access the organization.
400402
required: true
401403
content:
402404
application/json:

scenario/src/main/openapi/scenario.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,9 @@ paths:
608608
- scenario
609609
summary: Set the Scenario default security
610610
requestBody:
611-
description: the new Scenario default security.
611+
description: This change the scenario default security.
612+
The default security is the role assigned to any person not on the Access Control List.
613+
If the default security is None, then nobody outside of the ACL can access the scenario.
612614
required: true
613615
content:
614616
application/json:

solution/src/main/openapi/solution.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,9 @@ paths:
526526
- solution
527527
summary: Set the Solution default security
528528
requestBody:
529-
description: the new Solution default security.
529+
description: This change the solution default security.
530+
The default security is the role assigned to any person not on the Access Control List.
531+
If the default security is None, then nobody outside of the ACL can access the solution.
530532
required: true
531533
content:
532534
application/json:

workspace/src/main/openapi/workspace.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,9 @@ paths:
449449
- workspace
450450
summary: Set the Workspace default security
451451
requestBody:
452-
description: the new Workspace default security.
452+
description: This change the workspace default security.
453+
The default security is the role assigned to any person not on the Access Control List.
454+
If the default security is None, then nobody outside of the ACL can access the workspace.
453455
required: true
454456
content:
455457
application/json:

0 commit comments

Comments
 (0)