Skip to content

Commit 38d9504

Browse files
Update with code-generated api bindings and models performed 2020-09-11
1 parent 6f00b31 commit 38d9504

File tree

28 files changed

+1382
-348
lines changed

28 files changed

+1382
-348
lines changed

splunk_sdk/action/v1beta2/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -681,4 +681,4 @@ paths:
681681
- Webhook Keys
682682
x-auth-required: false
683683

684-
# Retrieved from scp-openapi commit 1899bf005088f76091287fccf1b37a5268609818 path: action/v1beta2/openapi.yaml
684+
# Retrieved from scp-openapi commit 0946f4bc226a17b28c46e9494b83fff7a8f8720c path: action/v1beta2/openapi.yaml

splunk_sdk/action/v2alpha1/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -731,4 +731,4 @@ paths:
731731
- Webhook Keys
732732
x-auth-required: false
733733

734-
# Retrieved from scp-openapi commit 1899bf005088f76091287fccf1b37a5268609818 path: action/v2alpha1/openapi.yaml
734+
# Retrieved from scp-openapi commit 0946f4bc226a17b28c46e9494b83fff7a8f8720c path: action/v2alpha1/openapi.yaml

splunk_sdk/app_registry/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,4 @@
5050
Subscription, \
5151
UpdateAppRequest, \
5252
WebAppFromAppResponseCreateUpdate, \
53-
WebAppFromAppResponseGetList, \
54-
WebAppPOST
53+
WebAppFromAppResponseGetList

splunk_sdk/app_registry/v1beta2/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,4 @@
5050
Subscription, \
5151
UpdateAppRequest, \
5252
WebAppFromAppResponseCreateUpdate, \
53-
WebAppFromAppResponseGetList, \
54-
WebAppPOST
53+
WebAppFromAppResponseGetList

splunk_sdk/app_registry/v1beta2/gen_models.py

Lines changed: 0 additions & 231 deletions
Original file line numberDiff line numberDiff line change
@@ -3626,234 +3626,3 @@ def to_dict(self):
36263626

36273627
AppResponseGetList.from_dict_handlers["web"] = WebAppFromAppResponseGetList._from_dict
36283628

