Skip to content

Commit 5da6dcf

Browse files
hkad98hkad98
authored
Merge pull request #1659 from okrcmaGD/okrc/update_api_docs
chore: regenerate api-client against staging
2 parents 0f95cbb + 198404d commit 5da6dcf

27 files changed

Lines changed: 304 additions & 21 deletions

‎gooddata-api-client/docs/ActionsApi.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4214,7 +4214,7 @@ with gooddata_api_client.ApiClient() as api_client:
42144214
data_type="INT",
42154215
description="Customer unique identifier",
42164216
name="customer_id",
4217-
null_value="null_value_example",
4217+
null_value="_",
42184218
),
42194219
],
42204220
statement="select * from abc",
@@ -9986,6 +9986,17 @@ with gooddata_api_client.ApiClient() as api_client:
99869986
local_identifier="metric_1",
99879987
),
99889988
],
9989+
parameters=[
9990+
ParameterItem(
9991+
parameter=AfmObjectIdentifierParameter(
9992+
identifier=AfmObjectIdentifierParameterIdentifier(
9993+
id="sample_item.price",
9994+
type="parameter",
9995+
),
9996+
),
9997+
value="value_example",
9998+
),
9999+
],
998910000
),
999010001
interval="DAY",
999110002
trigger="ALWAYS",

‎gooddata-api-client/docs/AlertAfm.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. |
99
**attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | [optional]
1010
**aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional]
11+
**parameters** | [**[ParameterItem]**](ParameterItem.md) | Parameters to be used in the computation. | [optional]
1112
**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]
1213

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

‎gooddata-api-client/docs/AutomationControllerApi.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,17 @@ with gooddata_api_client.ApiClient() as api_client:
7373
local_identifier="metric_1",
7474
),
7575
],
76+
parameters=[
77+
ParameterItem(
78+
parameter=AfmObjectIdentifierParameter(
79+
identifier=AfmObjectIdentifierParameterIdentifier(
80+
id="sample_item.price",
81+
type="parameter",
82+
),
83+
),
84+
value="value_example",
85+
),
86+
],
7687
),
7788
interval="DAY",
7889
trigger="ALWAYS",
@@ -706,6 +717,17 @@ with gooddata_api_client.ApiClient() as api_client:
706717
local_identifier="metric_1",
707718
),
708719
],
720+
parameters=[
721+
ParameterItem(
722+
parameter=AfmObjectIdentifierParameter(
723+
identifier=AfmObjectIdentifierParameterIdentifier(
724+
id="sample_item.price",
725+
type="parameter",
726+
),
727+
),
728+
value="value_example",
729+
),
730+
],
709731
),
710732
interval="DAY",
711733
trigger="ALWAYS",
@@ -1188,6 +1210,17 @@ with gooddata_api_client.ApiClient() as api_client:
11881210
local_identifier="metric_1",
11891211
),
11901212
],
1213+
parameters=[
1214+
ParameterItem(
1215+
parameter=AfmObjectIdentifierParameter(
1216+
identifier=AfmObjectIdentifierParameterIdentifier(
1217+
id="sample_item.price",
1218+
type="parameter",
1219+
),
1220+
),
1221+
value="value_example",
1222+
),
1223+
],
11911224
),
11921225
interval="DAY",
11931226
trigger="ALWAYS",

