Skip to content

Commit

Permalink
CAL-1093: update API clients for P32
Browse files Browse the repository at this point in the history
Now includes composite keys support. LDM dataset references
have a new "sources" option and "sourceColumns" are now Optional.
This property is returned only if GDC_FEATURES_ENABLE_COMPOSITE_GRAIN=true
  • Loading branch information
Vojtasii committed Oct 30, 2023
1 parent b6a6a96 commit 626f258
Show file tree
Hide file tree
Showing 199 changed files with 5,010 additions and 4,938 deletions.
4 changes: 4 additions & 0 deletions gooddata-api-client/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ docs/DeclarativeOrganizationInfo.md
docs/DeclarativeOrganizationPermission.md
docs/DeclarativePdm.md
docs/DeclarativeReference.md
docs/DeclarativeReferenceSource.md
docs/DeclarativeRsaSpecification.md
docs/DeclarativeSetting.md
docs/DeclarativeSingleWorkspacePermission.md
Expand Down Expand Up @@ -198,6 +199,7 @@ docs/JsonApiAnalyticalDashboardOutRelationshipsMetrics.md
docs/JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.md
docs/JsonApiAnalyticalDashboardOutWithLinks.md
docs/JsonApiAnalyticalDashboardPatch.md
docs/JsonApiAnalyticalDashboardPatchAttributes.md
docs/JsonApiAnalyticalDashboardPatchDocument.md
docs/JsonApiAnalyticalDashboardPostOptionalId.md
docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md
Expand Down Expand Up @@ -806,6 +808,7 @@ gooddata_api_client/model/declarative_organization_info.py
gooddata_api_client/model/declarative_organization_permission.py
gooddata_api_client/model/declarative_pdm.py
gooddata_api_client/model/declarative_reference.py
gooddata_api_client/model/declarative_reference_source.py
gooddata_api_client/model/declarative_rsa_specification.py
gooddata_api_client/model/declarative_setting.py
gooddata_api_client/model/declarative_single_workspace_permission.py
Expand Down Expand Up @@ -891,6 +894,7 @@ gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_metric
gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_visualization_objects.py
gooddata_api_client/model/json_api_analytical_dashboard_out_with_links.py
gooddata_api_client/model/json_api_analytical_dashboard_patch.py
gooddata_api_client/model/json_api_analytical_dashboard_patch_attributes.py
gooddata_api_client/model/json_api_analytical_dashboard_patch_document.py
gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id.py
gooddata_api_client/model/json_api_analytical_dashboard_post_optional_id_document.py
Expand Down
5 changes: 2 additions & 3 deletions gooddata-api-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ Class | Method | HTTP request | Description
*APITokensApi* | [**delete_entity_api_tokens**](docs/APITokensApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user
*APITokensApi* | [**get_all_entities_api_tokens**](docs/APITokensApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user
*APITokensApi* | [**get_entity_api_tokens**](docs/APITokensApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user
*APITokensApi* | [**update_entity_api_tokens**](docs/APITokensApi.md#update_entity_api_tokens) | **PUT** /api/v1/entities/users/{userId}/apiTokens/{id} | Put new API token for the user
*AnalyticsModelApi* | [**get_analytics_model**](docs/AnalyticsModelApi.md#get_analytics_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Get analytics model
*AnalyticsModelApi* | [**set_analytics_model**](docs/AnalyticsModelApi.md#set_analytics_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Set analytics model
*AppearanceApi* | [**create_entity_color_palettes**](docs/AppearanceApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes
Expand Down Expand Up @@ -466,7 +465,6 @@ Class | Method | HTTP request | Description
*EntitiesApi* | [**patch_entity_workspace_settings**](docs/EntitiesApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace
*EntitiesApi* | [**patch_entity_workspaces**](docs/EntitiesApi.md#patch_entity_workspaces) | **PATCH** /api/v1/entities/workspaces/{id} | Patch Workspace entity
*EntitiesApi* | [**update_entity_analytical_dashboards**](docs/EntitiesApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards
*EntitiesApi* | [**update_entity_api_tokens**](docs/EntitiesApi.md#update_entity_api_tokens) | **PUT** /api/v1/entities/users/{userId}/apiTokens/{id} | Put new API token for the user
*EntitiesApi* | [**update_entity_attribute_hierarchies**](docs/EntitiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy
*EntitiesApi* | [**update_entity_color_palettes**](docs/EntitiesApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette
*EntitiesApi* | [**update_entity_cookie_security_configurations**](docs/EntitiesApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration
Expand Down Expand Up @@ -595,7 +593,6 @@ Class | Method | HTTP request | Description
*UserModelControllerApi* | [**get_all_entities_user_settings**](docs/UserModelControllerApi.md#get_all_entities_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings | List all settings for a user
*UserModelControllerApi* | [**get_entity_api_tokens**](docs/UserModelControllerApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user
*UserModelControllerApi* | [**get_entity_user_settings**](docs/UserModelControllerApi.md#get_entity_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings/{id} | Get a setting for a user
*UserModelControllerApi* | [**update_entity_api_tokens**](docs/UserModelControllerApi.md#update_entity_api_tokens) | **PUT** /api/v1/entities/users/{userId}/apiTokens/{id} | Put new API token for the user
*UserModelControllerApi* | [**update_entity_user_settings**](docs/UserModelControllerApi.md#update_entity_user_settings) | **PUT** /api/v1/entities/users/{userId}/userSettings/{id} | Put new user settings for the user
*WorkspaceObjectControllerApi* | [**create_entity_analytical_dashboards**](docs/WorkspaceObjectControllerApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards
*WorkspaceObjectControllerApi* | [**create_entity_attribute_hierarchies**](docs/WorkspaceObjectControllerApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies
Expand Down Expand Up @@ -764,6 +761,7 @@ Class | Method | HTTP request | Description
- [DeclarativeOrganizationPermission](docs/DeclarativeOrganizationPermission.md)
- [DeclarativePdm](docs/DeclarativePdm.md)
- [DeclarativeReference](docs/DeclarativeReference.md)
- [DeclarativeReferenceSource](docs/DeclarativeReferenceSource.md)
- [DeclarativeRsaSpecification](docs/DeclarativeRsaSpecification.md)
- [DeclarativeSetting](docs/DeclarativeSetting.md)
- [DeclarativeSingleWorkspacePermission](docs/DeclarativeSingleWorkspacePermission.md)
Expand Down Expand Up @@ -849,6 +847,7 @@ Class | Method | HTTP request | Description
- [JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects](docs/JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.md)
- [JsonApiAnalyticalDashboardOutWithLinks](docs/JsonApiAnalyticalDashboardOutWithLinks.md)
- [JsonApiAnalyticalDashboardPatch](docs/JsonApiAnalyticalDashboardPatch.md)
- [JsonApiAnalyticalDashboardPatchAttributes](docs/JsonApiAnalyticalDashboardPatchAttributes.md)
- [JsonApiAnalyticalDashboardPatchDocument](docs/JsonApiAnalyticalDashboardPatchDocument.md)
- [JsonApiAnalyticalDashboardPostOptionalId](docs/JsonApiAnalyticalDashboardPostOptionalId.md)
- [JsonApiAnalyticalDashboardPostOptionalIdDocument](docs/JsonApiAnalyticalDashboardPostOptionalIdDocument.md)
Expand Down
87 changes: 0 additions & 87 deletions gooddata-api-client/docs/APITokensApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Method | HTTP request | Description
[**delete_entity_api_tokens**](APITokensApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user
[**get_all_entities_api_tokens**](APITokensApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user
[**get_entity_api_tokens**](APITokensApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user
[**update_entity_api_tokens**](APITokensApi.md#update_entity_api_tokens) | **PUT** /api/v1/entities/users/{userId}/apiTokens/{id} | Put new API token for the user


# **create_entity_api_tokens**
Expand Down Expand Up @@ -321,89 +320,3 @@ No authorization required

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

# **update_entity_api_tokens**
> JsonApiApiTokenOutDocument update_entity_api_tokens(user_id, id, json_api_api_token_in_document)
Put new API token for the user

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import api_tokens_api
from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument
from gooddata_api_client.model.json_api_api_token_in_document import JsonApiApiTokenInDocument
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = api_tokens_api.APITokensApi(api_client)
user_id = "userId_example" # str |
id = "/6bUUGjjNSwg0_bs" # str |
json_api_api_token_in_document = JsonApiApiTokenInDocument(
data=JsonApiApiTokenIn(
id="id1",
type="apiToken",
),
) # JsonApiApiTokenInDocument |
filter = "filter=bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)

# example passing only required values which don't have defaults set
try:
# Put new API token for the user
api_response = api_instance.update_entity_api_tokens(user_id, id, json_api_api_token_in_document)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling APITokensApi->update_entity_api_tokens: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
# Put new API token for the user
api_response = api_instance.update_entity_api_tokens(user_id, id, json_api_api_token_in_document, filter=filter)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling APITokensApi->update_entity_api_tokens: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user_id** | **str**| |
**id** | **str**| |
**json_api_api_token_in_document** | [**JsonApiApiTokenInDocument**](JsonApiApiTokenInDocument.md)| |
**filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional]

### Return type

[**JsonApiApiTokenOutDocument**](JsonApiApiTokenOutDocument.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/vnd.gooddata.api+json
- **Accept**: application/vnd.gooddata.api+json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Request successfully processed | - |

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

2 changes: 1 addition & 1 deletion gooddata-api-client/docs/ContextFiltersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ with gooddata_api_client.ApiClient() as api_client:
object_id = "objectId_example" # str |
json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument(
data=JsonApiFilterContextPatch(
attributes=JsonApiAnalyticalDashboardInAttributes(
attributes=JsonApiAnalyticalDashboardPatchAttributes(
are_relations_valid=True,
content={},
description="description_example",
Expand Down
2 changes: 1 addition & 1 deletion gooddata-api-client/docs/DashboardsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ with gooddata_api_client.ApiClient() as api_client:
object_id = "objectId_example" # str |
json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument(
data=JsonApiAnalyticalDashboardPatch(
attributes=JsonApiAnalyticalDashboardInAttributes(
attributes=JsonApiAnalyticalDashboardPatchAttributes(
are_relations_valid=True,
content={},
description="description_example",
Expand Down
5 changes: 3 additions & 2 deletions gooddata-api-client/docs/DeclarativeReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identifier** | [**ReferenceIdentifier**](ReferenceIdentifier.md) | |
**multivalue** | **bool** | The multi-value flag enables many-to-many cardinality for references. |
**source_columns** | **[str]** | An array of source column names for a given reference. |
**source_column_data_types** | **[str]** | An array of source column data types for a given reference. | [optional]
**source_column_data_types** | **[str]** | An array of source column data types for a given reference. Deprecated, use 'sources' instead. | [optional]
**source_columns** | **[str]** | An array of source column names for a given reference. Deprecated, use 'sources' instead. | [optional]
**sources** | [**[DeclarativeReferenceSource]**](DeclarativeReferenceSource.md) | An array of source columns for a given reference. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
15 changes: 15 additions & 0 deletions gooddata-api-client/docs/DeclarativeReferenceSource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DeclarativeReferenceSource

A dataset reference source column description.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**column** | **str** | A name of the source column in the table. |
**target** | [**GrainIdentifier**](GrainIdentifier.md) | |
**data_type** | **str** | A type of the source column. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

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


Loading

0 comments on commit 626f258

Please sign in to comment.