3629-
3630-
3631-
class WebAppPOST(CreateAppRequest):
3632-
3633-
@staticmethod
3634-
def _from_dict(model: dict) -> "WebAppPOST":
3635-
instance = WebAppPOST.__new__(WebAppPOST)
3636-
instance._attrs = model
3637-
return instance
3638-
3639-
def __init__(self, name: "str", app_principal_permissions: "List[str]" = None, description: "str" = None, login_url: "str" = None, logo_url: "str" = None, redirect_urls: "List[str]" = None, setup_url: "str" = None, title: "str" = None, user_permissions_filter: "List[str]" = None, webhook_url: "str" = None, **extra):
3640-
"""WebAppPOST"""
3641-
3642-
self._attrs = dict()
3643-
self._attrs["kind"] = "web"
3644-
if name is not None:
3645-
self._attrs["name"] = name
3646-
if app_principal_permissions is not None:
3647-
self._attrs["appPrincipalPermissions"] = app_principal_permissions
3648-
if description is not None:
3649-
self._attrs["description"] = description
3650-
if login_url is not None:
3651-
self._attrs["loginUrl"] = login_url
3652-
if logo_url is not None:
3653-
self._attrs["logoUrl"] = logo_url
3654-
if redirect_urls is not None:
3655-
self._attrs["redirectUrls"] = redirect_urls
3656-
if setup_url is not None:
3657-
self._attrs["setupUrl"] = setup_url
3658-
if title is not None:
3659-
self._attrs["title"] = title
3660-
if user_permissions_filter is not None:
3661-
self._attrs["userPermissionsFilter"] = user_permissions_filter
3662-
if webhook_url is not None:
3663-
self._attrs["webhookUrl"] = webhook_url
3664-
for k, v in extra.items():
3665-
self._attrs[k] = v
3666-
3667-
@property
3668-
def kind(self) -> str:
3669-
return "web"
3670-
3671-
3672-
@property
3673-
def name(self) -> "str":
3674-
""" Gets the name of this WebAppPOST.
3675-
App name that is unique within Splunk Cloud Platform.
3676-
"""
3677-
return self._attrs.get("name")
3678-
3679-
@name.setter
3680-
def name(self, name: "str"):
3681-
"""Sets the name of this WebAppPOST.
3682-
3683-
App name that is unique within Splunk Cloud Platform.
3684-
3685-
:param name: The name of this WebAppPOST.
3686-
:type: str
3687-
"""
3688-
if name is None:
3689-
raise ValueError("Invalid value for `name`, must not be `None`")
3690-
self._attrs["name"] = name
3691-
3692-
@property
3693-
def app_principal_permissions(self) -> "List[str]":
3694-
""" Gets the app_principal_permissions of this WebAppPOST.
3695-
Array of permission templates that are used to grant permission to the app principal when a tenant subscribes.
3696-
"""
3697-
return self._attrs.get("appPrincipalPermissions")
3698-
3699-
@app_principal_permissions.setter
3700-
def app_principal_permissions(self, app_principal_permissions: "List[str]"):
3701-
"""Sets the app_principal_permissions of this WebAppPOST.
3702-
3703-
Array of permission templates that are used to grant permission to the app principal when a tenant subscribes.
3704-
3705-
:param app_principal_permissions: The app_principal_permissions of this WebAppPOST.
3706-
:type: List[str]
3707-
"""
3708-
self._attrs["appPrincipalPermissions"] = app_principal_permissions
3709-
3710-
@property
3711-
def description(self) -> "str":
3712-
""" Gets the description of this WebAppPOST.
3713-
Short paragraph describing the app.
3714-
"""
3715-
return self._attrs.get("description")
3716-
3717-
@description.setter
3718-
def description(self, description: "str"):
3719-
"""Sets the description of this WebAppPOST.
3720-
3721-
Short paragraph describing the app.
3722-
3723-
:param description: The description of this WebAppPOST.
3724-
:type: str
3725-
"""
3726-
self._attrs["description"] = description
3727-
3728-
@property
3729-
def login_url(self) -> "str":
3730-
""" Gets the login_url of this WebAppPOST.
3731-
The URL used to log in to the app.
3732-
"""
3733-
return self._attrs.get("loginUrl")
3734-
3735-
@login_url.setter
3736-
def login_url(self, login_url: "str"):
3737-
"""Sets the login_url of this WebAppPOST.
3738-
3739-
The URL used to log in to the app.
3740-
3741-
:param login_url: The login_url of this WebAppPOST.
3742-
:type: str
3743-
"""
3744-
self._attrs["loginUrl"] = login_url
3745-
3746-
@property
3747-
def logo_url(self) -> "str":
3748-
""" Gets the logo_url of this WebAppPOST.
3749-
The URL used to display the app's logo.
3750-
"""
3751-
return self._attrs.get("logoUrl")
3752-
3753-
@logo_url.setter
3754-
def logo_url(self, logo_url: "str"):
3755-
"""Sets the logo_url of this WebAppPOST.
3756-
3757-
The URL used to display the app's logo.
3758-
3759-
:param logo_url: The logo_url of this WebAppPOST.
3760-
:type: str
3761-
"""
3762-
self._attrs["logoUrl"] = logo_url
3763-
3764-
@property
3765-
def redirect_urls(self) -> "List[str]":
3766-
""" Gets the redirect_urls of this WebAppPOST.
3767-
Array of URLs that can be used for redirect after logging into the app.
3768-
"""
3769-
return self._attrs.get("redirectUrls")
3770-
3771-
@redirect_urls.setter
3772-
def redirect_urls(self, redirect_urls: "List[str]"):
3773-
"""Sets the redirect_urls of this WebAppPOST.
3774-
3775-
Array of URLs that can be used for redirect after logging into the app.
3776-
3777-
:param redirect_urls: The redirect_urls of this WebAppPOST.
3778-
:type: List[str]
3779-
"""
3780-
self._attrs["redirectUrls"] = redirect_urls
3781-
3782-
@property
3783-
def setup_url(self) -> "str":
3784-
""" Gets the setup_url of this WebAppPOST.
3785-
URL to redirect to after a subscription is created.
3786-
"""
3787-
return self._attrs.get("setupUrl")
3788-
3789-
@setup_url.setter
3790-
def setup_url(self, setup_url: "str"):
3791-
"""Sets the setup_url of this WebAppPOST.
3792-
3793-
URL to redirect to after a subscription is created.
3794-
3795-
:param setup_url: The setup_url of this WebAppPOST.
3796-
:type: str
3797-
"""
3798-
self._attrs["setupUrl"] = setup_url
3799-
3800-
@property
3801-
def title(self) -> "str":
3802-
""" Gets the title of this WebAppPOST.
3803-
Human-readable title for the app.
3804-
"""
3805-
return self._attrs.get("title")
3806-
3807-
@title.setter
3808-
def title(self, title: "str"):
3809-
"""Sets the title of this WebAppPOST.
3810-
3811-
Human-readable title for the app.
3812-
3813-
:param title: The title of this WebAppPOST.
3814-
:type: str
3815-
"""
3816-
self._attrs["title"] = title
3817-
3818-
@property
3819-
def user_permissions_filter(self) -> "List[str]":
3820-
""" Gets the user_permissions_filter of this WebAppPOST.
3821-
Array of permission filter templates that are used to intersect with a user's permissions when using the app.
3822-
"""
3823-
return self._attrs.get("userPermissionsFilter")
3824-
3825-
@user_permissions_filter.setter
3826-
def user_permissions_filter(self, user_permissions_filter: "List[str]"):
3827-
"""Sets the user_permissions_filter of this WebAppPOST.
3828-
3829-
Array of permission filter templates that are used to intersect with a user's permissions when using the app.
3830-
3831-
:param user_permissions_filter: The user_permissions_filter of this WebAppPOST.
3832-
:type: List[str]
3833-
"""
3834-
self._attrs["userPermissionsFilter"] = user_permissions_filter
3835-
3836-
@property
3837-
def webhook_url(self) -> "str":
3838-
""" Gets the webhook_url of this WebAppPOST.
3839-
URL that webhook events are sent to.
3840-
"""
3841-
return self._attrs.get("webhookUrl")
3842-
3843-
@webhook_url.setter
3844-
def webhook_url(self, webhook_url: "str"):
3845-
"""Sets the webhook_url of this WebAppPOST.
3846-
3847-
URL that webhook events are sent to.
3848-
3849-
:param webhook_url: The webhook_url of this WebAppPOST.
3850-
:type: str
3851-
"""
3852-
self._attrs["webhookUrl"] = webhook_url
3853-
3854-
def to_dict(self):
3855-
return {k: v for (k, v) in self._attrs.items() if v is not None}
3856-
3857-
3858-
CreateAppRequest.from_dict_handlers["web"] = WebAppPOST._from_dict
3859-