‎gooddata-api-client/docs/AutomationsApi.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,17 @@ with gooddata_api_client.ApiClient() as api_client:
9090
local_identifier="metric_1",
9191
),
9292
],
93+
parameters=[
94+
ParameterItem(
95+
parameter=AfmObjectIdentifierParameter(
96+
identifier=AfmObjectIdentifierParameterIdentifier(
97+
id="sample_item.price",
98+
type="parameter",
99+
),
100+
),
101+
value="value_example",
102+
),
103+
],
93104
),
94105
interval="DAY",
95106
trigger="ALWAYS",
@@ -1028,6 +1039,17 @@ with gooddata_api_client.ApiClient() as api_client:
10281039
local_identifier="metric_1",
10291040
),
10301041
],
1042+
parameters=[
1043+
ParameterItem(
1044+
parameter=AfmObjectIdentifierParameter(
1045+
identifier=AfmObjectIdentifierParameterIdentifier(
1046+
id="sample_item.price",
1047+
type="parameter",
1048+
),
1049+
),
1050+
value="value_example",
1051+
),
1052+
],
10311053
),
10321054
interval="DAY",
10331055
trigger="ALWAYS",
@@ -1751,6 +1773,17 @@ with gooddata_api_client.ApiClient() as api_client:
17511773
local_identifier="metric_1",
17521774
),
17531775
],
1776+
parameters=[
1777+
ParameterItem(
1778+
parameter=AfmObjectIdentifierParameter(
1779+
identifier=AfmObjectIdentifierParameterIdentifier(
1780+
id="sample_item.price",
1781+
type="parameter",
1782+
),
1783+
),
1784+
value="value_example",
1785+
),
1786+
],
17541787
),
17551788
interval="DAY",
17561789
trigger="ALWAYS",
@@ -2121,6 +2154,17 @@ with gooddata_api_client.ApiClient() as api_client:
21212154
local_identifier="metric_1",
21222155
),
21232156
],
2157+
parameters=[
2158+
ParameterItem(
2159+
parameter=AfmObjectIdentifierParameter(
2160+
identifier=AfmObjectIdentifierParameterIdentifier(
2161+
id="sample_item.price",
2162+
type="parameter",
2163+
),
2164+
),
2165+
value="value_example",
2166+
),
2167+
],
21242168
),
21252169
interval="DAY",
21262170
trigger="ALWAYS",
@@ -3006,6 +3050,17 @@ with gooddata_api_client.ApiClient() as api_client:
30063050
local_identifier="metric_1",
30073051
),
30083052
],
3053+
parameters=[
3054+
ParameterItem(
3055+
parameter=AfmObjectIdentifierParameter(
3056+
identifier=AfmObjectIdentifierParameterIdentifier(
3057+
id="sample_item.price",
3058+
type="parameter",
3059+
),
3060+
),
3061+
value="value_example",
3062+
),
3063+
],
30093064
),
30103065
interval="DAY",
30113066
trigger="ALWAYS",

‎gooddata-api-client/docs/DeclarativeUser.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
1212
**lastname** | **str** | User last name | [optional]
1313
**permissions** | [**[DeclarativeUserPermission]**](DeclarativeUserPermission.md) | | [optional]
1414
**settings** | [**[DeclarativeSetting]**](DeclarativeSetting.md) | A list of user settings. | [optional]
15+
**system_account** | **bool** | Is user system account | [optional]
1516
**user_groups** | [**[DeclarativeUserGroupIdentifier]**](DeclarativeUserGroupIdentifier.md) | | [optional]
1617
**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]
1718

‎gooddata-api-client/docs/EntitiesApi.md‎

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -780,6 +780,17 @@ with gooddata_api_client.ApiClient() as api_client:
780780
local_identifier="metric_1",
781781
),
782782
],
783+
parameters=[
784+
ParameterItem(
785+
parameter=AfmObjectIdentifierParameter(
786+
identifier=AfmObjectIdentifierParameterIdentifier(
787+
id="sample_item.price",
788+
type="parameter",
789+
),
790+
),
791+
value="value_example",
792+
),
793+
],
783794
),
784795
interval="DAY",
785796
trigger="ALWAYS",
@@ -3491,7 +3502,7 @@ with gooddata_api_client.ApiClient() as api_client:
34913502
email="email_example",
34923503
firstname="firstname_example",
34933504
lastname="lastname_example",
3494-
system_account=True,
3505+
system_account=False,
34953506
),
34963507
id="id1",
34973508
relationships=JsonApiAgentInRelationships(
@@ -15240,6 +15251,17 @@ with gooddata_api_client.ApiClient() as api_client:
1524015251
local_identifier="metric_1",
1524115252
),
1524215253
],
15254+
parameters=[
15255+
ParameterItem(
15256+
parameter=AfmObjectIdentifierParameter(
15257+
identifier=AfmObjectIdentifierParameterIdentifier(
15258+
id="sample_item.price",
15259+
type="parameter",
15260+
),
15261+
),
15262+
value="value_example",
15263+
),
15264+
],
1524315265
),
1524415266
interval="DAY",
1524515267
trigger="ALWAYS",
@@ -18308,7 +18330,7 @@ with gooddata_api_client.ApiClient() as api_client:
1830818330
email="email_example",
1830918331
firstname="firstname_example",
1831018332
lastname="lastname_example",
18311-
system_account=True,
18333+
system_account=False,
1831218334
),
1831318335
id="id1",
1831418336
relationships=JsonApiAgentInRelationships(
@@ -21600,6 +21622,17 @@ with gooddata_api_client.ApiClient() as api_client:
2160021622
local_identifier="metric_1",
2160121623
),
2160221624
],
21625+
parameters=[
21626+
ParameterItem(
21627+
parameter=AfmObjectIdentifierParameter(
21628+
identifier=AfmObjectIdentifierParameterIdentifier(
21629+
id="sample_item.price",
21630+
type="parameter",
21631+
),
21632+
),
21633+
value="value_example",
21634+
),
21635+
],
2160321636
),
2160421637
interval="DAY",
2160521638
trigger="ALWAYS",
@@ -24669,7 +24702,7 @@ with gooddata_api_client.ApiClient() as api_client:
2466924702
email="email_example",
2467024703
firstname="firstname_example",
2467124704
lastname="lastname_example",
24672-
system_account=True,
24705+
system_account=False,
2467324706
),
2467424707
id="id1",
2467524708
relationships=JsonApiAgentInRelationships(

‎gooddata-api-client/docs/GenerateLogicalDataModelApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ with gooddata_api_client.ApiClient() as api_client:
5555
data_type="INT",
5656
description="Customer unique identifier",
5757
name="customer_id",
58-
null_value="null_value_example",
58+
null_value="_",
5959
),
6060
],
6161
statement="select * from abc",

