Skip to content

Commit f65f199

Browse files
Leopold-CramerLeopold-Cramer
committed
Modify required values in organization openapi objects + fix warnings
- added required to key values in openapi.yaml for organization - removed warnings due to useless non-null assertions - removed a few easy to fix warnings
1 parent ed04c84 commit f65f199

File tree

28 files changed

+1974
-2140
lines changed

28 files changed

+1974
-2140
lines changed

‎dataset/src/integrationTest/kotlin/com/cosmotech/dataset/service/DatasetServiceIntegrationTest.kt‎

Lines changed: 144 additions & 155 deletions
Large diffs are not rendered by default.

‎dataset/src/integrationTest/kotlin/com/cosmotech/dataset/service/DatasetServiceRBACTest.kt‎

Lines changed: 186 additions & 211 deletions
Large diffs are not rendered by default.

‎dataset/src/main/kotlin/com/cosmotech/dataset/service/DatasetServiceImpl.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ import com.cosmotech.dataset.utils.isReadOnlyQuery
7575
import com.cosmotech.dataset.utils.toCsmGraphEntity
7676
import com.cosmotech.dataset.utils.toJsonString
7777
import com.cosmotech.organization.OrganizationApiServiceInterface
78-
import com.cosmotech.organization.service.getRbac
78+
import com.cosmotech.organization.service.toGenericSecurity
7979
import com.google.gson.Gson
8080
import com.google.gson.reflect.TypeToken
8181
import java.io.InputStream
@@ -1030,7 +1030,7 @@ class DatasetServiceImpl(
10301030

10311031
val defaultPageSize = csmPlatformProperties.twincache.dataset.defaultPageSize
10321032
val pageable = constructPageRequest(page, size, defaultPageSize)
1033-
var datasetList = listOf<Dataset>()
1033+
var datasetList: List<Dataset>
10341034
if (pageable != null) {
10351035
datasetList =
10361036
datasetRepository
@@ -1080,7 +1080,7 @@ class DatasetServiceImpl(
10801080

10811081
val rbacSecurity =
10821082
csmRbac.addUserRole(
1083-
organization.getRbac(),
1083+
organization.security.toGenericSecurity(organizationId),
10841084
dataset.getRbac(),
10851085
datasetAccessControl.id,
10861086
datasetAccessControl.role)

‎doc/Apis/OrganizationApi.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ All URIs are relative to *http://localhost*
44

55
| Method | HTTP request | Description |
66
|------------- | ------------- | -------------|
7-
| [**createOrganization**](OrganizationApi.md#createOrganization) | **POST** /organizations | create a new organization |
7+
| [**createOrganization**](OrganizationApi.md#createOrganization) | **POST** /organizations | Create a new organization |
88
| [**createOrganizationAccessControl**](OrganizationApi.md#createOrganizationAccessControl) | **POST** /organizations/{organization_id}/security/access | Add a control access to the Organization |
9-
| [**deleteOrganization**](OrganizationApi.md#deleteOrganization) | **DELETE** /organizations/{organization_id} | delete an organization |
9+
| [**deleteOrganization**](OrganizationApi.md#deleteOrganization) | **DELETE** /organizations/{organization_id} | Delete an organization |
1010
| [**deleteOrganizationAccessControl**](OrganizationApi.md#deleteOrganizationAccessControl) | **DELETE** /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization |
1111
| [**getOrganization**](OrganizationApi.md#getOrganization) | **GET** /organizations/{organization_id} | Get the details of an Organization |
1212
| [**getOrganizationAccessControl**](OrganizationApi.md#getOrganizationAccessControl) | **GET** /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization |
@@ -22,15 +22,15 @@ All URIs are relative to *http://localhost*
2222

2323
<a name="createOrganization"></a>
2424
# **createOrganization**
25-
> Organization createOrganization(Organization)
25+
> Organization createOrganization(OrganizationCreateRequest)
2626
27-
create a new organization
27+
Create a new organization
2828

2929
### Parameters
3030

3131
|Name | Type | Description | Notes |
3232
|------------- | ------------- | ------------- | -------------|
33-
| **Organization** | [**Organization**](../Models/Organization.md)| the Organization to create | |
33+
| **OrganizationCreateRequest** | [**OrganizationCreateRequest**](../Models/OrganizationCreateRequest.md)| the Organization to create | |
3434

3535
### Return type
3636

@@ -75,7 +75,7 @@ Add a control access to the Organization
7575
# **deleteOrganization**
7676
> deleteOrganization(organization\_id)
7777
78-
delete an organization
78+
Delete an organization
7979

8080
### Parameters
8181

@@ -299,7 +299,7 @@ This endpoint does not need any parameter.
299299

300300
<a name="updateOrganization"></a>
301301
# **updateOrganization**
302-
> Organization updateOrganization(organization\_id, Organization)
302+
> Organization updateOrganization(organization\_id, OrganizationUpdateRequest)
303303
304304
Update an Organization
305305

@@ -308,7 +308,7 @@ Update an Organization
308308
|Name | Type | Description | Notes |
309309
|------------- | ------------- | ------------- | -------------|
310310
| **organization\_id** | **String**| the Organization identifier | [default to null] |
311-
| **Organization** | [**Organization**](../Models/Organization.md)| the new Organization details. This endpoint can&#39;t be used to update security | |
311+
| **OrganizationUpdateRequest** | [**OrganizationUpdateRequest**](../Models/OrganizationUpdateRequest.md)| the new Organization details. This endpoint can&#39;t be used to update security | |
312312

313313
### Return type
314314

‎doc/Models/ComponentRolePermissions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
6-
| **component** | **String** | | [optional] [default to null] |
7-
| **roles** | [**Map**](array.md) | | [optional] [default to null] |
6+
| **component** | **String** | | [default to null] |
7+
| **roles** | [**Map**](array.md) | | [default to null] |
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

‎doc/Models/Organization.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33

44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
6-
| **id** | **String** | the Organization unique identifier | [optional] [default to null] |
7-
| **name** | **String** | the Organization name | [optional] [default to null] |
8-
| **ownerId** | **String** | the Owner User Id | [optional] [default to null] |
9-
| **security** | [**OrganizationSecurity**](OrganizationSecurity.md) | | [optional] [default to null] |
6+
| **id** | **String** | the Organization unique identifier | [default to null] |
7+
| **name** | **String** | the Organization name | [default to null] |
8+
| **ownerId** | **String** | the Owner User Id | [default to null] |
9+
| **security** | [**OrganizationSecurity**](OrganizationSecurity.md) | | [default to null] |
1010

1111
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1212

‎doc/Models/OrganizationUpdateRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
6-
| **name** | **String** | the Organization name | [optional] [default to null] |
6+
| **name** | **String** | the Organization name | [default to null] |
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

‎doc/Models/UpdateOrganizationRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
| Name | Type | Description | Notes |
55
|------------ | ------------- | ------------- | -------------|
6-
| **name** | **String** | the Organization name | [optional] [default to null] |
6+
| **name** | **String** | the Organization name | [default to null] |
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

‎doc/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ All URIs are relative to *http://localhost*
4242
*DatasetApi* | [**updateDatasetAccessControl**](Apis/DatasetApi.md#updatedatasetaccesscontrol) | **PATCH** /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset |
4343
*DatasetApi* | [**updateTwingraphEntities**](Apis/DatasetApi.md#updatetwingraphentities) | **PATCH** /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Update entities in a graph instance |
4444
*DatasetApi* | [**uploadTwingraph**](Apis/DatasetApi.md#uploadtwingraph) | **POST** /organizations/{organization_id}/datasets/{dataset_id} | Upload data from zip file to dataset's twingraph |
45-
| *OrganizationApi* | [**createOrganization**](Apis/OrganizationApi.md#createorganization) | **POST** /organizations | create a new organization |
45+
| *OrganizationApi* | [**createOrganization**](Apis/OrganizationApi.md#createorganization) | **POST** /organizations | Create a new organization |
4646
*OrganizationApi* | [**createOrganizationAccessControl**](Apis/OrganizationApi.md#createorganizationaccesscontrol) | **POST** /organizations/{organization_id}/security/access | Add a control access to the Organization |
47-
*OrganizationApi* | [**deleteOrganization**](Apis/OrganizationApi.md#deleteorganization) | **DELETE** /organizations/{organization_id} | delete an organization |
47+
*OrganizationApi* | [**deleteOrganization**](Apis/OrganizationApi.md#deleteorganization) | **DELETE** /organizations/{organization_id} | Delete an organization |
4848
*OrganizationApi* | [**deleteOrganizationAccessControl**](Apis/OrganizationApi.md#deleteorganizationaccesscontrol) | **DELETE** /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization |
4949
*OrganizationApi* | [**getOrganization**](Apis/OrganizationApi.md#getorganization) | **GET** /organizations/{organization_id} | Get the details of an Organization |
5050
*OrganizationApi* | [**getOrganizationAccessControl**](Apis/OrganizationApi.md#getorganizationaccesscontrol) | **GET** /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization |
@@ -149,8 +149,10 @@ All URIs are relative to *http://localhost*
149149
- [IngestionStatusEnum](./Models/IngestionStatusEnum.md)
150150
- [Organization](./Models/Organization.md)
151151
- [OrganizationAccessControl](./Models/OrganizationAccessControl.md)
152+
- [OrganizationCreateRequest](./Models/OrganizationCreateRequest.md)
152153
- [OrganizationRole](./Models/OrganizationRole.md)
153154
- [OrganizationSecurity](./Models/OrganizationSecurity.md)
155+
- [OrganizationUpdateRequest](./Models/OrganizationUpdateRequest.md)
154156
- [QueryResult](./Models/QueryResult.md)
155157
- [ResourceSizeInfo](./Models/ResourceSizeInfo.md)
156158
- [Run](./Models/Run.md)

‎openapi/plantuml/schemas.plantuml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
title Cosmo Tech Platform API Schemas Diagram
44

55
entity ComponentRolePermissions {
6-
component: String
7-
roles: Map
6+
* component: String
7+
* roles: Map
88
}
99

1010
entity Connector {
@@ -161,10 +161,10 @@ entity IoTypesEnum {
161161
}
162162

163163
entity Organization {
164-
id: String
165-
name: String
166-
ownerId: String
167-
security: OrganizationSecurity
164+
* id: String
165+
* name: String
166+
* ownerId: String
167+
* security: OrganizationSecurity
168168
}
169169

170170
entity OrganizationAccessControl {
@@ -187,7 +187,7 @@ entity OrganizationSecurity {
187187
}
188188

189189
entity OrganizationUpdateRequest {
190-
name: String
190+
* name: String
191191
}
192192

193193
entity QueryResult {

0 commit comments

Comments
 (0)