splunk_sdk/app_registry/v1beta2/openapi.yaml

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,9 @@ components:
166166
mapping:
167167
native: '#/components/schemas/NativeAppPOST'
168168
service: '#/components/schemas/ServiceAppPOST'
169-
web: '#/components/schemas/WebAppPOST'
170169
propertyName: kind
171170
oneOf:
172171
- $ref: '#/components/schemas/ServiceAppPOST'
173-
- $ref: '#/components/schemas/WebAppPOST'
174172
- $ref: '#/components/schemas/NativeAppPOST'
175173
Error:
176174
properties:
@@ -313,18 +311,6 @@ components:
313311
- createdBy
314312
- createdAt
315313
type: object
316-
WebAppPOST:
317-
allOf:
318-
- $ref: '#/components/schemas/AppMetadataPublic'
319-
- $ref: '#/components/schemas/AppResource'
320-
- $ref: '#/components/schemas/AppMetadataPrivate'
321-
description: Required input for creating a web kind app.
322-
required:
323-
- name
324-
- kind
325-
- title
326-
- redirectUrls
327-
type: object
328314
securitySchemes:
329315
BearerToken:
330316
scheme: bearer
@@ -934,4 +920,4 @@ paths:
934920
security:
935921
- BearerToken: []
936922

937-
# Retrieved from scp-openapi commit 1899bf005088f76091287fccf1b37a5268609818 path: app-registry/v1beta2/openapi.yaml
923+
# Retrieved from scp-openapi commit 0946f4bc226a17b28c46e9494b83fff7a8f8720c path: app-registry/v1beta2/openapi.yaml

splunk_sdk/catalog/v2alpha2/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4813,4 +4813,4 @@ paths:
48134813
- $ref: '#/components/parameters/AuthorizationHeader'
48144814
- $ref: '#/components/parameters/Tenant'
48154815

4816-
# Retrieved from scp-openapi commit 1899bf005088f76091287fccf1b37a5268609818 path: catalog/v2alpha2/openapi.yaml
4816+
# Retrieved from scp-openapi commit 0946f4bc226a17b28c46e9494b83fff7a8f8720c path: catalog/v2alpha2/openapi.yaml

splunk_sdk/catalog/v2beta1/gen_models.py

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7549,7 +7549,7 @@ def _from_dict(model: dict) -> "JobDatasetGET":
75497549
instance._attrs = model
75507550
return instance
75517551