‎gooddata-api-client/docs/JsonApiIpAllowlistPolicyInAttributes.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**allowed_sources** | **[str], none_type** | Allowed source IPv4 addresses or CIDR ranges. Only IPv4 is supported; IPv6 are rejected. The /0 prefix is not allowed. |
7+
**allowed_sources** | **[str], none_type** | Allowed source IPv4 or IPv6 addresses or CIDR ranges. The /0 and ::/0 prefixes are not allowed. |
88
**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]
99

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

‎gooddata-api-client/docs/JsonApiUserInAttributes.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**email** | **str** | | [optional]
99
**firstname** | **str** | | [optional]
1010
**lastname** | **str** | | [optional]
11-
**system_account** | **bool** | | [optional]
11+
**system_account** | **bool** | Is user system account | [optional]
1212
**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]
1313

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

‎gooddata-api-client/docs/LayoutApi.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2100,6 +2100,7 @@ with gooddata_api_client.ApiClient() as api_client:
21002100
type="TIMEZONE",
21012101
),
21022102
],
2103+
system_account=False,
21032104
user_groups=[
21042105
DeclarativeUserGroupIdentifier(
21052106
id="group.admins",
@@ -2219,6 +2220,7 @@ with gooddata_api_client.ApiClient() as api_client:
22192220
type="TIMEZONE",
22202221
),
22212222
],
2223+
system_account=False,
22222224
user_groups=[
22232225
DeclarativeUserGroupIdentifier(
22242226
id="group.admins",
@@ -3147,6 +3149,17 @@ with gooddata_api_client.ApiClient() as api_client:
31473149
local_identifier="metric_1",
31483150
),
31493151
],
3152+
parameters=[
3153+
ParameterItem(
3154+
parameter=AfmObjectIdentifierParameter(
3155+
identifier=AfmObjectIdentifierParameterIdentifier(
3156+
id="sample_item.price",
3157+
type="parameter",
3158+
),
3159+
),
3160+
value="value_example",
3161+
),
3162+
],
31503163
),
31513164
interval="DAY",
31523165
trigger="ALWAYS",
@@ -4586,6 +4599,7 @@ with gooddata_api_client.ApiClient() as api_client:
45864599
type="TIMEZONE",
45874600
),
45884601
],
4602+
system_account=False,
45894603
user_groups=[
45904604
DeclarativeUserGroupIdentifier(
45914605
id="group.admins",
@@ -4652,6 +4666,17 @@ with gooddata_api_client.ApiClient() as api_client:
46524666
local_identifier="metric_1",
46534667
),
46544668
],
4669+
parameters=[
4670+
ParameterItem(
4671+
parameter=AfmObjectIdentifierParameter(
4672+
identifier=AfmObjectIdentifierParameterIdentifier(
4673+
id="sample_item.price",
4674+
type="parameter",
4675+
),
4676+
),
4677+
value="value_example",
4678+
),
4679+
],
46554680
),
46564681
interval="DAY",
46574682
trigger="ALWAYS",
@@ -6015,6 +6040,17 @@ with gooddata_api_client.ApiClient() as api_client:
60156040
local_identifier="metric_1",
60166041
),
60176042
],
6043+
parameters=[
6044+
ParameterItem(
6045+
parameter=AfmObjectIdentifierParameter(
6046+
identifier=AfmObjectIdentifierParameterIdentifier(
6047+
id="sample_item.price",
6048+
type="parameter",
6049+
),
6050+
),
6051+
value="value_example",
6052+
),
6053+
],
60186054
),
60196055
interval="DAY",
60206056
trigger="ALWAYS",

0 commit comments

Comments
 (0)