7552-
def __init__(self, name: "str", collect_event_summary: "bool" = None, collect_field_summary: "bool" = None, collect_time_buckets: "bool" = None, completion_time: "str" = None, delete_time: "str" = None, dispatch_time: "str" = None, enable_preview: "bool" = None, execution_time: "float" = None, extract_all_fields: "bool" = None, fields: "List[FieldPOST]" = None, has_side_effects: "bool" = None, id: "str" = None, max_time: "int" = None, module: "str" = None, parameters: "object" = None, parent: "str" = None, percent_complete: "int" = None, query: "str" = None, resolved_earliest: "str" = None, resolved_latest: "str" = None, results_available: "int" = None, search_head: "str" = None, sid: "str" = None, spl: "str" = None, status: "str" = None, timeline_metadata: "JobDatasetPropertiesTimelineMetadata" = None, **extra):
7552+
def __init__(self, name: "str", collect_event_summary: "bool" = None, collect_field_summary: "bool" = None, collect_time_buckets: "bool" = None, completion_time: "str" = None, delete_time: "str" = None, dispatch_time: "str" = None, enable_preview: "bool" = None, execution_time: "float" = None, extract_all_fields: "bool" = None, extract_fields: "str" = None, fields: "List[FieldPOST]" = None, has_side_effects: "bool" = None, id: "str" = None, max_time: "int" = None, module: "str" = None, parameters: "object" = None, parent: "str" = None, percent_complete: "int" = None, query: "str" = None, resolved_earliest: "str" = None, resolved_latest: "str" = None, results_available: "int" = None, search_head: "str" = None, sid: "str" = None, spl: "str" = None, status: "str" = None, timeline_metadata: "JobDatasetPropertiesTimelineMetadata" = None, **extra):
75537553
"""JobDatasetGET"""
75547554

75557555
self._attrs = dict()
@@ -7573,6 +7573,8 @@ def __init__(self, name: "str", collect_event_summary: "bool" = None, collect_fi
75737573
self._attrs["executionTime"] = execution_time
75747574
if extract_all_fields is not None:
75757575
self._attrs["extractAllFields"] = extract_all_fields
7576+
if extract_fields is not None:
7577+
self._attrs["extractFields"] = extract_fields
75767578
if fields is not None:
75777579
self._attrs["fields"] = fields
75787580
if has_side_effects is not None:
@@ -7793,6 +7795,24 @@ def extract_all_fields(self, extract_all_fields: "bool"):
77937795
"""
77947796
self._attrs["extractAllFields"] = extract_all_fields
77957797

7798+
@property
7799+
def extract_fields(self) -> "str":
7800+
""" Gets the extract_fields of this JobDatasetGET.
7801+
The fields to extract. Valid values are all, none, or indexed.
7802+
"""
7803+
return self._attrs.get("extractFields")
7804+
7805+
@extract_fields.setter
7806+
def extract_fields(self, extract_fields: "str"):
7807+
"""Sets the extract_fields of this JobDatasetGET.
7808+
7809+
The fields to extract. Valid values are all, none, or indexed.
7810+
7811+
:param extract_fields: The extract_fields of this JobDatasetGET.
7812+
:type: str
7813+
"""
7814+
self._attrs["extractFields"] = extract_fields
7815+
77967816
@property
77977817
def fields(self) -> "List[FieldPOST]":
77987818
""" Gets the fields of this JobDatasetGET.

splunk_sdk/catalog/v2beta1/openapi.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1197,6 +1197,9 @@ components:
11971197
description: Should the search produce all fields (including those not explicity
11981198
mentioned in the SPL)?
11991199
type: boolean
1200+
extractFields:
1201+
description: The fields to extract. Valid values are all, none, or indexed.
1202+
type: string
12001203
hasSideEffects:
12011204
description: Did the SPL query cause any side effects on a dataset?
12021205
type: boolean
@@ -5023,4 +5026,4 @@ paths:
50235026
"404":
50245027
description: The workflow run was not found.
50255028

5026-
# Retrieved from scp-openapi commit 1899bf005088f76091287fccf1b37a5268609818 path: catalog/v2beta1/openapi.yaml
5029+
# Retrieved from scp-openapi commit 0946f4bc226a17b28c46e9494b83fff7a8f8720c path: catalog/v2beta1/openapi.yaml

splunk_sdk/collect/v1beta1/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1016,4 +1016,4 @@ paths:
10161016
x-authz-scope: collect.jobs.executions.update
10171017
x-internal: false
10181018

1019-
# Retrieved from scp-openapi commit 1899bf005088f76091287fccf1b37a5268609818 path: collect/v1beta1/openapi.yaml
1019+
# Retrieved from scp-openapi commit 0946f4bc226a17b28c46e9494b83fff7a8f8720c path: collect/v1beta1/openapi.yaml

0 commit comments

Comments
 (0)