diff --git a/.apigentools-info b/.apigentools-info index d28740bc1a..3ff7ef38e9 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.4.1.dev6", - "regenerated": "2021-03-23 10:52:34.560111", - "spec_repo_commit": "34cf37f" + "regenerated": "2021-03-23 14:02:46.709774", + "spec_repo_commit": "7e667f1" }, "v2": { "apigentools_version": "1.4.1.dev6", - "regenerated": "2021-03-23 10:53:14.043922", - "spec_repo_commit": "34cf37f" + "regenerated": "2021-03-23 14:03:25.204186", + "spec_repo_commit": "7e667f1" } } } \ No newline at end of file diff --git a/.generator/templates/README.mustache b/.generator/templates/README.mustache new file mode 100644 index 0000000000..65a06eaae0 --- /dev/null +++ b/.generator/templates/README.mustache @@ -0,0 +1,55 @@ +# {{{projectName}}} +{{#appDescriptionWithNewLines}} +{{{appDescriptionWithNewLines}}} +{{/appDescriptionWithNewLines}} + +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: {{appVersion}} +- Package version: {{packageVersion}} +{{^hideGenerationTimestamp}} +- Build date: {{generatedDate}} +{{/hideGenerationTimestamp}} +- Build package: {{generatorClass}} +{{#infoUrl}} +For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) +{{/infoUrl}} + +## Requirements. + +Python >= 3.6 + +## Installation & Usage +### pip install + +If the python package is hosted on a repository, you can install directly using: + +```sh +pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git +``` +(you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`) + +Then import the package: +```python +import {{{packageName}}} +``` + +### Setuptools + +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) + +Then import the package: +```python +import {{{packageName}}} +``` + +## Getting Started + +Please follow the [installation procedure](#installation--usage) and then run the following: + +{{> README_common }} diff --git a/.generator/templates/README_common.mustache b/.generator/templates/README_common.mustache new file mode 100644 index 0000000000..f1fa2c2d7d --- /dev/null +++ b/.generator/templates/README_common.mustache @@ -0,0 +1,111 @@ +```python +{{#apiInfo}}{{#apis}}{{#-last}}{{#hasHttpSignatureMethods}}import datetime{{/hasHttpSignatureMethods}}{{/-last}}{{/apis}}{{/apiInfo}} +import time +import {{{packageName}}} +from pprint import pprint +{{#apiInfo}} +{{#apis}} +{{#-first}} +from {{apiPackage}} import {{classVarName}} +{{#imports}} +{{{import}}} +{{/imports}} +{{#operations}} +{{#operation}} +{{#-first}} +{{> python_doc_auth_partial}} + +# Enter a context with an instance of the API client +with {{{packageName}}}.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = {{classVarName}}.{{{classname}}}(api_client) + {{#allParams}}{{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + {{/allParams}} + + try: + {{#summary}} # {{{.}}} + {{/summary}} {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}){{#returnType}} + pprint(api_response){{/returnType}} + except {{{packageName}}}.ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/-first}} +{{/operation}} +{{/operations}} +{{/-first}} +{{/apis}} +{{/apiInfo}} +``` + +## Documentation for API Endpoints + +All URIs are relative to *{{basePath}}* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} +{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} + +## Documentation For Models + +{{#models}}{{#model}} - [{{{classname}}}]({{{classname}}}.md) +{{/model}}{{/models}} + +## Documentation For Authorization + +{{^authMethods}} + All endpoints do not require authorization. +{{/authMethods}} +{{#authMethods}} +{{#last}} Authentication schemes defined for the API:{{/last}} +## {{{name}}} + +{{#isApiKey}} +- **Type**: API key +- **API key parameter name**: {{{keyParamName}}} +- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}} +{{/isApiKey}} +{{#isBasic}} +{{#isBasicBasic}} +- **Type**: HTTP basic authentication +{{/isBasicBasic}} +{{#isBasicBearer}} +- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}} +{{/isBasicBearer}} +{{#isHttpSignature}} +- **Type**: HTTP signature authentication +{{/isHttpSignature}} +{{/isBasic}} +{{#isOAuth}} +- **Type**: OAuth +- **Flow**: {{{flow}}} +- **Authorization URL**: {{{authorizationUrl}}} +- **Scopes**: {{^scopes}}N/A{{/scopes}} +{{#scopes}} - **{{{scope}}}**: {{{description}}} +{{/scopes}} +{{/isOAuth}} + +{{/authMethods}} + +## Author + +{{#apiInfo}}{{#apis}}{{#-last}}{{infoEmail}} +{{/-last}}{{/apis}}{{/apiInfo}} + +## Notes for Large OpenAPI documents +If the OpenAPI document is large, imports in {{{packageName}}}.apis and {{{packageName}}}.models may fail with a +RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: + +Solution 1: +Use specific imports for apis and models like: +- `from {{{packageName}}}.api.default_api import DefaultApi` +- `from {{{packageName}}}.model.pet import Pet` + +Solution 2: +Before importing the package, adjust the maximum recursion limit as shown below: +``` +import sys +sys.setrecursionlimit(1500) +import {{{packageName}}} +from {{{packageName}}}.apis import * +from {{{packageName}}}.models import * +``` diff --git a/.generator/templates/README_onlypackage.mustache b/.generator/templates/README_onlypackage.mustache new file mode 100644 index 0000000000..7202059fba --- /dev/null +++ b/.generator/templates/README_onlypackage.mustache @@ -0,0 +1,42 @@ +# {{{projectName}}} +{{#appDescription}} +{{{appDescription}}} +{{/appDescription}} + +The `{{packageName}}` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: {{appVersion}} +- Package version: {{packageVersion}} +{{^hideGenerationTimestamp}} +- Build date: {{generatedDate}} +{{/hideGenerationTimestamp}} +- Build package: {{generatorClass}} +{{#infoUrl}} +For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) +{{/infoUrl}} + +## Requirements. + +Python >= 3.6 + +## Installation & Usage + +This python library package is generated without supporting files like setup.py or requirements files + +To be able to use it, you will need these dependencies in your own package that uses this library: + +* urllib3 >= 1.25.3 +* python-dateutil +{{#asyncio}} +* aiohttp +{{/asyncio}} +{{#tornado}} +* tornado>=4.2,<5 +{{/tornado}} + +## Getting Started + +In your own code, to use this library to connect and interact with {{{projectName}}}, +you can run the following: + +{{> README_common }} diff --git a/.generator/templates/__init__.mustache b/.generator/templates/__init__.mustache new file mode 100644 index 0000000000..e69de29bb2 diff --git a/.generator/templates/__init__api.mustache b/.generator/templates/__init__api.mustache new file mode 100644 index 0000000000..8a9e6b91b9 --- /dev/null +++ b/.generator/templates/__init__api.mustache @@ -0,0 +1,9 @@ +{{#apiInfo}} +{{#apis}} +{{#-first}} +# do not import all apis into this module because that uses a lot of memory and stack frames +# if you need the ability to import all apis from one package, import them with +# from {{packageName}}.apis import {{classname}} +{{/-first}} +{{/apis}} +{{/apiInfo}} diff --git a/.generator/templates/__init__apis.mustache b/.generator/templates/__init__apis.mustache new file mode 100644 index 0000000000..b4ec8a9a47 --- /dev/null +++ b/.generator/templates/__init__apis.mustache @@ -0,0 +1,23 @@ +{{#apiInfo}} +{{#apis}} +{{#-first}} + +# flake8: noqa + +# Import all APIs into this package. +# If you have many APIs here with many many models used in each API this may +# raise a `RecursionError`. +# In order to avoid this, import only the API that you directly need like: +# +# from {{packagename}}.api.{{classVarName}} import {{classname}} +# +# or import this package, but before doing it, use: +# +# import sys +# sys.setrecursionlimit(n) + +# Import APIs into API package: +{{/-first}} +from {{apiPackage}}.{{classVarName}} import {{classname}} +{{/apis}} +{{/apiInfo}} diff --git a/.generator/templates/__init__model.mustache b/.generator/templates/__init__model.mustache new file mode 100644 index 0000000000..cfe32b7849 --- /dev/null +++ b/.generator/templates/__init__model.mustache @@ -0,0 +1,5 @@ +# we can not import model classes here because that would create a circular +# reference which would not work in python2 +# do not import all models into this module because that uses a lot of memory and stack frames +# if you need the ability to import all models from one package, import them with +# from {{packageName}.models import ModelA, ModelB diff --git a/.generator/templates/__init__models.mustache b/.generator/templates/__init__models.mustache new file mode 100644 index 0000000000..76d91fc5d4 --- /dev/null +++ b/.generator/templates/__init__models.mustache @@ -0,0 +1,16 @@ +# flake8: noqa + +# import all models into this package +# if you have many models here with many references from one model to another this may +# raise a RecursionError +# to avoid this, import only the models that you directly need like: +# from from {{modelPackage}}.pet import Pet +# or import this package, but before doing it, use: +# import sys +# sys.setrecursionlimit(n) + +{{#models}} +{{#model}} +from {{modelPackage}}.{{classFilename}} import {{classname}} +{{/model}} +{{/models}} diff --git a/.generator/templates/__init__package.mustache b/.generator/templates/__init__package.mustache new file mode 100644 index 0000000000..6308ba683f --- /dev/null +++ b/.generator/templates/__init__package.mustache @@ -0,0 +1,26 @@ +# flake8: noqa + +{{>partial_header}} + +__version__ = "{{packageVersion}}" + +# import ApiClient +from {{packageName}}.api_client import ApiClient + +# import Configuration +from {{packageName}}.configuration import Configuration +{{#hasHttpSignatureMethods}} +from {{packageName}}.signing import HttpSigningConfiguration +{{/hasHttpSignatureMethods}} + +# import exceptions +from {{packageName}}.exceptions import OpenApiException +from {{packageName}}.exceptions import ApiAttributeError +from {{packageName}}.exceptions import ApiTypeError +from {{packageName}}.exceptions import ApiValueError +from {{packageName}}.exceptions import ApiKeyError +from {{packageName}}.exceptions import ApiException +{{#recursionLimit}} + +__import__('sys').setrecursionlimit({{{.}}}) +{{/recursionLimit}} diff --git a/.generator/templates/api.mustache b/.generator/templates/api.mustache new file mode 100644 index 0000000000..cbad6df2c5 --- /dev/null +++ b/.generator/templates/api.mustache @@ -0,0 +1,306 @@ +{{>partial_header}} + +import re # noqa: F401 +import sys # noqa: F401 + +from {{packageName}}.api_client import ApiClient, Endpoint as _Endpoint +from {{packageName}}.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +{{#imports}} +{{{import}}} +{{/imports}} + + +{{#operations}} +class {{classname}}(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client +{{#operation}} + + def __{{operationId}}( + self, +{{#requiredParams}} +{{^defaultValue}} + {{paramName}}, +{{/defaultValue}} +{{/requiredParams}} +{{#requiredParams}} +{{#defaultValue}} + {{paramName}}={{{defaultValue}}}, +{{/defaultValue}} +{{/requiredParams}} + **kwargs + ): + """{{#summary}}{{{.}}}{{/summary}}{{^summary}}{{operationId}}{{/summary}} # noqa: E501 + +{{#notes}} + {{{notes}}} # noqa: E501 +{{/notes}} + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.{{operationId}}({{#requiredParams}}{{^defaultValue}}{{paramName}}, {{/defaultValue}}{{/requiredParams}}{{#requiredParams}}{{#defaultValue}}{{paramName}}={{{defaultValue}}}, {{/defaultValue}}{{/requiredParams}}async_req=True) + >>> result = thread.get() + +{{#requiredParams}} +{{#-last}} + Args: +{{/-last}} +{{/requiredParams}} +{{#requiredParams}} +{{^defaultValue}} + {{paramName}} ({{dataType}}):{{#description}} {{{description}}}{{/description}} +{{/defaultValue}} +{{/requiredParams}} +{{#requiredParams}} +{{#defaultValue}} + {{paramName}} ({{dataType}}):{{#description}} {{{description}}}.{{/description}} defaults to {{{defaultValue}}}, must be one of [{{{defaultValue}}}] +{{/defaultValue}} +{{/requiredParams}} + + Keyword Args:{{#optionalParams}} + {{paramName}} ({{dataType}}):{{#description}} {{{description}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/defaultValue}}{{/optionalParams}} + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (float/tuple): timeout setting for this request. If one + number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}} + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') +{{#requiredParams}} + kwargs['{{paramName}}'] = \ + {{paramName}} +{{/requiredParams}} + return self.call_with_http_info(**kwargs) + + self.{{operationId}} = _Endpoint( + settings={ + 'response_type': {{#returnType}}({{{returnType}}},){{/returnType}}{{^returnType}}None{{/returnType}}, +{{#authMethods}} +{{#-first}} + 'auth': [ +{{/-first}} + '{{name}}'{{^-last}},{{/-last}} +{{#-last}} + ], +{{/-last}} +{{/authMethods}} +{{^authMethods}} + 'auth': [], +{{/authMethods}} + 'endpoint_path': '{{{path}}}', + 'operation_id': '{{operationId}}', + 'http_method': '{{httpMethod}}', +{{#servers}} +{{#-first}} + 'servers': [ +{{/-first}} + { + 'url': "{{{url}}}", + 'description': "{{{description}}}{{^description}}No description provided{{/description}}", + {{#variables}} + {{#-first}} + 'variables': { + {{/-first}} + '{{{name}}}': { + 'description': "{{{description}}}{{^description}}No description provided{{/description}}", + 'default_value': "{{{defaultValue}}}", + {{#enumValues}} + {{#-first}} + 'enum_values': [ + {{/-first}} + "{{{.}}}"{{^-last}},{{/-last}} + {{#-last}} + ] + {{/-last}} + {{/enumValues}} + }{{^-last}},{{/-last}} + {{#-last}} + } + {{/-last}} + {{/variables}} + }, +{{#-last}} + ] +{{/-last}} +{{/servers}} +{{^servers}} + 'servers': None, +{{/servers}} + }, + params_map={ + 'all': [ +{{#allParams}} + '{{paramName}}', +{{/allParams}} + ], +{{#requiredParams}} +{{#-first}} + 'required': [ +{{/-first}} + '{{paramName}}', +{{#-last}} + ], +{{/-last}} +{{/requiredParams}} +{{^requiredParams}} + 'required': [], +{{/requiredParams}} + 'nullable': [ +{{#allParams}} +{{#isNullable}} + '{{paramName}}', +{{/isNullable}} +{{/allParams}} + ], + 'enum': [ +{{#allParams}} +{{#isEnum}} + '{{paramName}}', +{{/isEnum}} +{{/allParams}} + ], + 'validation': [ +{{#allParams}} +{{#hasValidation}} + '{{paramName}}', +{{/hasValidation}} +{{/allParams}} + ] + }, + root_map={ + 'validations': { +{{#allParams}} +{{#hasValidation}} + ('{{paramName}}',): { +{{#maxLength}} + 'max_length': {{maxLength}},{{/maxLength}}{{#minLength}} + 'min_length': {{minLength}},{{/minLength}}{{#maxItems}} + 'max_items': {{maxItems}},{{/maxItems}}{{#minItems}} + 'min_items': {{minItems}},{{/minItems}}{{#maximum}} + {{#exclusiveMaximum}}'exclusive_maximum'{{/exclusiveMaximum}}'inclusive_maximum'{{^exclusiveMaximum}}{{/exclusiveMaximum}}: {{maximum}},{{/maximum}}{{#minimum}} + {{#exclusiveMinimum}}'exclusive_minimum'{{/exclusiveMinimum}}'inclusive_minimum'{{^exclusiveMinimum}}{{/exclusiveMinimum}}: {{minimum}},{{/minimum}}{{#pattern}} + 'regex': { + 'pattern': r'{{{vendorExtensions.x-regex}}}', # noqa: E501{{#vendorExtensions.x-modifiers}} + {{#-first}}'flags': (re.{{.}}{{/-first}}{{^-first}} re.{{.}}{{/-first}}{{^-last}} | {{/-last}}{{#-last}}){{/-last}}{{/vendorExtensions.x-modifiers}} + },{{/pattern}} + }, +{{/hasValidation}} +{{/allParams}} + }, + 'allowed_values': { +{{#allParams}} +{{#isEnum}} + ('{{paramName}}',): { +{{#isNullable}} + 'None': None,{{/isNullable}}{{#allowableValues}}{{#enumVars}} + "{{name}}": {{{value}}}{{^-last}},{{/-last}}{{/enumVars}}{{/allowableValues}} + }, +{{/isEnum}} +{{/allParams}} + }, + 'openapi_types': { +{{#allParams}} + '{{paramName}}': + ({{{dataType}}},), +{{/allParams}} + }, + 'attribute_map': { +{{#allParams}} +{{^isBodyParam}} + '{{paramName}}': '{{baseName}}', +{{/isBodyParam}} +{{/allParams}} + }, + 'location_map': { +{{#allParams}} + '{{paramName}}': '{{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isHeaderParam}}header{{/isHeaderParam}}{{#isCookieParam}}cookie{{/isCookieParam}}{{#isBodyParam}}body{{/isBodyParam}}', +{{/allParams}} + }, + 'collection_format_map': { +{{#allParams}} +{{#collectionFormat}} + '{{paramName}}': '{{collectionFormat}}', +{{/collectionFormat}} +{{/allParams}} + } + }, + headers_map={ +{{#hasProduces}} + 'accept': [ +{{#produces}} + '{{{mediaType}}}'{{^-last}},{{/-last}} +{{/produces}} + ], +{{/hasProduces}} +{{^hasProduces}} + 'accept': [], +{{/hasProduces}} +{{#hasConsumes}} + 'content_type': [ +{{#consumes}} + '{{{mediaType}}}'{{^-last}},{{/-last}} +{{/consumes}} + ] +{{/hasConsumes}} +{{^hasConsumes}} + 'content_type': [], +{{/hasConsumes}} + }, + api_client=api_client, + callable=__{{operationId}} + ) +{{/operation}} +{{/operations}} diff --git a/.generator/templates/api_client.mustache b/.generator/templates/api_client.mustache new file mode 100644 index 0000000000..cede0a2b4e --- /dev/null +++ b/.generator/templates/api_client.mustache @@ -0,0 +1,890 @@ +{{>partial_header}} + +import json +import atexit +import mimetypes +import warnings +from multiprocessing.pool import ThreadPool +import io +import os +import re +import typing +from urllib.parse import quote +from urllib3.fields import RequestField + +{{#tornado}} +import tornado.gen +{{/tornado}} + +from {{packageName}} import rest +from {{packageName}}.configuration import Configuration +from {{packageName}}.exceptions import ApiTypeError, ApiValueError, ApiException +from {{packageName}}.model_utils import ( + ModelNormal, + ModelSimple, + ModelComposed, + check_allowed_values, + check_validations, + date, + datetime, + deserialize_file, + file_type, + model_to_dict, + none_type, + validate_and_convert_types +) + + +class ApiClient(object): + """Generic API client for OpenAPI client library builds. + + OpenAPI generic API client. This client handles the client- + server communication, and is invariant across implementations. Specifics of + the methods and models for each application are generated from the OpenAPI + templates. + + NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param configuration: .Configuration object for this client + :param header_name: a header to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API + :param pool_threads: The number of threads to use for async requests + to the API. More threads means more concurrent API requests. + """ + + _pool = None + + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None, pool_threads=1): + if configuration is None: + configuration = Configuration.get_default_copy() + self.configuration = configuration + self.pool_threads = pool_threads + + self.rest_client = rest.RESTClientObject(configuration) + self.default_headers = {} + if header_name is not None: + self.default_headers[header_name] = header_value + self.cookie = cookie + # Set default User-Agent. + self.user_agent = user_agent() + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + self.close() + + def close(self): + if self._pool: + self._pool.close() + self._pool.join() + self._pool = None + if hasattr(atexit, 'unregister'): + atexit.unregister(self.close) + + @property + def pool(self): + """Create thread pool on first request + avoids instantiating unused threadpool for blocking clients. + """ + if self._pool is None: + atexit.register(self.close) + self._pool = ThreadPool(self.pool_threads) + return self._pool + + @property + def user_agent(self): + """User agent for this API client""" + return self.default_headers['User-Agent'] + + @user_agent.setter + def user_agent(self, value): + self.default_headers['User-Agent'] = value + + def set_default_header(self, header_name, header_value): + self.default_headers[header_name] = header_value + + {{#tornado}} + @tornado.gen.coroutine + {{/tornado}} + {{#asyncio}}async {{/asyncio}}def __call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None + ): + + config = self.configuration + + # header parameters + header_params = header_params or {} + header_params.update(self.default_headers) + if self.cookie: + header_params['Cookie'] = self.cookie + if header_params: + header_params = self.sanitize_for_serialization(header_params) + header_params = dict(self.parameters_to_tuples(header_params, + collection_formats)) + + # path parameters + if path_params: + path_params = self.sanitize_for_serialization(path_params) + path_params = self.parameters_to_tuples(path_params, + collection_formats) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) + + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + query_params = self.parameters_to_tuples(query_params, + collection_formats) + + # post parameters + if post_params or files: + post_params = post_params if post_params else [] + post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples(post_params, + collection_formats) + post_params.extend(self.files_parameters(files)) + if header_params['Content-Type'].startswith("multipart"): + post_params = self.parameters_to_multipart(post_params, + (dict) ) + + # body + if body: + body = self.sanitize_for_serialization(body) + + # auth setting + self.update_params_for_auth(header_params, query_params, + auth_settings, resource_path, method, body) + + # request url + if _host is None: + url = self.configuration.host + resource_path + else: + # use server/host defined in path or operation instead + url = _host + resource_path + + try: + # perform request and return response + response_data = {{#asyncio}}await {{/asyncio}}{{#tornado}}yield {{/tornado}}self.request( + method, url, query_params=query_params, headers=header_params, + post_params=post_params, body=body, + _preload_content=_preload_content, + _request_timeout=_request_timeout) + except ApiException as e: + e.body = e.body.decode('utf-8') + raise e + + self.last_response = response_data + + return_data = response_data + + if not _preload_content: + {{^tornado}} + return (return_data) + {{/tornado}} + {{#tornado}} + raise tornado.gen.Return(return_data) + {{/tornado}} + return return_data + + # deserialize response data + if response_type: + if response_type != (file_type,): + encoding = "utf-8" + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) + if match: + encoding = match.group(1) + response_data.data = response_data.data.decode(encoding) + + return_data = self.deserialize( + response_data, + response_type, + _check_type + ) + else: + return_data = None + +{{^tornado}} + if _return_http_data_only: + return (return_data) + else: + return (return_data, response_data.status, + response_data.getheaders()) +{{/tornado}} +{{#tornado}} + if _return_http_data_only: + raise tornado.gen.Return(return_data) + else: + raise tornado.gen.Return((return_data, response_data.status, + response_data.getheaders())) +{{/tornado}} + + def parameters_to_multipart(self, params, collection_types): + """Get parameters as list of tuples, formatting as json if value is collection_types + + :param params: Parameters as list of two-tuples + :param dict collection_types: Parameter collection types + :return: Parameters as list of tuple or urllib3.fields.RequestField + """ + new_params = [] + if collection_types is None: + collection_types = (dict) + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if isinstance(v, collection_types): # v is instance of collection_type, formatting as application/json + v = json.dumps(v, ensure_ascii=False).encode("utf-8") + field = RequestField(k, v) + field.make_multipart(content_type="application/json; charset=utf-8") + new_params.append(field) + else: + new_params.append((k, v)) + return new_params + + @classmethod + def sanitize_for_serialization(cls, obj): + """Prepares data for transmission before it is sent with the rest client + If obj is None, return None. + If obj is str, int, long, float, bool, return directly. + If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. + If obj is list, sanitize each element in the list. + If obj is dict, return the dict. + If obj is OpenAPI model, return the properties dict. + If obj is io.IOBase, return the bytes + :param obj: The data to serialize. + :return: The serialized form of data. + """ + if isinstance(obj, (ModelNormal, ModelComposed)): + return { + key: cls.sanitize_for_serialization(val) for key, val in model_to_dict(obj, serialize=True).items() + } + elif isinstance(obj, io.IOBase): + return cls.get_file_data_and_close_file(obj) + elif isinstance(obj, (str, int, float, none_type, bool)): + return obj + elif isinstance(obj, (datetime, date)): + return obj.isoformat() + elif isinstance(obj, ModelSimple): + return cls.sanitize_for_serialization(obj.value) + elif isinstance(obj, (list, tuple)): + return [cls.sanitize_for_serialization(item) for item in obj] + if isinstance(obj, dict): + return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} + raise ApiValueError('Unable to prepare type {} for serialization'.format(obj.__class__.__name__)) + + def deserialize(self, response, response_type, _check_type): + """Deserializes response into an object. + + :param response: RESTResponse object to be deserialized. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param _check_type: boolean, whether to check the types of the data + received from the server + :type _check_type: bool + + :return: deserialized object. + """ + # handle file downloading + # save response body into a tmp file and return the instance + if response_type == (file_type,): + content_disposition = response.getheader("Content-Disposition") + return deserialize_file(response.data, self.configuration, + content_disposition=content_disposition) + + # fetch data from response object + try: + received_data = json.loads(response.data) + except ValueError: + received_data = response.data + + # store our data under the key of 'received_data' so users have some + # context if they are deserializing a string and the data type is wrong + deserialized_data = validate_and_convert_types( + received_data, + response_type, + ['received_data'], + True, + _check_type, + configuration=self.configuration + ) + return deserialized_data + + def call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + async_req: typing.Optional[bool] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None + ): + """Makes the HTTP request (synchronous) and returns deserialized data. + + To make an async_req request, set the async_req parameter. + + :param resource_path: Path to method endpoint. + :param method: Method to call. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param files: key -> field name, value -> a list of open file + objects for `multipart/form-data`. + :type files: dict + :param async_req bool: execute request asynchronously + :type async_req: bool, optional + :param _return_http_data_only: response data without head status code + and headers + :type _return_http_data_only: bool, optional + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :type collection_formats: dict, optional + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :type _preload_content: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _check_type: boolean describing if the data back from the server + should have its type checked. + :type _check_type: bool, optional + :return: + If async_req parameter is True, + the request will be called asynchronously. + The method will return the request thread. + If parameter async_req is False or missing, + then the method will return the response directly. + """ + if not async_req: + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, + _preload_content, _request_timeout, _host, + _check_type) + + return self.pool.apply_async(self.__call_api, (resource_path, + method, path_params, + query_params, + header_params, body, + post_params, files, + response_type, + auth_settings, + _return_http_data_only, + collection_formats, + _preload_content, + _request_timeout, + _host, _check_type)) + + def request(self, method, url, query_params=None, headers=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + """Makes the HTTP request using RESTClient.""" + if method == "GET": + return self.rest_client.GET(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "HEAD": + return self.rest_client.HEAD(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "OPTIONS": + return self.rest_client.OPTIONS(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "POST": + return self.rest_client.POST(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PUT": + return self.rest_client.PUT(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PATCH": + return self.rest_client.PATCH(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "DELETE": + return self.rest_client.DELETE(url, + query_params=query_params, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + else: + raise ApiValueError( + "http method must be `GET`, `HEAD`, `OPTIONS`," + " `POST`, `PATCH`, `PUT` or `DELETE`." + ) + + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + + @staticmethod + def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: + file_data = file_instance.read() + file_instance.close() + return file_data + + def files_parameters(self, files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None): + """Builds form parameters. + + :param files: None or a dict with key=param_name and + value is a list of open file objects + :return: List of tuples of form parameters with file data + """ + if files is None: + return [] + + params = [] + for param_name, file_instances in files.items(): + if file_instances is None: + # if the file field is nullable, skip None values + continue + for file_instance in file_instances: + if file_instance is None: + # if the file field is nullable, skip None values + continue + if file_instance.closed is True: + raise ApiValueError( + "Cannot read a closed file. The passed in file_type " + "for %s must be open." % param_name + ) + filename = os.path.basename(file_instance.name) + filedata = self.get_file_data_and_close_file(file_instance) + mimetype = (mimetypes.guess_type(filename)[0] or + 'application/octet-stream') + params.append( + tuple([param_name, tuple([filename, filedata, mimetype])])) + + return params + + def select_header_accept(self, accepts): + """Returns `Accept` based on an array of accepts provided. + + :param accepts: List of headers. + :return: Accept (e.g. application/json). + """ + if not accepts: + return + + accepts = [x.lower() for x in accepts] + + if 'application/json' in accepts: + return 'application/json' + else: + return ', '.join(accepts) + + def select_header_content_type(self, content_types): + """Returns `Content-Type` based on an array of content_types provided. + + :param content_types: List of content-types. + :return: Content-Type (e.g. application/json). + """ + if not content_types: + return 'application/json' + + content_types = [x.lower() for x in content_types] + + if 'application/json' in content_types or '*/*' in content_types: + return 'application/json' + else: + return content_types[0] + + def update_params_for_auth(self, headers, querys, auth_settings, + resource_path, method, body): + """Updates header and query params based on authentication setting. + + :param headers: Header parameters dict to be updated. + :param querys: Query parameters tuple list to be updated. + :param auth_settings: Authentication setting identifiers list. + :param resource_path: A string representation of the HTTP request resource path. + :param method: A string representation of the HTTP request method. + :param body: A object representing the body of the HTTP request. + The object type is the return value of _encoder.default(). + """ + if not auth_settings: + return + + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + if auth_setting['in'] == 'cookie': + headers['Cookie'] = auth_setting['value'] + elif auth_setting['in'] == 'header': + if auth_setting['type'] != 'http-signature': + headers[auth_setting['key']] = auth_setting['value'] +{{#hasHttpSignatureMethods}} + else: + # The HTTP signature scheme requires multiple HTTP headers + # that are calculated dynamically. + signing_info = self.configuration.signing_info + auth_headers = signing_info.get_http_signature_headers( + resource_path, method, headers, body, querys) + headers.update(auth_headers) +{{/hasHttpSignatureMethods}} + elif auth_setting['in'] == 'query': + querys.append((auth_setting['key'], auth_setting['value'])) + else: + raise ApiValueError( + 'Authentication token must be in `query` or `header`' + ) + + +class Endpoint(object): + def __init__(self, settings=None, params_map=None, root_map=None, + headers_map=None, api_client=None, callable=None): + """Creates an endpoint + + Args: + settings (dict): see below key value pairs + 'response_type' (tuple/None): response type + 'auth' (list): a list of auth type keys + 'endpoint_path' (str): the endpoint path + 'operation_id' (str): endpoint string identifier + 'http_method' (str): POST/PUT/PATCH/GET etc + 'servers' (list): list of str servers that this endpoint is at + params_map (dict): see below key value pairs + 'all' (list): list of str endpoint parameter names + 'required' (list): list of required parameter names + 'nullable' (list): list of nullable parameter names + 'enum' (list): list of parameters with enum values + 'validation' (list): list of parameters with validations + root_map + 'validations' (dict): the dict mapping endpoint parameter tuple + paths to their validation dictionaries + 'allowed_values' (dict): the dict mapping endpoint parameter + tuple paths to their allowed_values (enum) dictionaries + 'openapi_types' (dict): param_name to openapi type + 'attribute_map' (dict): param_name to camelCase name + 'location_map' (dict): param_name to 'body', 'file', 'form', + 'header', 'path', 'query' + collection_format_map (dict): param_name to `csv` etc. + headers_map (dict): see below key value pairs + 'accept' (list): list of Accept header strings + 'content_type' (list): list of Content-Type header strings + api_client (ApiClient) api client instance + callable (function): the function which is invoked when the + Endpoint is called + """ + self.settings = settings + self.params_map = params_map + self.params_map['all'].extend([ + 'async_req', + '_host_index', + '_preload_content', + '_request_timeout', + '_return_http_data_only', + '_check_input_type', + '_check_return_type' + ]) + self.params_map['nullable'].extend(['_request_timeout']) + self.validations = root_map['validations'] + self.allowed_values = root_map['allowed_values'] + self.openapi_types = root_map['openapi_types'] + extra_types = { + 'async_req': (bool,), + '_host_index': (none_type, int), + '_preload_content': (bool,), + '_request_timeout': (none_type, int, (int,), [int]), + '_return_http_data_only': (bool,), + '_check_input_type': (bool,), + '_check_return_type': (bool,) + } + self.openapi_types.update(extra_types) + self.attribute_map = root_map['attribute_map'] + self.location_map = root_map['location_map'] + self.collection_format_map = root_map['collection_format_map'] + self.headers_map = headers_map + self.api_client = api_client + self.callable = callable + + def __validate_inputs(self, kwargs): + for param in self.params_map['enum']: + if param in kwargs: + check_allowed_values( + self.allowed_values, + (param,), + kwargs[param] + ) + + for param in self.params_map['validation']: + if param in kwargs: + check_validations( + self.validations, + (param,), + kwargs[param], + configuration=self.api_client.configuration + ) + + if kwargs['_check_input_type'] is False: + return + + for key, value in kwargs.items(): + fixed_val = validate_and_convert_types( + value, + self.openapi_types[key], + [key], + False, + kwargs['_check_input_type'], + configuration=self.api_client.configuration + ) + kwargs[key] = fixed_val + + def __gather_params(self, kwargs): + params = { + 'body': None, + 'collection_format': {}, + 'file': {}, + 'form': [], + 'header': {}, + 'path': {}, + 'query': [] + } + + for param_name, param_value in kwargs.items(): + param_location = self.location_map.get(param_name) + if param_location is None: + continue + if param_location: + if param_location == 'body': + params['body'] = param_value + continue + base_name = self.attribute_map[param_name] + if (param_location == 'form' and + self.openapi_types[param_name] == (file_type,)): + params['file'][param_name] = [param_value] + elif (param_location == 'form' and + self.openapi_types[param_name] == ([file_type],)): + # param_value is already a list + params['file'][param_name] = param_value + elif param_location in {'form', 'query'}: + param_value_full = (base_name, param_value) + params[param_location].append(param_value_full) + if param_location not in {'form', 'query'}: + params[param_location][base_name] = param_value + collection_format = self.collection_format_map.get(param_name) + if collection_format: + params['collection_format'][base_name] = collection_format + + return params + + def __call__(self, *args, **kwargs): + """ This method is invoked when endpoints are called + Example: +{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}} + api_instance = {{classname}}() + api_instance.{{operationId}} # this is an instance of the class Endpoint + api_instance.{{operationId}}() # this invokes api_instance.{{operationId}}.__call__() + which then invokes the callable functions stored in that endpoint at + api_instance.{{operationId}}.callable or self.callable in this class +{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}} + """ + return self.callable(self, *args, **kwargs) + + def call_with_http_info(self, **kwargs): + + is_unstable = self.api_client.configuration.unstable_operations.get(self.settings['operation_id']) + if is_unstable: + warnings.warn("Using unstable operation '{0}'".format(self.settings['operation_id'])) + elif is_unstable is False: + raise ApiValueError("Unstable operation '{0}' is disabled".format(self.settings['operation_id'])) + + try: + index = self.api_client.configuration.server_operation_index.get( + self.settings['operation_id'], self.api_client.configuration.server_index + ) if kwargs['_host_index'] is None else kwargs['_host_index'] + server_variables = self.api_client.configuration.server_operation_variables.get( + self.settings['operation_id'], self.api_client.configuration.server_variables + ) + _host = self.api_client.configuration.get_host_from_settings( + index, variables=server_variables, servers=self.settings['servers'] + ) + except IndexError: + if self.settings['servers']: + raise ApiValueError( + "Invalid host index. Must be 0 <= index < %s" % + len(self.settings['servers']) + ) + _host = None + + for key, value in kwargs.items(): + if key not in self.params_map['all']: + raise ApiTypeError( + "Got an unexpected parameter '%s'" + " to method `%s`" % + (key, self.settings['operation_id']) + ) + # only throw this nullable ApiValueError if _check_input_type + # is False, if _check_input_type==True we catch this case + # in self.__validate_inputs + if (key not in self.params_map['nullable'] and value is None + and kwargs['_check_input_type'] is False): + raise ApiValueError( + "Value may not be None for non-nullable parameter `%s`" + " when calling `%s`" % + (key, self.settings['operation_id']) + ) + + for key in self.params_map['required']: + if key not in kwargs.keys(): + raise ApiValueError( + "Missing the required parameter `%s` when calling " + "`%s`" % (key, self.settings['operation_id']) + ) + + self.__validate_inputs(kwargs) + + params = self.__gather_params(kwargs) + params['header']['Dd-Operation-Id'] = ''.join(x.title() for x in self.settings['operation_id'].split('_')) + + accept_headers_list = self.headers_map['accept'] + if accept_headers_list: + params['header']['Accept'] = self.api_client.select_header_accept( + accept_headers_list) + + content_type_headers_list = self.headers_map['content_type'] + if content_type_headers_list: + header_list = self.api_client.select_header_content_type( + content_type_headers_list) + params['header']['Content-Type'] = header_list + + return self.api_client.call_api( + self.settings['endpoint_path'], self.settings['http_method'], + params['path'], + params['query'], + params['header'], + body=params['body'], + post_params=params['form'], + files=params['file'], + response_type=self.settings['response_type'], + auth_settings=self.settings['auth'], + async_req=kwargs['async_req'], + _check_type=kwargs['_check_return_type'], + _return_http_data_only=kwargs['_return_http_data_only'], + _preload_content=kwargs['_preload_content'], + _request_timeout=kwargs['_request_timeout'], + _host=_host, + collection_formats=params['collection_format']) + + +def user_agent(): + """Generate default User-Agent header.""" + import platform + from datadog_api_client.version import __version__ + return "datadog-api-client-python/{version} (python {py}; os {os}; arch {arch})".format( + version=__version__, + py=platform.python_version(), + os=platform.system(), + arch=platform.machine(), + ) diff --git a/.generator/templates/api_doc.mustache b/.generator/templates/api_doc.mustache new file mode 100644 index 0000000000..3946bfa584 --- /dev/null +++ b/.generator/templates/api_doc.mustache @@ -0,0 +1,77 @@ +# {{packageName}}.{{classname}}{{#description}} +{{description}}{{/description}} + +All URIs are relative to *{{basePath}}* + +Method | HTTP request | Description +------------- | ------------- | ------------- +{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} +{{/operation}}{{/operations}} + +{{#operations}} +{{#operation}} +# **{{{operationId}}}** +> {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}}) + +{{{summary}}}{{#notes}} + +{{{notes}}}{{/notes}} + +### Example + +{{#hasAuthMethods}} +{{#authMethods}} +{{#isBasic}} +{{#isBasicBasic}} +* Basic Authentication ({{name}}): +{{/isBasicBasic}} +{{#isBasicBearer}} +* Bearer{{#bearerFormat}} ({{{.}}}){{/bearerFormat}} Authentication ({{name}}): +{{/isBasicBearer}} +{{/isBasic}} +{{#isApiKey}} +* Api Key Authentication ({{name}}): +{{/isApiKey }} +{{#isOAuth}} +* OAuth Authentication ({{name}}): +{{/isOAuth }} +{{/authMethods}} +{{/hasAuthMethods}} +{{> api_doc_example }} + +### Parameters +{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} +Name | Type | Description | Notes +------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} +{{#requiredParams}}{{^defaultValue}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | +{{/defaultValue}}{{/requiredParams}}{{#requiredParams}}{{#defaultValue}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | defaults to {{{.}}} +{{/defaultValue}}{{/requiredParams}}{{#optionalParams}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | [optional]{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} +{{/optionalParams}} + +### Return type + +{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} + +### Authorization + +{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} + +### HTTP request headers + + - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} + - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} + +{{#responses.0}} + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +{{#responses}} +**{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}} | +{{/responses}} +{{/responses.0}} + +[[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) + +{{/operation}} +{{/operations}} diff --git a/.generator/templates/api_doc_example.mustache b/.generator/templates/api_doc_example.mustache new file mode 100644 index 0000000000..17bfe3795b --- /dev/null +++ b/.generator/templates/api_doc_example.mustache @@ -0,0 +1,75 @@ +```python +import os +from dateutil.parser import parse as dateutil_parser +from {{{packageName}}} import ApiClient, ApiException, Configuration +from {{apiPackage}} import {{classVarName}} +from {{{packageName}}}.models import * +from pprint import pprint +{{> python_doc_auth_partial}} +# Enter a context with an instance of the API client +{{#hasAuthMethods}} +with ApiClient(configuration) as api_client: +{{/hasAuthMethods}} +{{^hasAuthMethods}} +with ApiClient() as api_client: +{{/hasAuthMethods}} + # Create an instance of the API class + api_instance = {{classVarName}}.{{{classname}}}(api_client) +{{#requiredParams}} +{{^defaultValue}} + {{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}} +{{/defaultValue}} +{{/requiredParams}} +{{#optionalParams}} + {{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/defaultValue}} +{{/optionalParams}} +{{#requiredParams}} +{{#-last}} + + # example passing only required values which don't have defaults set + try: +{{#summary}} + # {{{.}}} +{{/summary}} + {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}}) +{{#returnType}} + pprint(api_response) +{{/returnType}} + except ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/-last}} +{{/requiredParams}} +{{#optionalParams}} +{{#-last}} + + # example passing only required values which don't have defaults set + # and optional values + try: +{{#summary}} + # {{{.}}} +{{/summary}} + {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}, {{/defaultValue}}{{/requiredParams}}{{#optionalParams}}{{paramName}}={{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}) +{{#returnType}} + pprint(api_response) +{{/returnType}} + except ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/-last}} +{{/optionalParams}} +{{^requiredParams}} +{{^optionalParams}} + + # example, this endpoint has no required or optional parameters + try: +{{#summary}} + # {{{.}}} +{{/summary}} + {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}() +{{#returnType}} + pprint(api_response) +{{/returnType}} + except ApiException as e: + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) +{{/optionalParams}} +{{/requiredParams}} +``` diff --git a/.generator/templates/api_test.mustache b/.generator/templates/api_test.mustache new file mode 100644 index 0000000000..bf2cd19285 --- /dev/null +++ b/.generator/templates/api_test.mustache @@ -0,0 +1,32 @@ +{{>partial_header}} + +import unittest + +import {{packageName}} +from {{apiPackage}}.{{classVarName}} import {{classname}} # noqa: E501 + + +class {{#operations}}Test{{classname}}(unittest.TestCase): + """{{classname}} unit test stubs""" + + def setUp(self): + self.api = {{classname}}() # noqa: E501 + + def tearDown(self): + pass + + {{#operation}} + def test_{{operationId}}(self): + """Test case for {{{operationId}}} + +{{#summary}} + {{{summary}}} # noqa: E501 +{{/summary}} + """ + pass + + {{/operation}} +{{/operations}} + +if __name__ == '__main__': + unittest.main() diff --git a/.generator/templates/asyncio/rest.mustache b/.generator/templates/asyncio/rest.mustache new file mode 100644 index 0000000000..3744b62c81 --- /dev/null +++ b/.generator/templates/asyncio/rest.mustache @@ -0,0 +1,236 @@ +{{>partial_header}} + +import io +import json +import logging +import re +import ssl + +import aiohttp +# python 2 and python 3 compatibility library +from six.moves.urllib.parse import urlencode + +from {{packageName}}.exceptions import ApiException, ApiValueError + +logger = logging.getLogger(__name__) + + +class RESTResponse(io.IOBase): + + def __init__(self, resp, data): + self.aiohttp_response = resp + self.status = resp.status + self.reason = resp.reason + self.data = data + + def getheaders(self): + """Returns a CIMultiDictProxy of the response headers.""" + return self.aiohttp_response.headers + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.aiohttp_response.headers.get(name, default) + + +class RESTClientObject(object): + + def __init__(self, configuration, pools_size=4, maxsize=None): + + # maxsize is number of requests to host that are allowed in parallel + if maxsize is None: + maxsize = configuration.connection_pool_maxsize + + ssl_context = ssl.create_default_context(cafile=configuration.ssl_ca_cert) + if configuration.cert_file: + ssl_context.load_cert_chain( + configuration.cert_file, keyfile=configuration.key_file + ) + + if not configuration.verify_ssl: + ssl_context.check_hostname = False + ssl_context.verify_mode = ssl.CERT_NONE + + connector = aiohttp.TCPConnector( + limit=maxsize, + ssl=ssl_context + ) + + self.proxy = configuration.proxy + self.proxy_headers = configuration.proxy_headers + + # https pool manager + self.pool_manager = aiohttp.ClientSession( + connector=connector + ) + + async def close(self): + await self.pool_manager.close() + + async def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + """Execute request + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _preload_content: this is a non-applicable field for + the AiohttpClient. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + """ + method = method.upper() + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + timeout = _request_timeout or 5 * 60 + + if 'Content-Type' not in headers: + headers['Content-Type'] = 'application/json' + + args = { + "method": method, + "url": url, + "timeout": timeout, + "headers": headers + } + + if self.proxy: + args["proxy"] = self.proxy + if self.proxy_headers: + args["proxy_headers"] = self.proxy_headers + + if query_params: + args["url"] += '?' + urlencode(query_params) + + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + if re.search('json', headers['Content-Type'], re.IGNORECASE): + if body is not None: + body = json.dumps(body) + args["data"] = body + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + args["data"] = aiohttp.FormData(post_params) + elif headers['Content-Type'] == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by aiohttp + del headers['Content-Type'] + data = aiohttp.FormData() + for param in post_params: + k, v = param + if isinstance(v, tuple) and len(v) == 3: + data.add_field(k, + value=v[1], + filename=v[0], + content_type=v[2]) + else: + data.add_field(k, v) + args["data"] = data + + # Pass a `bytes` parameter directly in the body to support + # other content types than Json when `body` argument is provided + # in serialized form + elif isinstance(body, bytes): + args["data"] = body + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + + r = await self.pool_manager.request(**args) + if _preload_content: + + data = await r.read() + r = RESTResponse(r, data) + + # log response body + logger.debug("response body: %s", r.data) + + if not 200 <= r.status <= 299: + raise ApiException(http_resp=r) + + return r + + async def GET(self, url, headers=None, query_params=None, + _preload_content=True, _request_timeout=None): + return (await self.request("GET", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params)) + + async def HEAD(self, url, headers=None, query_params=None, + _preload_content=True, _request_timeout=None): + return (await self.request("HEAD", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params)) + + async def OPTIONS(self, url, headers=None, query_params=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + return (await self.request("OPTIONS", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body)) + + async def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): + return (await self.request("DELETE", url, + headers=headers, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body)) + + async def POST(self, url, headers=None, query_params=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + return (await self.request("POST", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body)) + + async def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return (await self.request("PUT", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body)) + + async def PATCH(self, url, headers=None, query_params=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + return (await self.request("PATCH", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body)) diff --git a/.generator/templates/configuration.mustache b/.generator/templates/configuration.mustache new file mode 100644 index 0000000000..92dc64f41d --- /dev/null +++ b/.generator/templates/configuration.mustache @@ -0,0 +1,641 @@ +{{>partial_header}} + +import copy +import logging +{{^asyncio}} +import multiprocessing +{{/asyncio}} +import sys +import urllib3 + +from http import client as http_client +from {{packageName}}.exceptions import ApiValueError + + +JSON_SCHEMA_VALIDATION_KEYWORDS = { + 'multipleOf', 'maximum', 'exclusiveMaximum', + 'minimum', 'exclusiveMinimum', 'maxLength', + 'minLength', 'pattern', 'maxItems', 'minItems' +} + +class Configuration(object): + """NOTE: This class is auto generated by OpenAPI Generator + + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param host: Base url + :param api_key: Dict to store API key(s). + Each entry in the dict specifies an API key. + The dict key is the name of the security scheme in the OAS specification. + The dict value is the API key secret. + :param api_key_prefix: Dict to store API prefix (e.g. Bearer) + The dict key is the name of the security scheme in the OAS specification. + The dict value is an API key prefix when generating the auth data. + :param username: Username for HTTP basic authentication + :param password: Password for HTTP basic authentication + :param discard_unknown_keys: Boolean value indicating whether to discard + unknown properties. A server may send a response that includes additional + properties that are not known by the client in the following scenarios: + 1. The OpenAPI document is incomplete, i.e. it does not match the server + implementation. + 2. The client was generated using an older version of the OpenAPI document + and the server has been upgraded since then. + If a schema in the OpenAPI document defines the additionalProperties attribute, + then all undeclared properties received by the server are injected into the + additional properties map. In that case, there are undeclared properties, and + nothing to discard. + :param disabled_client_side_validations (string): Comma-separated list of + JSON schema validation keywords to disable JSON schema structural validation + rules. The following keywords may be specified: multipleOf, maximum, + exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, + maxItems, minItems. + By default, the validation is performed for data generated locally by the client + and data received from the server, independent of any validation performed by + the server side. If the input data does not satisfy the JSON schema validation + rules specified in the OpenAPI document, an exception is raised. + If disabled_client_side_validations is set, structural validation is + disabled. This can be useful to troubleshoot data validation problem, such as + when the OpenAPI document validation rules do not match the actual API data + received by the server. +{{#hasHttpSignatureMethods}} + :param signing_info: Configuration parameters for the HTTP signature security scheme. + Must be an instance of {{{packageName}}}.signing.HttpSigningConfiguration +{{/hasHttpSignatureMethods}} + :param server_index: Index to servers configuration. + :param server_variables: Mapping with string values to replace variables in + templated server configuration. The validation of enums is performed for + variables with defined enum values before. + :param server_operation_index: Mapping from operation ID to an index to server + configuration. + :param server_operation_variables: Mapping from operation ID to a mapping with + string values to replace variables in templated server configuration. + The validation of enums is performed for variables with defined enum values before. + :param ssl_ca_cert: str - the path to a file of concatenated CA certificates + in PEM format + +{{#hasAuthMethods}} + :Example: +{{#hasApiKeyMethods}} + + API Key Authentication Example. + Given the following security scheme in the OpenAPI specification: + components: + securitySchemes: + cookieAuth: # name for the security scheme + type: apiKey + in: cookie + name: JSESSIONID # cookie name + + You can programmatically set the cookie: + +conf = {{{packageName}}}.Configuration( + api_key={'cookieAuth': 'abc123'} + api_key_prefix={'cookieAuth': 'JSESSIONID'} +) + + The following cookie will be added to the HTTP request: + Cookie: JSESSIONID abc123 +{{/hasApiKeyMethods}} +{{#hasHttpBasicMethods}} + + HTTP Basic Authentication Example. + Given the following security scheme in the OpenAPI specification: + components: + securitySchemes: + http_basic_auth: + type: http + scheme: basic + + Configure API client with HTTP basic authentication: + +conf = {{{packageName}}}.Configuration( + username='the-user', + password='the-password', +) + +{{/hasHttpBasicMethods}} +{{#hasHttpSignatureMethods}} + + HTTP Signature Authentication Example. + Given the following security scheme in the OpenAPI specification: + components: + securitySchemes: + http_basic_auth: + type: http + scheme: signature + + Configure API client with HTTP signature authentication. Use the 'hs2019' signature scheme, + sign the HTTP requests with the RSA-SSA-PSS signature algorithm, and set the expiration time + of the signature to 5 minutes after the signature has been created. + Note you can use the constants defined in the {{{packageName}}}.signing module, and you can + also specify arbitrary HTTP headers to be included in the HTTP signature, except for the + 'Authorization' header, which is used to carry the signature. + + One may be tempted to sign all headers by default, but in practice it rarely works. + This is beccause explicit proxies, transparent proxies, TLS termination endpoints or + load balancers may add/modify/remove headers. Include the HTTP headers that you know + are not going to be modified in transit. + +conf = {{{packageName}}}.Configuration( + signing_info = {{{packageName}}}.signing.HttpSigningConfiguration( + key_id = 'my-key-id', + private_key_path = 'rsa.pem', + signing_scheme = {{{packageName}}}.signing.SCHEME_HS2019, + signing_algorithm = {{{packageName}}}.signing.ALGORITHM_RSASSA_PSS, + signed_headers = [{{{packageName}}}.signing.HEADER_REQUEST_TARGET, + {{{packageName}}}.signing.HEADER_CREATED, + {{{packageName}}}.signing.HEADER_EXPIRES, + {{{packageName}}}.signing.HEADER_HOST, + {{{packageName}}}.signing.HEADER_DATE, + {{{packageName}}}.signing.HEADER_DIGEST, + 'Content-Type', + 'User-Agent' + ], + signature_max_validity = datetime.timedelta(minutes=5) + ) +) +{{/hasHttpSignatureMethods}} +{{/hasAuthMethods}} + """ + + _default = None + + def __init__(self, host=None, + api_key=None, api_key_prefix=None, + access_token=None, + username=None, password=None, + discard_unknown_keys=True, + disabled_client_side_validations="", +{{#hasHttpSignatureMethods}} + signing_info=None, +{{/hasHttpSignatureMethods}} + server_index=None, server_variables=None, + server_operation_index=None, server_operation_variables=None, + ssl_ca_cert=None, + ): + """Constructor + """ + self._base_path = "{{{basePath}}}" if host is None else host + """Default Base url + """ + self.server_index = 0 if server_index is None and host is None else server_index + self.server_operation_index = server_operation_index or {} + """Default server index + """ + self.server_variables = server_variables or {} + self.server_operation_variables = server_operation_variables or {} + """Default server variables + """ + self.temp_folder_path = None + """Temp file folder for downloading files + """ + # Authentication Settings + self.access_token = access_token + self.api_key = {} + if api_key: + self.api_key = api_key + """dict to store API key(s) + """ + self.api_key_prefix = {} + if api_key_prefix: + self.api_key_prefix = api_key_prefix + """dict to store API prefix (e.g. Bearer) + """ + self.refresh_api_key_hook = None + """function hook to refresh API key if expired + """ + self.username = username + """Username for HTTP basic authentication + """ + self.password = password + """Password for HTTP basic authentication + """ + self.discard_unknown_keys = discard_unknown_keys + self.disabled_client_side_validations = disabled_client_side_validations +{{#hasHttpSignatureMethods}} + if signing_info is not None: + signing_info.host = host + self.signing_info = signing_info + """The HTTP signing configuration + """ +{{/hasHttpSignatureMethods}} + self.logger = {} + """Logging Settings + """ + self.logger["package_logger"] = logging.getLogger("{{packageName}}") + self.logger["urllib3_logger"] = logging.getLogger("urllib3") + self.logger_format = '%(asctime)s %(levelname)s %(message)s' + """Log format + """ + self.logger_stream_handler = None + """Log stream handler + """ + self.logger_file_handler = None + """Log file handler + """ + self.logger_file = None + """Debug file location + """ + self.debug = False + """Debug switch + """ + + self.verify_ssl = True + """SSL/TLS verification + Set this to false to skip verifying SSL certificate when calling API + from https server. + """ + self.ssl_ca_cert = ssl_ca_cert + """Set this to customize the certificate file to verify the peer. + """ + self.cert_file = None + """client certificate file + """ + self.key_file = None + """client key file + """ + self.assert_hostname = None + """Set this to True/False to enable/disable SSL hostname verification. + """ + + {{#asyncio}} + self.connection_pool_maxsize = 100 + """This value is passed to the aiohttp to limit simultaneous connections. + Default values is 100, None means no-limit. + """ + {{/asyncio}} + {{^asyncio}} + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. + """ + {{/asyncio}} + + self.proxy = None + """Proxy URL + """ + self.proxy_headers = None + """Proxy headers + """ + self.safe_chars_for_path_param = '' + """Safe chars for path_param + """ + self.retries = None + """Adding retries to override urllib3 default value 3 + """ + # Enable client side validation + self.client_side_validation = True + + # Options to pass down to the underlying urllib3 socket + self.socket_options = None + + # Keep track of unstable operations + self.unstable_operations = { + {{#apiInfo}} + {{#apis}} + {{#operations}} + {{#operation}} + {{#vendorExtensions.x-unstable}} + "{{operationId}}": False, + {{/vendorExtensions.x-unstable}} + {{/operation}} + {{/operations}} + {{/apis}} + {{/apiInfo}} + } + + def __deepcopy__(self, memo): + cls = self.__class__ + result = cls.__new__(cls) + memo[id(self)] = result + for k, v in self.__dict__.items(): + if k not in ('logger', 'logger_file_handler'): + setattr(result, k, copy.deepcopy(v, memo)) + # shallow copy of loggers + result.logger = copy.copy(self.logger) + # use setters to configure loggers + result.logger_file = self.logger_file + result.debug = self.debug + return result + + def __setattr__(self, name, value): + object.__setattr__(self, name, value) + if name == 'disabled_client_side_validations': + s = set(filter(None, value.split(','))) + for v in s: + if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: + raise ApiValueError( + "Invalid keyword: '{0}''".format(v)) + self._disabled_client_side_validations = s +{{#hasHttpSignatureMethods}} + if name == "signing_info" and value is not None: + # Ensure the host paramater from signing info is the same as + # Configuration.host. + value.host = self.host +{{/hasHttpSignatureMethods}} + + @classmethod + def set_default(cls, default): + """Set default instance of configuration. + + It stores default configuration, which can be + returned by get_default_copy method. + + :param default: object of Configuration + """ + cls._default = copy.deepcopy(default) + + @classmethod + def get_default_copy(cls): + """Return new instance of configuration. + + This method returns newly created, based on default constructor, + object of Configuration class or returns a copy of default + configuration passed by the set_default method. + + :return: The configuration object. + """ + if cls._default is not None: + return copy.deepcopy(cls._default) + return Configuration() + + @property + def logger_file(self): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + return self.__logger_file + + @logger_file.setter + def logger_file(self, value): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + self.__logger_file = value + if self.__logger_file: + # If set logging file, + # then add file handler and remove stream handler. + self.logger_file_handler = logging.FileHandler(self.__logger_file) + self.logger_file_handler.setFormatter(self.logger_formatter) + for _, logger in self.logger.items(): + logger.addHandler(self.logger_file_handler) + + @property + def debug(self): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + return self.__debug + + @debug.setter + def debug(self, value): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + self.__debug = value + if self.__debug: + # if debug status is True, turn on debug logging + for _, logger in self.logger.items(): + logger.setLevel(logging.DEBUG) + # turn on http_client debug + http_client.HTTPConnection.debuglevel = 1 + else: + # if debug status is False, turn off debug logging, + # setting log level to default `logging.WARNING` + for _, logger in self.logger.items(): + logger.setLevel(logging.WARNING) + # turn off http_client debug + http_client.HTTPConnection.debuglevel = 0 + + @property + def logger_format(self): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + return self.__logger_format + + @logger_format.setter + def logger_format(self, value): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + self.__logger_format = value + self.logger_formatter = logging.Formatter(self.__logger_format) + + def get_api_key_with_prefix(self, identifier, alias=None): + """Gets API key (with prefix if set). + + :param identifier: The identifier of apiKey. + :param alias: The alternative identifier of apiKey. + :return: The token for api key authentication. + """ + if self.refresh_api_key_hook is not None: + self.refresh_api_key_hook(self) + key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) + if key: + prefix = self.api_key_prefix.get(identifier) + if prefix: + return "%s %s" % (prefix, key) + else: + return key + + def get_basic_auth_token(self): + """Gets HTTP basic authentication header (string). + + :return: The token for basic HTTP authentication. + """ + username = "" + if self.username is not None: + username = self.username + password = "" + if self.password is not None: + password = self.password + return urllib3.util.make_headers( + basic_auth=username + ':' + password + ).get('authorization') + + def auth_settings(self): + """Gets Auth Settings dict for api client. + + :return: The Auth Settings information dict. + """ + auth = {} +{{#authMethods}} +{{#isApiKey}} + if '{{name}}' in self.api_key{{#vendorExtensions.x-auth-id-alias}} or '{{.}}' in self.api_key{{/vendorExtensions.x-auth-id-alias}}: + auth['{{name}}'] = { + 'type': 'api_key', + 'in': {{#isKeyInCookie}}'cookie'{{/isKeyInCookie}}{{#isKeyInHeader}}'header'{{/isKeyInHeader}}{{#isKeyInQuery}}'query'{{/isKeyInQuery}}, + 'key': '{{keyParamName}}', + 'value': self.get_api_key_with_prefix( + '{{name}}',{{#vendorExtensions.x-auth-id-alias}} + alias='{{.}}',{{/vendorExtensions.x-auth-id-alias}} + ), + } +{{/isApiKey}} +{{#isBasic}} + {{#isBasicBasic}} + if self.username is not None and self.password is not None: + auth['{{name}}'] = { + 'type': 'basic', + 'in': 'header', + 'key': 'Authorization', + 'value': self.get_basic_auth_token() + } + {{/isBasicBasic}} + {{#isBasicBearer}} + if self.access_token is not None: + auth['{{name}}'] = { + 'type': 'bearer', + 'in': 'header', + {{#bearerFormat}} + 'format': '{{{.}}}', + {{/bearerFormat}} + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } + {{/isBasicBearer}} + {{#isHttpSignature}} + if self.signing_info is not None: + auth['{{name}}'] = { + 'type': 'http-signature', + 'in': 'header', + 'key': 'Authorization', + 'value': None # Signature headers are calculated for every HTTP request + } + {{/isHttpSignature}} +{{/isBasic}} +{{#isOAuth}} + if self.access_token is not None: + auth['{{name}}'] = { + 'type': 'oauth2', + 'in': 'header', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } +{{/isOAuth}} +{{/authMethods}} + return auth + + def to_debug_report(self): + """Gets the essential information for debugging. + + :return: The report for debugging. + """ + return "Python SDK Debug Report:\n"\ + "OS: {env}\n"\ + "Python Version: {pyversion}\n"\ + "Version of the API: {{version}}\n"\ + "SDK Package Version: {{packageVersion}}".\ + format(env=sys.platform, pyversion=sys.version) + + def get_host_settings(self): + """Gets an array of host settings + + :return: An array of host settings + """ + return [ + {{#servers}} + { + 'url': "{{{url}}}", + 'description': "{{{description}}}{{^description}}No description provided{{/description}}", + {{#variables}} + {{#-first}} + 'variables': { + {{/-first}} + '{{{name}}}': { + 'description': "{{{description}}}{{^description}}No description provided{{/description}}", + 'default_value': "{{{defaultValue}}}", + {{#enumValues}} + {{#-first}} + 'enum_values': [ + {{/-first}} + "{{{.}}}"{{^-last}},{{/-last}} + {{#-last}} + ] + {{/-last}} + {{/enumValues}} + }{{^-last}},{{/-last}} + {{#-last}} + } + {{/-last}} + {{/variables}} + }{{^-last}},{{/-last}} + {{/servers}} + ] + + def get_host_from_settings(self, index, variables=None, servers=None): + """Gets host URL based on the index and variables + :param index: array index of the host settings + :param variables: hash of variable and the corresponding value + :param servers: an array of host settings or None + :return: URL based on host settings + """ + if index is None: + return self._base_path + + variables = {} if variables is None else variables + servers = self.get_host_settings() if servers is None else servers + + try: + server = servers[index] + except IndexError: + raise ValueError( + "Invalid index {0} when selecting the host settings. " + "Must be less than {1}".format(index, len(servers))) + + url = server['url'] + + # go through variables and replace placeholders + for variable_name, variable in server.get('variables', {}).items(): + used_value = variables.get( + variable_name, variable['default_value']) + + if 'enum_values' in variable \ + and used_value not in variable['enum_values']: + raise ValueError( + "The variable `{0}` in the host URL has invalid value " + "{1}. Must be {2}.".format( + variable_name, variables[variable_name], + variable['enum_values'])) + + url = url.replace("{" + variable_name + "}", used_value) + + return url + + @property + def host(self): + """Return generated host.""" + return self.get_host_from_settings(self.server_index, variables=self.server_variables) + + @host.setter + def host(self, value): + """Fix base path.""" + self._base_path = value + self.server_index = None diff --git a/.generator/templates/exceptions.mustache b/.generator/templates/exceptions.mustache new file mode 100644 index 0000000000..046dcd9a5a --- /dev/null +++ b/.generator/templates/exceptions.mustache @@ -0,0 +1,151 @@ +{{>partial_header}} + + +class OpenApiException(Exception): + """The base exception class for all OpenAPIExceptions""" + + +class ApiTypeError(OpenApiException, TypeError): + def __init__(self, msg, path_to_item=None, valid_classes=None, + key_type=None): + """ Raises an exception for TypeErrors + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset + """ + self.path_to_item = path_to_item + self.valid_classes = valid_classes + self.key_type = key_type + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiTypeError, self).__init__(full_msg) + + +class ApiValueError(OpenApiException, ValueError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset + """ + + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiValueError, self).__init__(full_msg) + + +class ApiAttributeError(OpenApiException, AttributeError): + def __init__(self, msg, path_to_item=None): + """ + Raised when an attribute reference or assignment fails. + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiAttributeError, self).__init__(full_msg) + + +class ApiKeyError(OpenApiException, KeyError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiKeyError, self).__init__(full_msg) + + +class ApiException(OpenApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + if http_resp: + self.status = http_resp.status + self.reason = http_resp.reason + self.body = http_resp.data + self.headers = http_resp.getheaders() + else: + self.status = status + self.reason = reason + self.body = None + self.headers = None + + def __str__(self): + """Custom error messages for exception""" + error_message = "({0})\n"\ + "Reason: {1}\n".format(self.status, self.reason) + if self.headers: + error_message += "HTTP response headers: {0}\n".format( + self.headers) + + if self.body: + error_message += "HTTP response body: {0}\n".format(self.body) + + return error_message + + +class NotFoundException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(NotFoundException, self).__init__(status, reason, http_resp) + + +class UnauthorizedException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(UnauthorizedException, self).__init__(status, reason, http_resp) + + +class ForbiddenException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ForbiddenException, self).__init__(status, reason, http_resp) + + +class ServiceException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ServiceException, self).__init__(status, reason, http_resp) + + +def render_path(path_to_item): + """Returns a string representation of a path""" + result = "" + for pth in path_to_item: + if isinstance(pth, int): + result += "[{0}]".format(pth) + else: + result += "['{0}']".format(pth) + return result diff --git a/.generator/templates/git_push.sh.mustache b/.generator/templates/git_push.sh.mustache new file mode 100755 index 0000000000..8b3f689c91 --- /dev/null +++ b/.generator/templates/git_push.sh.mustache @@ -0,0 +1,58 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="{{{gitHost}}}" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="{{{gitUserId}}}" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="{{{gitRepoId}}}" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="{{{releaseNote}}}" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=`git remote` +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' + diff --git a/.generator/templates/gitignore.mustache b/.generator/templates/gitignore.mustache new file mode 100644 index 0000000000..43995bd42f --- /dev/null +++ b/.generator/templates/gitignore.mustache @@ -0,0 +1,66 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ +venv/ +.venv/ +.python-version +.pytest_cache + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +#Ipython Notebook +.ipynb_checkpoints diff --git a/.generator/templates/gitlab-ci.mustache b/.generator/templates/gitlab-ci.mustache new file mode 100644 index 0000000000..cf785a80ab --- /dev/null +++ b/.generator/templates/gitlab-ci.mustache @@ -0,0 +1,29 @@ +# ref: https://docs.gitlab.com/ee/ci/README.html + +stages: + - test + +.tests: + stage: test + script: + - pip install -r requirements.txt + - pip install -r test-requirements.txt + {{#useNose}} + - nosetests + {{/useNose}} + {{^useNose}} + - pytest --cov={{{packageName}}} + {{/useNose}} + +test-3.6: + extends: .tests + image: python:3.6-alpine +test-3.7: + extends: .tests + image: python:3.7-alpine +test-3.8: + extends: .tests + image: python:3.8-alpine +test-3.9: + extends: .tests + image: python:3.9-alpine diff --git a/.generator/templates/model.mustache b/.generator/templates/model.mustache new file mode 100644 index 0000000000..680b60644c --- /dev/null +++ b/.generator/templates/model.mustache @@ -0,0 +1,55 @@ +{{> partial_header }} + +import re # noqa: F401 +import sys # noqa: F401 + +from {{packageName}}.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) +{{#models}} +{{#model}} +{{#imports}} +{{#-first}} + +def lazy_import(): +{{/-first}} + {{{.}}} +{{/imports}} + + +{{^interfaces}} +{{#isArray}} +{{> model_templates/model_simple }} +{{/isArray}} +{{#isEnum}} +{{> model_templates/model_simple }} +{{/isEnum}} +{{#isAlias}} +{{> model_templates/model_simple }} +{{/isAlias}} +{{^isArray}} +{{^isEnum}} +{{^isAlias}} +{{> model_templates/model_normal }} +{{/isAlias}} +{{/isEnum}} +{{/isArray}} +{{/interfaces}} +{{#interfaces}} +{{#-last}} +{{> model_templates/model_composed }} +{{/-last}} +{{/interfaces}} +{{/model}} +{{/models}} diff --git a/.generator/templates/model_doc.mustache b/.generator/templates/model_doc.mustache new file mode 100644 index 0000000000..d81a598b67 --- /dev/null +++ b/.generator/templates/model_doc.mustache @@ -0,0 +1,37 @@ +{{#models}}{{#model}}# {{classname}} + +{{#description}}{{&description}} +{{/description}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +{{#isEnum}} +**value** | {{^arrayModelType}}**{{dataType}}**{{/arrayModelType}} | {{description}} | {{#defaultValue}}{{#hasRequired}} if omitted the server will use the default value of {{/hasRequired}}{{^hasRequired}}defaults to {{/hasRequired}}{{{.}}}{{/defaultValue}}{{#allowableValues}}{{#defaultValue}}, {{/defaultValue}} must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} +{{/isEnum}} +{{#isAlias}} +**value** | {{^arrayModelType}}**{{dataType}}**{{/arrayModelType}} | {{description}} | {{#defaultValue}}{{#hasRequired}} if omitted the server will use the default value of {{/hasRequired}}{{^hasRequired}}defaults to {{/hasRequired}}{{{.}}}{{/defaultValue}} +{{/isAlias}} +{{#isArray}} +**value** | {{^arrayModelType}}**{{dataType}}**{{/arrayModelType}}{{#arrayModelType}}[**{{dataType}}**]({{arrayModelType}}.md){{/arrayModelType}} | {{description}} | {{#defaultValue}}{{#hasRequired}} if omitted the server will use the default value of {{/hasRequired}}{{^hasRequired}}defaults to {{/hasRequired}}{{{.}}}{{/defaultValue}} +{{/isArray}} +{{#requiredVars}} +{{^defaultValue}} +**{{name}}** | {{^complexType}}**{{dataType}}**{{/complexType}}{{#complexType}}[**{{dataType}}**]({{complexType}}.md){{/complexType}} | {{description}} | {{#isReadOnly}}[readonly] {{/isReadOnly}} +{{/defaultValue}} +{{/requiredVars}} +{{#requiredVars}} +{{#defaultValue}} +**{{name}}** | {{^complexType}}**{{dataType}}**{{/complexType}}{{#complexType}}[**{{dataType}}**]({{complexType}}.md){{/complexType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}defaults to {{{.}}}{{/defaultValue}} +{{/defaultValue}} +{{/requiredVars}} +{{#optionalVars}} +**{{name}}** | {{^complexType}}**{{dataType}}**{{/complexType}}{{#complexType}}[**{{dataType}}**]({{complexType}}.md){{/complexType}} | {{description}} | [optional] {{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} +{{/optionalVars}} +{{#additionalPropertiesType}} +**any string name** | **{{additionalPropertiesType}}** | any string name can be used but the value must be the correct type | [optional] +{{/additionalPropertiesType}} + +[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) + +{{/model}}{{/models}} diff --git a/.generator/templates/model_templates/classvars.mustache b/.generator/templates/model_templates/classvars.mustache new file mode 100644 index 0000000000..1c6aab23e9 --- /dev/null +++ b/.generator/templates/model_templates/classvars.mustache @@ -0,0 +1,145 @@ + allowed_values = { +{{#isEnum}} + ('value',): { +{{#isNullable}} + 'None': None, +{{/isNullable}} +{{#allowableValues}} +{{#enumVars}} + '{{name}}': {{{value}}}, +{{/enumVars}} +{{/allowableValues}} + }, +{{/isEnum}} +{{#requiredVars}} +{{#isEnum}} + ('{{name}}',): { +{{#isNullable}} + 'None': None, +{{/isNullable}} +{{#allowableValues}} +{{#enumVars}} + '{{name}}': {{{value}}}, +{{/enumVars}} +{{/allowableValues}} + }, +{{/isEnum}} +{{/requiredVars}} +{{#optionalVars}} +{{#isEnum}} + ('{{name}}',): { +{{#isNullable}} + 'None': None, +{{/isNullable}} +{{#allowableValues}} +{{#enumVars}} + '{{name}}': {{{value}}}, +{{/enumVars}} +{{/allowableValues}} + }, +{{/isEnum}} +{{/optionalVars}} + } + + validations = { +{{#hasValidation}} + ('value',): { +{{> model_templates/validations }} +{{/hasValidation}} +{{#requiredVars}} +{{#hasValidation}} + ('{{name}}',): { +{{> model_templates/validations }} +{{/hasValidation}} +{{/requiredVars}} +{{#optionalVars}} +{{#hasValidation}} + ('{{name}}',): { +{{> model_templates/validations }} +{{/hasValidation}} +{{/optionalVars}} + } + +{{#additionalPropertiesType}} + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ +{{#imports}} +{{#-first}} + lazy_import() +{{/-first}} +{{/imports}} + return ({{{additionalPropertiesType}}},) # noqa: E501 +{{/additionalPropertiesType}} +{{^additionalPropertiesType}} + additional_properties_type = None +{{/additionalPropertiesType}} + + _nullable = {{#isNullable}}True{{/isNullable}}{{^isNullable}}False{{/isNullable}} + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ +{{#oneOf}} +{{#-first}} + return {} +{{/-first}} +{{/oneOf}} +{{^oneOf}} +{{#imports}} +{{#-first}} + lazy_import() +{{/-first}} +{{/imports}} + return { +{{#isAlias}} + 'value': ({{{dataType}}},), +{{/isAlias}} +{{#isEnum}} + 'value': ({{{dataType}}},), +{{/isEnum}} +{{#isArray}} + 'value': ({{{dataType}}},), +{{/isArray}} +{{#requiredVars}} + '{{name}}': ({{{dataType}}},), # noqa: E501 +{{/requiredVars}} +{{#optionalVars}} + '{{name}}': ({{{dataType}}},), # noqa: E501 +{{/optionalVars}} + } +{{/oneOf}} + + @cached_property + def discriminator(): +{{^discriminator}} + return None +{{/discriminator}} +{{#discriminator}} +{{#mappedModels}} +{{#-first}} +{{#imports}} +{{#-first}} + lazy_import() +{{/-first}} +{{/imports}} +{{/-first}} +{{/mappedModels}} + val = { +{{#mappedModels}} + '{{mappingName}}': {{{modelName}}}, +{{/mappedModels}} + } + if not val: + return None + return {'{{{discriminatorName}}}': val}{{/discriminator}} \ No newline at end of file diff --git a/.generator/templates/model_templates/docstring_allowed.mustache b/.generator/templates/model_templates/docstring_allowed.mustache new file mode 100644 index 0000000000..ab20932b28 --- /dev/null +++ b/.generator/templates/model_templates/docstring_allowed.mustache @@ -0,0 +1,4 @@ + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. \ No newline at end of file diff --git a/.generator/templates/model_templates/docstring_init_required_kwargs.mustache b/.generator/templates/model_templates/docstring_init_required_kwargs.mustache new file mode 100644 index 0000000000..b09f3950b9 --- /dev/null +++ b/.generator/templates/model_templates/docstring_init_required_kwargs.mustache @@ -0,0 +1,30 @@ + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) \ No newline at end of file diff --git a/.generator/templates/model_templates/docstring_openapi_validations.mustache b/.generator/templates/model_templates/docstring_openapi_validations.mustache new file mode 100644 index 0000000000..f933b86c5b --- /dev/null +++ b/.generator/templates/model_templates/docstring_openapi_validations.mustache @@ -0,0 +1,7 @@ + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. \ No newline at end of file diff --git a/.generator/templates/model_templates/method_init_composed.mustache b/.generator/templates/model_templates/method_init_composed.mustache new file mode 100644 index 0000000000..9b29837971 --- /dev/null +++ b/.generator/templates/model_templates/method_init_composed.mustache @@ -0,0 +1,46 @@ + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + +{{> model_templates/method_init_shared }} + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + required_args = { +{{#requiredVars}} + '{{name}}': {{name}}, +{{/requiredVars}} + } + model_args = {} + model_args.update(required_args) + model_args.update(kwargs) + composed_info = validate_get_composed_info( + constant_args, model_args, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + unused_args = composed_info[3] + + for var_name, var_value in required_args.items(): + setattr(self, var_name, var_value) + for var_name, var_value in kwargs.items(): + if var_name in unused_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + not self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) \ No newline at end of file diff --git a/.generator/templates/model_templates/method_init_normal.mustache b/.generator/templates/model_templates/method_init_normal.mustache new file mode 100644 index 0000000000..e670b4ffb4 --- /dev/null +++ b/.generator/templates/model_templates/method_init_normal.mustache @@ -0,0 +1,25 @@ + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + +{{> model_templates/method_init_shared }} + +{{#isEnum}} + self.value = value +{{/isEnum}} +{{#requiredVars}} + self.{{name}} = {{name}} +{{/requiredVars}} + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) \ No newline at end of file diff --git a/.generator/templates/model_templates/method_init_shared.mustache b/.generator/templates/model_templates/method_init_shared.mustache new file mode 100644 index 0000000000..a766c14bac --- /dev/null +++ b/.generator/templates/model_templates/method_init_shared.mustache @@ -0,0 +1,54 @@ + @convert_js_args_to_python_args + def __init__(self{{#requiredVars}}{{^defaultValue}}, {{name}}{{/defaultValue}}{{/requiredVars}}, *args, **kwargs): # noqa: E501 + """{{classname}} - a model defined in OpenAPI + +{{#requiredVars}} +{{#-first}} + Args: +{{/-first}} +{{^defaultValue}} + {{name}} ({{{dataType}}}):{{#description}} {{{description}}}{{/description}} +{{/defaultValue}} +{{#-last}} + +{{/-last}} +{{/requiredVars}} + Keyword Args: +{{#requiredVars}} +{{#defaultValue}} + {{name}} ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}} defaults to {{{defaultValue}}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} # noqa: E501 +{{/defaultValue}} +{{/requiredVars}} +{{> model_templates/docstring_init_required_kwargs }} +{{#optionalVars}} + {{name}} ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/defaultValue}} # noqa: E501 +{{/optionalVars}} + """ + +{{#requiredVars}} +{{#defaultValue}} + {{name}} = kwargs.get('{{name}}', {{{defaultValue}}}) +{{/defaultValue}} +{{/requiredVars}} + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) \ No newline at end of file diff --git a/.generator/templates/model_templates/method_init_simple.mustache b/.generator/templates/model_templates/method_init_simple.mustache new file mode 100644 index 0000000000..9e06a6a22e --- /dev/null +++ b/.generator/templates/model_templates/method_init_simple.mustache @@ -0,0 +1,74 @@ + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """{{classname}} - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}}{{#defaultValue}} if omitted defaults to {{{defaultValue}}}{{/defaultValue}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} # noqa: E501 + + Keyword Args: + value ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}}{{#defaultValue}} if omitted defaults to {{{defaultValue}}}{{/defaultValue}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}} # noqa: E501 +{{> model_templates/docstring_init_required_kwargs }} + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) +{{#defaultValue}} + else: + value = {{{defaultValue}}} +{{/defaultValue}} +{{^defaultValue}} + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) +{{/defaultValue}} + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) \ No newline at end of file diff --git a/.generator/templates/model_templates/method_set_attribute.mustache b/.generator/templates/model_templates/method_set_attribute.mustache new file mode 100644 index 0000000000..8ba0529cd0 --- /dev/null +++ b/.generator/templates/model_templates/method_set_attribute.mustache @@ -0,0 +1,51 @@ + def set_attribute(self, name, value): + # this is only used to set properties on self + + path_to_item = [] + if self._path_to_item: + path_to_item.extend(self._path_to_item) + path_to_item.append(name) + + if name in self.openapi_types: + required_types_mixed = self.openapi_types[name] + elif self.additional_properties_type is None: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + path_to_item + ) + elif self.additional_properties_type is not None: + required_types_mixed = self.additional_properties_type + + if get_simple_class(name) != str: + error_msg = type_error_message( + var_name=name, + var_value=name, + valid_classes=(str,), + key_type=True + ) + raise ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=(str,), + key_type=True + ) + + if self._check_type: + value = validate_and_convert_types( + value, required_types_mixed, path_to_item, self._spec_property_naming, + self._check_type, configuration=self._configuration) + if (name,) in self.allowed_values: + check_allowed_values( + self.allowed_values, + (name,), + value + ) + if (name,) in self.validations: + check_validations( + self.validations, + (name,), + value, + self._configuration + ) + self.__dict__['_data_store'][name] = value \ No newline at end of file diff --git a/.generator/templates/model_templates/methods_setattr_getattr_composed.mustache b/.generator/templates/model_templates/methods_setattr_getattr_composed.mustache new file mode 100644 index 0000000000..6b1013ca99 --- /dev/null +++ b/.generator/templates/model_templates/methods_setattr_getattr_composed.mustache @@ -0,0 +1,88 @@ + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + # set the attribute on the correct instance + model_instances = self._var_name_to_model_instances.get( + name, self._additional_properties_model_instances) + if model_instances: + for model_instance in model_instances: + if model_instance == self: + self.set_attribute(name, value) + else: + setattr(model_instance, name, value) + if name not in self._var_name_to_model_instances: + # we assigned an additional property + self.__dict__['_var_name_to_model_instances'][name] = ( + model_instance + ) + return None + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + __unset_attribute_value__ = object() + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + # get the attribute from the correct instance + model_instances = self._var_name_to_model_instances.get( + name, self._additional_properties_model_instances) + values = [] + # A composed model stores child (oneof/anyOf/allOf) models under + # self._var_name_to_model_instances. A named property can exist in + # multiple child models. If the property is present in more than one + # child model, the value must be the same across all the child models. + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + v = model_instance._data_store[name] + if v not in values: + values.append(v) + len_values = len(values) + if len_values == 0: + return default + elif len_values == 1: + return values[0] + elif len_values > 1: + raise ApiValueError( + "Values stored for property {0} in {1} differ when looking " + "at self and self's composed instances. All values must be " + "the same".format(name, type(self).__name__), + [e for e in [self._path_to_item, name] if e] + ) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + value = self.get(name, self.__unset_attribute_value__) + if value is self.__unset_attribute_value__: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + return value + + def __contains__(self, name): + """used by `in` operator to check if an attrbute value was set in an instance: `'attr' in instance`""" + + if name in self.required_properties: + return name in self.__dict__ + + model_instances = self._var_name_to_model_instances.get( + name, self._additional_properties_model_instances) + + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + return True + + return False \ No newline at end of file diff --git a/.generator/templates/model_templates/methods_setattr_getattr_normal.mustache b/.generator/templates/model_templates/methods_setattr_getattr_normal.mustache new file mode 100644 index 0000000000..e700dad953 --- /dev/null +++ b/.generator/templates/model_templates/methods_setattr_getattr_normal.mustache @@ -0,0 +1,32 @@ + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attrbute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] \ No newline at end of file diff --git a/.generator/templates/model_templates/methods_shared.mustache b/.generator/templates/model_templates/methods_shared.mustache new file mode 100644 index 0000000000..43bcf6fd0d --- /dev/null +++ b/.generator/templates/model_templates/methods_shared.mustache @@ -0,0 +1,15 @@ + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other + + def __setattr__(self, attr, value): + """set the value of an attribute using dot notation: `instance.attr = val`""" + self[attr] = value + + def __getattr__(self, attr): + """get the value of an attribute using dot notation: `instance.attr`""" + return self.{{#attrNoneIfUnset}}get{{/attrNoneIfUnset}}{{^attrNoneIfUnset}}__getitem__{{/attrNoneIfUnset}}(attr) \ No newline at end of file diff --git a/.generator/templates/model_templates/methods_todict_tostr_eq_shared.mustache b/.generator/templates/model_templates/methods_todict_tostr_eq_shared.mustache new file mode 100644 index 0000000000..17c441196a --- /dev/null +++ b/.generator/templates/model_templates/methods_todict_tostr_eq_shared.mustache @@ -0,0 +1,24 @@ + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True \ No newline at end of file diff --git a/.generator/templates/model_templates/methods_tostr_eq_simple.mustache b/.generator/templates/model_templates/methods_tostr_eq_simple.mustache new file mode 100644 index 0000000000..4a7ef6ae5c --- /dev/null +++ b/.generator/templates/model_templates/methods_tostr_eq_simple.mustache @@ -0,0 +1,16 @@ + def to_str(self): + """Returns the string representation of the model""" + return str(self.value) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + this_val = self._data_store['value'] + that_val = other._data_store['value'] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + return vals_equal \ No newline at end of file diff --git a/.generator/templates/model_templates/model_composed.mustache b/.generator/templates/model_templates/model_composed.mustache new file mode 100644 index 0000000000..5b348e9d23 --- /dev/null +++ b/.generator/templates/model_templates/model_composed.mustache @@ -0,0 +1,52 @@ +class {{classname}}(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: +{{> model_templates/docstring_allowed }} + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. +{{> model_templates/docstring_openapi_validations }} + """ + +{{> model_templates/classvars }} + + attribute_map = {} + +{{> model_templates/method_init_composed }} + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error beause the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading +{{#imports}} +{{#-first}} + lazy_import() +{{/-first}} +{{/imports}} + return { + 'anyOf': [ +{{#anyOf}} + {{{.}}}, +{{/anyOf}} + ], + 'allOf': [ +{{#allOf}} + {{{.}}}, +{{/allOf}} + ], + 'oneOf': [ +{{#oneOf}} + {{{.}}}, +{{/oneOf}} + ], + } \ No newline at end of file diff --git a/.generator/templates/model_templates/model_normal.mustache b/.generator/templates/model_templates/model_normal.mustache new file mode 100644 index 0000000000..9aada8f5a0 --- /dev/null +++ b/.generator/templates/model_templates/model_normal.mustache @@ -0,0 +1,29 @@ +class {{classname}}(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: +{{> model_templates/docstring_allowed }} + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. +{{> model_templates/docstring_openapi_validations }} + """ + +{{> model_templates/classvars }} + + attribute_map = { +{{#requiredVars}} + '{{name}}': '{{baseName}}', # noqa: E501 +{{/requiredVars}} +{{#optionalVars}} + '{{name}}': '{{baseName}}', # noqa: E501 +{{/optionalVars}} + } + + _composed_schemas = {} + +{{> model_templates/method_init_normal}} \ No newline at end of file diff --git a/.generator/templates/model_templates/model_simple.mustache b/.generator/templates/model_templates/model_simple.mustache new file mode 100644 index 0000000000..a4055af756 --- /dev/null +++ b/.generator/templates/model_templates/model_simple.mustache @@ -0,0 +1,18 @@ +class {{classname}}(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: +{{> model_templates/docstring_allowed }} +{{> model_templates/docstring_openapi_validations }} + """ + +{{> model_templates/classvars }} + + attribute_map = {} + + _composed_schemas = None + +{{> model_templates/method_init_simple}} \ No newline at end of file diff --git a/.generator/templates/model_templates/validations.mustache b/.generator/templates/model_templates/validations.mustache new file mode 100644 index 0000000000..9e26146d83 --- /dev/null +++ b/.generator/templates/model_templates/validations.mustache @@ -0,0 +1,34 @@ +{{#maxLength}} + 'max_length': {{maxLength}}, +{{/maxLength}} +{{#minLength}} + 'min_length': {{minLength}}, +{{/minLength}} +{{#maxItems}} + 'max_items': {{maxItems}}, +{{/maxItems}} +{{#minProperties}} + 'min_properties': {{minProperties}}, +{{/minProperties}} +{{#maxProperties}} + 'max_properties': {{maxProperties}}, +{{/maxProperties}} +{{#minItems}} + 'min_items': {{minItems}}, +{{/minItems}} +{{#maximum}} + {{#exclusiveMaximum}}'exclusive_maximum'{{/exclusiveMaximum}}'inclusive_maximum'{{^exclusiveMaximum}}{{/exclusiveMaximum}}: {{maximum}}, +{{/maximum}} +{{#minimum}} + {{#exclusiveMinimum}}'exclusive_minimum'{{/exclusiveMinimum}}'inclusive_minimum'{{^exclusiveMinimum}}{{/exclusiveMinimum}}: {{minimum}}, +{{/minimum}} +{{#pattern}} + 'regex': { + 'pattern': r'{{{vendorExtensions.x-regex}}}', # noqa: E501{{#vendorExtensions.x-modifiers}} + {{#-first}}'flags': (re.{{.}}{{/-first}}{{^-first}} re.{{.}}{{/-first}}{{^-last}} | {{/-last}}{{#-last}}){{/-last}}{{/vendorExtensions.x-modifiers}} + }, +{{/pattern}} +{{#multipleOf}} + 'multiple_of': {{multipleOf}}, +{{/multipleOf}} + }, \ No newline at end of file diff --git a/.generator/templates/model_test.mustache b/.generator/templates/model_test.mustache new file mode 100644 index 0000000000..aa95f64944 --- /dev/null +++ b/.generator/templates/model_test.mustache @@ -0,0 +1,34 @@ +{{>partial_header}} + +import sys +import unittest + +import {{packageName}} +{{#models}} +{{#model}} +{{#imports}} +{{{.}}} +{{/imports}} +from {{modelPackage}}.{{classFilename}} import {{classname}} + + +class Test{{classname}}(unittest.TestCase): + """{{classname}} unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def test{{classname}}(self): + """Test {{classname}}""" + # FIXME: construct object with mandatory attributes with example values + # model = {{classname}}() # noqa: E501 + pass + +{{/model}} +{{/models}} + +if __name__ == '__main__': + unittest.main() diff --git a/.generator/templates/model_utils.mustache b/.generator/templates/model_utils.mustache new file mode 100644 index 0000000000..07b77a99d1 --- /dev/null +++ b/.generator/templates/model_utils.mustache @@ -0,0 +1,1603 @@ +{{>partial_header}} + +from datetime import date, datetime # noqa: F401 +import inspect +import io +import os +import pprint +import re +import tempfile + +from dateutil.parser import parse + +from {{packageName}}.exceptions import ( + ApiKeyError, + ApiAttributeError, + ApiTypeError, + ApiValueError, +) + +none_type = type(None) +file_type = io.IOBase + + +class cached_property(object): + # this caches the result of the function call for fn with no inputs + # use this as a decorator on fuction methods that you want converted + # into cached properties + result_key = '_results' + + def __init__(self, fn): + self._fn = fn + + def __get__(self, instance, cls=None): + if self.result_key in vars(self): + return vars(self)[self.result_key] + else: + result = self._fn() + setattr(self, self.result_key, result) + return result + + +PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) + +def allows_single_value_input(cls): + """ + This function returns True if the input composed schema model or any + descendant model allows a value only input + This is true for cases where oneOf contains items like: + oneOf: + - float + - NumberWithValidation + - StringEnum + - ArrayModel + - null + TODO: lru_cache this + """ + if ( + issubclass(cls, ModelSimple) or + cls in PRIMITIVE_TYPES + ): + return True + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return False + return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) + return False + +def composed_model_input_classes(cls): + """ + This function returns a list of the possible models that can be accepted as + inputs. + TODO: lru_cache this + """ + if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: + return [cls] + elif issubclass(cls, ModelNormal): + if cls.discriminator is None: + return [cls] + else: + return get_discriminated_classes(cls) + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return [] + if cls.discriminator is None: + input_classes = [] + for c in cls._composed_schemas['oneOf']: + input_classes.extend(composed_model_input_classes(c)) + return input_classes + else: + return get_discriminated_classes(cls) + return [] + + +class OpenApiModel(object): + """The base class for all OpenAPIModels""" + +{{> model_templates/method_set_attribute }} + +{{> model_templates/methods_shared }} + + def __new__(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: If Animal has a discriminator + # petType and we pass in "Dog", and the class Dog + # allOf includes Animal, we move through Animal + # once using the discriminator, and pick Dog. + # Then in the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return super(OpenApiModel, cls).__new__(cls) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return super(OpenApiModel, cls).__new__(cls) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = super(OpenApiModel, cls).__new__(cls) + self_inst.__init__(*args, **kwargs) + + new_inst = new_cls.__new__(new_cls, *args, **kwargs) + new_inst.__init__(*args, **kwargs) + return new_inst + + +class ModelSimple(OpenApiModel): + """the parent class of models whose type != object in their + swagger/openapi""" + +{{> model_templates/methods_setattr_getattr_normal }} + +{{> model_templates/methods_tostr_eq_simple }} + + +class ModelNormal(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi""" + +{{> model_templates/methods_setattr_getattr_normal }} + +{{> model_templates/methods_todict_tostr_eq_shared}} + + +class ModelComposed(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi and have oneOf/allOf/anyOf + + When one sets a property we use var_name_to_model_instances to store the value in + the correct class instances + run any type checking + validation code. + When one gets a property we use var_name_to_model_instances to get the value + from the correct class instances. + This allows multiple composed schemas to contain the same property with additive + constraints on the value. + + _composed_schemas (dict) stores the anyOf/allOf/oneOf classes + key (str): allOf/oneOf/anyOf + value (list): the classes in the XOf definition. + Note: none_type can be included when the openapi document version >= 3.1.0 + _composed_instances (list): stores a list of instances of the composed schemas + defined in _composed_schemas. When properties are accessed in the self instance, + they are returned from the self._data_store or the data stores in the instances + in self._composed_schemas + _var_name_to_model_instances (dict): maps between a variable name on self and + the composed instances (self included) which contain that data + key (str): property name + value (list): list of class instances, self or instances in _composed_instances + which contain the value that the key is referring to. + """ + +{{> model_templates/methods_setattr_getattr_composed }} + +{{> model_templates/methods_todict_tostr_eq_shared}} + + +COERCION_INDEX_BY_TYPE = { + ModelComposed: 0, + ModelNormal: 1, + ModelSimple: 2, + none_type: 3, # The type of 'None'. + list: 4, + dict: 5, + float: 6, + int: 7, + bool: 8, + datetime: 9, + date: 10, + str: 11, + file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. +} + +# these are used to limit what type conversions we try to do +# when we have a valid type already and we want to try converting +# to another type +UPCONVERSION_TYPE_PAIRS = ( + (str, datetime), + (str, date), + (int, float), # A float may be serialized as an integer, e.g. '3' is a valid serialized float. + (list, ModelComposed), + (dict, ModelComposed), + (str, ModelComposed), + (int, ModelComposed), + (float, ModelComposed), + (list, ModelComposed), + (list, ModelNormal), + (dict, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), +) + +COERCIBLE_TYPE_PAIRS = { + False: ( # client instantiation of a model with client data + # (dict, ModelComposed), + # (list, ModelComposed), + # (dict, ModelNormal), + # (list, ModelNormal), + # (str, ModelSimple), + # (int, ModelSimple), + # (float, ModelSimple), + # (list, ModelSimple), + # (str, int), + # (str, float), + # (str, datetime), + # (str, date), + # (int, str), + # (float, str), + ), + True: ( # server -> client data + (dict, ModelComposed), + (list, ModelComposed), + (dict, ModelNormal), + (list, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), + # (str, int), + # (str, float), + (str, datetime), + (str, date), + # (int, str), + # (float, str), + (str, file_type) + ), +} + + +def get_simple_class(input_value): + """Returns an input_value's simple class that we will use for type checking + Python2: + float and int will return int, where int is the python3 int backport + str and unicode will return str, where str is the python3 str backport + Note: float and int ARE both instances of int backport + Note: str_py2 and unicode_py2 are NOT both instances of str backport + + Args: + input_value (class/class_instance): the item for which we will return + the simple class + """ + if isinstance(input_value, type): + # input_value is a class + return input_value + elif isinstance(input_value, tuple): + return tuple + elif isinstance(input_value, list): + return list + elif isinstance(input_value, dict): + return dict + elif isinstance(input_value, none_type): + return none_type + elif isinstance(input_value, file_type): + return file_type + elif isinstance(input_value, bool): + # this must be higher than the int check because + # isinstance(True, int) == True + return bool + elif isinstance(input_value, int): + return int + elif isinstance(input_value, datetime): + # this must be higher than the date check because + # isinstance(datetime_instance, date) == True + return datetime + elif isinstance(input_value, date): + return date + elif isinstance(input_value, str): + return str + return type(input_value) + + +def check_allowed_values(allowed_values, input_variable_path, input_values): + """Raises an exception if the input_values are not allowed + + Args: + allowed_values (dict): the allowed_values dict + input_variable_path (tuple): the path to the input variable + input_values (list/str/int/float/date/datetime): the values that we + are checking to see if they are in allowed_values + """ + these_allowed_values = list(allowed_values[input_variable_path].values()) + if (isinstance(input_values, list) + and not set(input_values).issubset( + set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values) - set(these_allowed_values))), + raise ApiValueError( + "Invalid values for `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (isinstance(input_values, dict) + and not set( + input_values.keys()).issubset(set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values.keys()) - set(these_allowed_values))) + raise ApiValueError( + "Invalid keys in `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (not isinstance(input_values, (list, dict)) + and input_values not in these_allowed_values): + raise ApiValueError( + "Invalid value for `%s` (%s), must be one of %s" % + ( + input_variable_path[0], + input_values, + these_allowed_values + ) + ) + + +def is_json_validation_enabled(schema_keyword, configuration=None): + """Returns true if JSON schema validation is enabled for the specified + validation keyword. This can be used to skip JSON schema structural validation + as requested in the configuration. + + Args: + schema_keyword (string): the name of a JSON schema validation keyword. + configuration (Configuration): the configuration class. + """ + + return (configuration is None or + not hasattr(configuration, '_disabled_client_side_validations') or + schema_keyword not in configuration._disabled_client_side_validations) + + +def check_validations( + validations, input_variable_path, input_values, + configuration=None): + """Raises an exception if the input_values are invalid + + Args: + validations (dict): the validation dictionary. + input_variable_path (tuple): the path to the input variable. + input_values (list/str/int/float/date/datetime): the values that we + are checking. + configuration (Configuration): the configuration class. + """ + + if input_values is None: + return + + current_validations = validations[input_variable_path] + if (is_json_validation_enabled('multipleOf', configuration) and + 'multiple_of' in current_validations and + isinstance(input_values, (int, float)) and + not (float(input_values) / current_validations['multiple_of']).is_integer()): + # Note 'multipleOf' will be as good as the floating point arithmetic. + raise ApiValueError( + "Invalid value for `%s`, value must be a multiple of " + "`%s`" % ( + input_variable_path[0], + current_validations['multiple_of'] + ) + ) + + if (is_json_validation_enabled('maxLength', configuration) and + 'max_length' in current_validations and + len(input_values) > current_validations['max_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['max_length'] + ) + ) + + if (is_json_validation_enabled('minLength', configuration) and + 'min_length' in current_validations and + len(input_values) < current_validations['min_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be greater than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['min_length'] + ) + ) + + if (is_json_validation_enabled('maxItems', configuration) and + 'max_items' in current_validations and + len(input_values) > current_validations['max_items']): + raise ApiValueError( + "Invalid value for `%s`, number of items must be less than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['max_items'] + ) + ) + + if (is_json_validation_enabled('minItems', configuration) and + 'min_items' in current_validations and + len(input_values) < current_validations['min_items']): + raise ValueError( + "Invalid value for `%s`, number of items must be greater than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['min_items'] + ) + ) + + items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', + 'inclusive_minimum') + if (any(item in current_validations for item in items)): + if isinstance(input_values, list): + max_val = max(input_values) + min_val = min(input_values) + elif isinstance(input_values, dict): + max_val = max(input_values.values()) + min_val = min(input_values.values()) + else: + max_val = input_values + min_val = input_values + + if (is_json_validation_enabled('exclusiveMaximum', configuration) and + 'exclusive_maximum' in current_validations and + max_val >= current_validations['exclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than `%s`" % ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('maximum', configuration) and + 'inclusive_maximum' in current_validations and + max_val > current_validations['inclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['inclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('exclusiveMinimum', configuration) and + 'exclusive_minimum' in current_validations and + min_val <= current_validations['exclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than `%s`" % + ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('minimum', configuration) and + 'inclusive_minimum' in current_validations and + min_val < current_validations['inclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than or equal " + "to `%s`" % ( + input_variable_path[0], + current_validations['inclusive_minimum'] + ) + ) + flags = current_validations.get('regex', {}).get('flags', 0) + if (is_json_validation_enabled('pattern', configuration) and + 'regex' in current_validations and + not re.search(current_validations['regex']['pattern'], + input_values, flags=flags)): + err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( + input_variable_path[0], + current_validations['regex']['pattern'] + ) + if flags != 0: + # Don't print the regex flags if the flags are not + # specified in the OAS document. + err_msg = r"%s with flags=`%s`" % (err_msg, flags) + raise ApiValueError(err_msg) + + +def order_response_types(required_types): + """Returns the required types sorted in coercion order + + Args: + required_types (list/tuple): collection of classes or instance of + list or dict with class information inside it. + + Returns: + (list): coercion order sorted collection of classes or instance + of list or dict with class information inside it. + """ + + def index_getter(class_or_instance): + if isinstance(class_or_instance, list): + return COERCION_INDEX_BY_TYPE[list] + elif isinstance(class_or_instance, dict): + return COERCION_INDEX_BY_TYPE[dict] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelComposed)): + return COERCION_INDEX_BY_TYPE[ModelComposed] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelNormal)): + return COERCION_INDEX_BY_TYPE[ModelNormal] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelSimple)): + return COERCION_INDEX_BY_TYPE[ModelSimple] + elif class_or_instance in COERCION_INDEX_BY_TYPE: + return COERCION_INDEX_BY_TYPE[class_or_instance] + raise ApiValueError("Unsupported type: %s" % class_or_instance) + + sorted_types = sorted( + required_types, + key=lambda class_or_instance: index_getter(class_or_instance) + ) + return sorted_types + + +def remove_uncoercible(required_types_classes, current_item, spec_property_naming, + must_convert=True): + """Only keeps the type conversions that are possible + + Args: + required_types_classes (tuple): tuple of classes that are required + these should be ordered by COERCION_INDEX_BY_TYPE + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + current_item (any): the current item (input data) to be converted + + Keyword Args: + must_convert (bool): if True the item to convert is of the wrong + type and we want a big list of coercibles + if False, we want a limited list of coercibles + + Returns: + (list): the remaining coercible required types, classes only + """ + current_type_simple = get_simple_class(current_item) + + results_classes = [] + for required_type_class in required_types_classes: + # convert our models to OpenApiModel + required_type_class_simplified = required_type_class + if isinstance(required_type_class_simplified, type): + if issubclass(required_type_class_simplified, ModelComposed): + required_type_class_simplified = ModelComposed + elif issubclass(required_type_class_simplified, ModelNormal): + required_type_class_simplified = ModelNormal + elif issubclass(required_type_class_simplified, ModelSimple): + required_type_class_simplified = ModelSimple + + if required_type_class_simplified == current_type_simple: + # don't consider converting to one's own class + continue + + class_pair = (current_type_simple, required_type_class_simplified) + if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: + results_classes.append(required_type_class) + elif class_pair in UPCONVERSION_TYPE_PAIRS: + results_classes.append(required_type_class) + return results_classes + +def get_discriminated_classes(cls): + """ + Returns all the classes that a discriminator converts to + TODO: lru_cache this + """ + possible_classes = [] + key = list(cls.discriminator.keys())[0] + if is_type_nullable(cls): + possible_classes.append(cls) + for discr_cls in cls.discriminator[key].values(): + if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: + possible_classes.extend(get_discriminated_classes(discr_cls)) + else: + possible_classes.append(discr_cls) + return possible_classes + + +def get_possible_classes(cls, from_server_context): + # TODO: lru_cache this + possible_classes = [cls] + if from_server_context: + return possible_classes + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + possible_classes = [] + possible_classes.extend(get_discriminated_classes(cls)) + elif issubclass(cls, ModelComposed): + possible_classes.extend(composed_model_input_classes(cls)) + return possible_classes + + +def get_required_type_classes(required_types_mixed, spec_property_naming): + """Converts the tuple required_types into a tuple and a dict described + below + + Args: + required_types_mixed (tuple/list): will contain either classes or + instance of list or dict + spec_property_naming (bool): if True these values came from the + server, and we use the data types in our endpoints. + If False, we are client side and we need to include + oneOf and discriminator classes inside the data types in our endpoints + + Returns: + (valid_classes, dict_valid_class_to_child_types_mixed): + valid_classes (tuple): the valid classes that the current item + should be + dict_valid_class_to_child_types_mixed (dict): + valid_class (class): this is the key + child_types_mixed (list/dict/tuple): describes the valid child + types + """ + valid_classes = [] + child_req_types_by_current_type = {} + for required_type in required_types_mixed: + if isinstance(required_type, list): + valid_classes.append(list) + child_req_types_by_current_type[list] = required_type + elif isinstance(required_type, tuple): + valid_classes.append(tuple) + child_req_types_by_current_type[tuple] = required_type + elif isinstance(required_type, dict): + valid_classes.append(dict) + child_req_types_by_current_type[dict] = required_type[str] + else: + valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) + return tuple(valid_classes), child_req_types_by_current_type + + +def change_keys_js_to_python(input_dict, model_class): + """ + Converts from javascript_key keys in the input_dict to python_keys in + the output dict using the mapping in model_class. + If the input_dict contains a key which does not declared in the model_class, + the key is added to the output dict as is. The assumption is the model_class + may have undeclared properties (additionalProperties attribute in the OAS + document). + """ + + if getattr(model_class, 'attribute_map', None) is None: + return input_dict + output_dict = {} + reversed_attr_map = {value: key for key, value in + model_class.attribute_map.items()} + for javascript_key, value in input_dict.items(): + python_key = reversed_attr_map.get(javascript_key) + if python_key is None: + # if the key is unknown, it is in error or it is an + # additionalProperties variable + python_key = javascript_key + output_dict[python_key] = value + return output_dict + + +def get_type_error(var_value, path_to_item, valid_classes, key_type=False): + error_msg = type_error_message( + var_name=path_to_item[-1], + var_value=var_value, + valid_classes=valid_classes, + key_type=key_type + ) + return ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=valid_classes, + key_type=key_type + ) + + +def deserialize_primitive(data, klass, path_to_item): + """Deserializes string to primitive type. + + :param data: str/int/float + :param klass: str/class the class to convert to + + :return: int, float, str, bool, date, datetime + """ + additional_message = "" + try: + if klass in {datetime, date}: + additional_message = ( + "If you need your parameter to have a fallback " + "string value, please set its type as `type: {}` in your " + "spec. That allows the value to be any type. " + ) + if klass == datetime: + if len(data) < 8: + raise ValueError("This is not a datetime") + # The string should be in iso8601 datetime format. + parsed_datetime = parse(data) + date_only = ( + parsed_datetime.hour == 0 and + parsed_datetime.minute == 0 and + parsed_datetime.second == 0 and + parsed_datetime.tzinfo is None and + 8 <= len(data) <= 10 + ) + if date_only: + raise ValueError("This is a date, not a datetime") + return parsed_datetime + elif klass == date: + if len(data) < 8: + raise ValueError("This is not a date") + return parse(data).date() + else: + converted_value = klass(data) + if isinstance(data, str) and klass == float: + if str(converted_value) != data: + # '7' -> 7.0 -> '7.0' != '7' + raise ValueError('This is not a float') + return converted_value + except (OverflowError, ValueError) as ex: + # parse can raise OverflowError + raise ApiValueError( + "{0}Failed to parse {1} as {2}".format( + additional_message, repr(data), klass.__name__ + ), + path_to_item=path_to_item + ) from ex + + +def get_discriminator_class(model_class, + discr_name, + discr_value, cls_visited): + """Returns the child class specified by the discriminator. + + Args: + model_class (OpenApiModel): the model class. + discr_name (string): the name of the discriminator property. + discr_value (any): the discriminator value. + cls_visited (list): list of model classes that have been visited. + Used to determine the discriminator class without + visiting circular references indefinitely. + + Returns: + used_model_class (class/None): the chosen child class that will be used + to deserialize the data, for example dog.Dog. + If a class is not found, None is returned. + """ + + if model_class in cls_visited: + # The class has already been visited and no suitable class was found. + return None + cls_visited.append(model_class) + used_model_class = None + if discr_name in model_class.discriminator: + class_name_to_discr_class = model_class.discriminator[discr_name] + used_model_class = class_name_to_discr_class.get(discr_value) + if used_model_class is None: + # We didn't find a discriminated class in class_name_to_discr_class. + # So look in the ancestor or descendant discriminators + # The discriminator mapping may exist in a descendant (anyOf, oneOf) + # or ancestor (allOf). + # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat + # hierarchy, the discriminator mappings may be defined at any level + # in the hierarchy. + # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig + # if we try to make BasquePig from mammal, we need to travel through + # the oneOf descendant discriminators to find BasquePig + descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ + model_class._composed_schemas.get('anyOf', ()) + ancestor_classes = model_class._composed_schemas.get('allOf', ()) + possible_classes = descendant_classes + ancestor_classes + for cls in possible_classes: + # Check if the schema has inherited discriminators. + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + used_model_class = get_discriminator_class( + cls, discr_name, discr_value, cls_visited) + if used_model_class is not None: + return used_model_class + return used_model_class + + +def deserialize_model(model_data, model_class, path_to_item, check_type, + configuration, spec_property_naming): + """Deserializes model_data to model instance. + + Args: + model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model + model_class (OpenApiModel): the model class + path_to_item (list): path to the model in the received data + check_type (bool): whether to check the data tupe for the values in + the model + configuration (Configuration): the instance to use to convert files + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + + Returns: + model instance + + Raise: + ApiTypeError + ApiValueError + ApiKeyError + """ + + kw_args = dict(_check_type=check_type, + _path_to_item=path_to_item, + _configuration=configuration, + _spec_property_naming=spec_property_naming) + + if issubclass(model_class, ModelSimple): + return model_class(model_data, **kw_args) + elif isinstance(model_data, list): + return model_class(*model_data, **kw_args) + if isinstance(model_data, dict): + kw_args.update(model_data) + return model_class(**kw_args) + elif isinstance(model_data, PRIMITIVE_TYPES): + return model_class(model_data, **kw_args) + + +def deserialize_file(response_data, configuration, content_disposition=None): + """Deserializes body to file + + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. + + Args: + param response_data (str): the file data to write + configuration (Configuration): the instance to use to convert files + + Keyword Args: + content_disposition (str): the value of the Content-Disposition + header + + Returns: + (file_type): the deserialized file which is open + The user is responsible for closing and reading the file + """ + fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + if content_disposition: + filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition).group(1) + path = os.path.join(os.path.dirname(path), filename) + + with open(path, "wb") as f: + if isinstance(response_data, str): + # change str to bytes so we can write it + response_data = response_data.encode('utf-8') + f.write(response_data) + + f = open(path, "rb") + return f + + +def attempt_convert_item(input_value, valid_classes, path_to_item, + configuration, spec_property_naming, key_type=False, + must_convert=False, check_type=True): + """ + Args: + input_value (any): the data to convert + valid_classes (any): the classes that are valid + path_to_item (list): the path to the item to convert + configuration (Configuration): the instance to use to convert files + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + key_type (bool): if True we need to convert a key type (not supported) + must_convert (bool): if True we must convert + check_type (bool): if True we check the type or the returned data in + ModelComposed/ModelNormal/ModelSimple instances + + Returns: + instance (any) the fixed item + + Raises: + ApiTypeError + ApiValueError + ApiKeyError + """ + valid_classes_ordered = order_response_types(valid_classes) + valid_classes_coercible = remove_uncoercible( + valid_classes_ordered, input_value, spec_property_naming) + if not valid_classes_coercible or key_type: + # we do not handle keytype errors, json will take care + # of this for us + if configuration is None or not configuration.discard_unknown_keys: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=key_type) + for valid_class in valid_classes_coercible: + try: + if issubclass(valid_class, OpenApiModel): + return deserialize_model(input_value, valid_class, + path_to_item, check_type, + configuration, spec_property_naming) + elif valid_class == file_type: + return deserialize_file(input_value, configuration) + return deserialize_primitive(input_value, valid_class, + path_to_item) + except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: + if must_convert: + raise conversion_exc + # if we have conversion errors when must_convert == False + # we ignore the exception and move on to the next class + continue + # we were unable to convert, must_convert == False + return input_value + + +def is_type_nullable(input_type): + """ + Returns true if None is an allowed value for the specified input_type. + + A type is nullable if at least one of the following conditions is true: + 1. The OAS 'nullable' attribute has been specified, + 1. The type is the 'null' type, + 1. The type is a anyOf/oneOf composed schema, and a child schema is + the 'null' type. + Args: + input_type (type): the class of the input_value that we are + checking + Returns: + bool + """ + if input_type is none_type: + return True + if issubclass(input_type, OpenApiModel) and input_type._nullable: + return True + if issubclass(input_type, ModelComposed): + # If oneOf/anyOf, check if the 'null' type is one of the allowed types. + for t in input_type._composed_schemas.get('oneOf', ()): + if is_type_nullable(t): return True + for t in input_type._composed_schemas.get('anyOf', ()): + if is_type_nullable(t): return True + return False + + +def is_valid_type(input_class_simple, valid_classes): + """ + Args: + input_class_simple (class): the class of the input_value that we are + checking + valid_classes (tuple): the valid classes that the current item + should be + Returns: + bool + """ + valid_type = input_class_simple in valid_classes + if not valid_type and ( + issubclass(input_class_simple, OpenApiModel) or + input_class_simple is none_type): + for valid_class in valid_classes: + if input_class_simple is none_type and is_type_nullable(valid_class): + # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. + return True + if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): + continue + discr_propertyname_py = list(valid_class.discriminator.keys())[0] + discriminator_classes = ( + valid_class.discriminator[discr_propertyname_py].values() + ) + valid_type = is_valid_type(input_class_simple, discriminator_classes) + if valid_type: + return True + return valid_type + + +def validate_and_convert_types(input_value, required_types_mixed, path_to_item, + spec_property_naming, _check_type, configuration=None): + """Raises a TypeError is there is a problem, otherwise returns value + + Args: + input_value (any): the data to validate/convert + required_types_mixed (list/dict/tuple): A list of + valid classes, or a list tuples of valid classes, or a dict where + the value is a tuple of value classes + path_to_item: (list) the path to the data being validated + this stores a list of keys or indices to get to the data being + validated + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + _check_type: (boolean) if true, type will be checked and conversion + will be attempted. + configuration: (Configuration): the configuration class to use + when converting file_type items. + If passed, conversion will be attempted when possible + If not passed, no conversions will be attempted and + exceptions will be raised + + Returns: + the correctly typed value + + Raises: + ApiTypeError + """ + results = get_required_type_classes(required_types_mixed, spec_property_naming) + valid_classes, child_req_types_by_current_type = results + + input_class_simple = get_simple_class(input_value) + valid_type = is_valid_type(input_class_simple, valid_classes) + if not valid_type: + if configuration: + # if input_value is not valid_type try to convert it + converted_instance = attempt_convert_item( + input_value, + valid_classes, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=True, + check_type=_check_type + ) + return converted_instance + else: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=False) + + # input_value's type is in valid_classes + if len(valid_classes) > 1 and configuration: + # there are valid classes which are not the current class + valid_classes_coercible = remove_uncoercible( + valid_classes, input_value, spec_property_naming, must_convert=False) + if valid_classes_coercible: + converted_instance = attempt_convert_item( + input_value, + valid_classes_coercible, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=False, + check_type=_check_type + ) + return converted_instance + + if child_req_types_by_current_type == {}: + # all types are of the required types and there are no more inner + # variables left to look at + return input_value + inner_required_types = child_req_types_by_current_type.get( + type(input_value) + ) + if inner_required_types is None: + # for this type, there are not more inner variables left to look at + return input_value + if isinstance(input_value, list): + if input_value == []: + # allow an empty list + return input_value + for index, inner_value in enumerate(input_value): + inner_path = list(path_to_item) + inner_path.append(index) + input_value[index] = validate_and_convert_types( + inner_value, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + elif isinstance(input_value, dict): + if input_value == {}: + # allow an empty dict + return input_value + for inner_key, inner_val in input_value.items(): + inner_path = list(path_to_item) + inner_path.append(inner_key) + if get_simple_class(inner_key) != str: + raise get_type_error(inner_key, inner_path, valid_classes, + key_type=True) + input_value[inner_key] = validate_and_convert_types( + inner_val, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + return input_value + + +def model_to_dict(model_instance, serialize=True): + """Returns the model properties as a dict + + Args: + model_instance (one of your model instances): the model instance that + will be converted to a dict. + + Keyword Args: + serialize (bool): if True, the keys in the dict will be values from + attribute_map + """ + result = {} + + model_instances = [model_instance] + if model_instance._composed_schemas: + model_instances.extend(model_instance._composed_instances) + for model_instance in model_instances: + for attr, value in model_instance._data_store.items(): + if serialize: + # we use get here because additional property key names do not + # exist in attribute_map + attr = model_instance.attribute_map.get(attr, attr) + if isinstance(value, list): + if not value or isinstance(value[0], PRIMITIVE_TYPES): + # empty list or primitive types + result[attr] = value + elif isinstance(value[0], ModelSimple): + result[attr] = [x.value for x in value] + else: + result[attr] = [model_to_dict(x, serialize=serialize) for x in value] + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], + model_to_dict(item[1], serialize=serialize)) + if hasattr(item[1], '_data_store') else item, + value.items() + )) + elif isinstance(value, ModelSimple): + result[attr] = value.value + elif hasattr(value, '_data_store'): + result[attr] = model_to_dict(value, serialize=serialize) + else: + result[attr] = value + + return result + + +def type_error_message(var_value=None, var_name=None, valid_classes=None, + key_type=None): + """ + Keyword Args: + var_value (any): the variable which has the type_error + var_name (str): the name of the variable which has the typ error + valid_classes (tuple): the accepted classes for current_item's + value + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + """ + key_or_value = 'value' + if key_type: + key_or_value = 'key' + valid_classes_phrase = get_valid_classes_phrase(valid_classes) + msg = ( + "Invalid type for variable '{0}'. Required {1} type {2} and " + "passed type was {3}".format( + var_name, + key_or_value, + valid_classes_phrase, + type(var_value).__name__, + ) + ) + return msg + + +def get_valid_classes_phrase(input_classes): + """Returns a string phrase describing what types are allowed + """ + all_classes = list(input_classes) + all_classes = sorted(all_classes, key=lambda cls: cls.__name__) + all_class_names = [cls.__name__ for cls in all_classes] + if len(all_class_names) == 1: + return 'is {0}'.format(all_class_names[0]) + return "is one of [{0}]".format(", ".join(all_class_names)) + + +def convert_js_args_to_python_args(fn): + from functools import wraps + @wraps(fn) + def wrapped_init(self, *args, **kwargs): + spec_property_naming = kwargs.get('_spec_property_naming', False) + if spec_property_naming: + kwargs = change_keys_js_to_python(kwargs, self.__class__) + return fn(self, *args, **kwargs) + return wrapped_init + + +def get_allof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + used to make instances + constant_args (dict): var_name to var_value + used to make instances + + Returns + composed_instances (list) + """ + composed_instances = [] + for allof_class in self._composed_schemas['allOf']: + + # no need to handle changing js keys to python because + # for composed schemas, allof parameters are included in the + # composed schema and were changed to python keys in __new__ + # extract a dict of only required keys from fixed_model_args + kwargs = {} + var_names = set(allof_class.openapi_types.keys()) + for var_name in var_names: + if var_name in model_args: + kwargs[var_name] = model_args[var_name] + + # and use it to make the instance + kwargs.update(constant_args) + try: + allof_instance = allof_class(**kwargs) + composed_instances.append(allof_instance) + except Exception as ex: + raise ApiValueError( + "Invalid inputs given to generate an instance of '%s'. The " + "input data was invalid for the allOf schema '%s' in the composed " + "schema '%s'. Error=%s" % ( + allof_class.__name__, + allof_class.__name__, + self.__class__.__name__, + str(ex) + ) + ) from ex + return composed_instances + + +def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): + """ + Find the oneOf schema that matches the input data (e.g. payload). + If exactly one schema matches the input data, an instance of that schema + is returned. + If zero or more than one schema match the input data, an exception is raised. + In OAS 3.x, the payload MUST, by validation, match exactly one of the + schemas described by oneOf. + + Args: + cls: the class we are handling + model_kwargs (dict): var_name to var_value + The input data, e.g. the payload that must match a oneOf schema + in the OpenAPI document. + constant_kwargs (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Kwargs: + model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): + the value to assign to a primitive class or ModelSimple class + Notes: + - this is only passed in when oneOf includes types which are not object + - None is used to suppress handling of model_arg, nullable models are handled in __new__ + + Returns + oneof_instance (instance) + """ + if len(cls._composed_schemas['oneOf']) == 0: + return None + + oneof_instances = [] + # Iterate over each oneOf schema and determine if the input data + # matches the oneOf schemas. + for oneof_class in cls._composed_schemas['oneOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if oneof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + single_value_input = allows_single_value_input(oneof_class) + + if not single_value_input: + # transform js keys from input data to python keys in fixed_model_args + fixed_model_args = change_keys_js_to_python( + model_kwargs, oneof_class) + + # Extract a dict with the properties that are declared in the oneOf schema. + # Undeclared properties (e.g. properties that are allowed because of the + # additionalProperties attribute in the OAS document) are not added to + # the dict. + kwargs = {} + var_names = set(oneof_class.openapi_types.keys()) + for var_name in var_names: + if var_name in fixed_model_args: + kwargs[var_name] = fixed_model_args[var_name] + + # do not try to make a model with no input args + if len(kwargs) == 0: + continue + + # and use it to make the instance + kwargs.update(constant_kwargs) + + try: + if not single_value_input: + oneof_instance = oneof_class(**kwargs) + else: + if issubclass(oneof_class, ModelSimple): + oneof_instance = oneof_class(model_arg, **constant_kwargs) + elif oneof_class in PRIMITIVE_TYPES: + oneof_instance = validate_and_convert_types( + model_arg, + (oneof_class,), + constant_kwargs['_path_to_item'], + constant_kwargs['_spec_property_naming'], + constant_kwargs['_check_type'], + configuration=constant_kwargs['_configuration'] + ) + oneof_instances.append(oneof_instance) + except Exception: + pass + if len(oneof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None " + "of the oneOf schemas matched the input data." % + cls.__name__ + ) + elif len(oneof_instances) > 1: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. Multiple " + "oneOf schemas matched the inputs, but a max of one is allowed." % + cls.__name__ + ) + return oneof_instances[0] + + +def get_anyof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + The input data, e.g. the payload that must match at least one + anyOf child schema in the OpenAPI document. + constant_args (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Returns + anyof_instances (list) + """ + anyof_instances = [] + if len(self._composed_schemas['anyOf']) == 0: + return anyof_instances + + for anyof_class in self._composed_schemas['anyOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if anyof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + # transform js keys to python keys in fixed_model_args + fixed_model_args = change_keys_js_to_python(model_args, anyof_class) + + # extract a dict of only required keys from these_model_vars + kwargs = {} + var_names = set(anyof_class.openapi_types.keys()) + for var_name in var_names: + if var_name in fixed_model_args: + kwargs[var_name] = fixed_model_args[var_name] + + # do not try to make a model with no input args + if len(kwargs) == 0: + continue + + # and use it to make the instance + kwargs.update(constant_args) + try: + anyof_instance = anyof_class(**kwargs) + anyof_instances.append(anyof_instance) + except Exception: + pass + if len(anyof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None of the " + "anyOf schemas matched the inputs." % + self.__class__.__name__ + ) + return anyof_instances + + +def get_additional_properties_model_instances( + composed_instances, self): + additional_properties_model_instances = [] + all_instances = [self] + all_instances.extend(composed_instances) + for instance in all_instances: + if instance.additional_properties_type is not None: + additional_properties_model_instances.append(instance) + return additional_properties_model_instances + + +def get_var_name_to_model_instances(self, composed_instances): + var_name_to_model_instances = {} + all_instances = [self] + all_instances.extend(composed_instances) + for instance in all_instances: + for var_name in instance.openapi_types: + if var_name not in var_name_to_model_instances: + var_name_to_model_instances[var_name] = [instance] + else: + var_name_to_model_instances[var_name].append(instance) + return var_name_to_model_instances + + +def get_unused_args(self, composed_instances, model_args): + unused_args = dict(model_args) + # arguments apssed to self were already converted to python names + # before __init__ was called + for var_name_py in self.attribute_map: + if var_name_py in unused_args: + del unused_args[var_name_py] + for instance in composed_instances: + if instance.__class__ in self._composed_schemas['allOf']: + for var_name_py in instance.attribute_map: + if var_name_py in unused_args: + del unused_args[var_name_py] + else: + for var_name_js in instance.attribute_map.values(): + if var_name_js in unused_args: + del unused_args[var_name_js] + return unused_args + + +def validate_get_composed_info(constant_args, model_args, self): + """ + For composed schemas, generate schema instances for + all schemas in the oneOf/anyOf/allOf definition. If additional + properties are allowed, also assign those properties on + all matched schemas that contain additionalProperties. + Openapi schemas are python classes. + + Exceptions are raised if: + - 0 or > 1 oneOf schema matches the model_args input data + - no anyOf schema matches the model_args input data + - any of the allOf schemas do not match the model_args input data + + Args: + constant_args (dict): these are the args that every model requires + model_args (dict): these are the required and optional spec args that + were passed in to make this model + self (class): the class that we are instantiating + This class contains self._composed_schemas + + Returns: + composed_info (list): length three + composed_instances (list): the composed instances which are not + self + var_name_to_model_instances (dict): a dict going from var_name + to the model_instance which holds that var_name + the model_instance may be self or an instance of one of the + classes in self.composed_instances() + additional_properties_model_instances (list): a list of the + model instances which have the property + additional_properties_type. This list can include self + """ + # create composed_instances + composed_instances = [] + allof_instances = get_allof_instances(self, model_args, constant_args) + composed_instances.extend(allof_instances) + oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) + if oneof_instance is not None: + composed_instances.append(oneof_instance) + anyof_instances = get_anyof_instances(self, model_args, constant_args) + composed_instances.extend(anyof_instances) + + # map variable names to composed_instances + var_name_to_model_instances = get_var_name_to_model_instances( + self, composed_instances) + + # set additional_properties_model_instances + additional_properties_model_instances = ( + get_additional_properties_model_instances(composed_instances, self) + ) + + # set any remaining values + unused_args = get_unused_args(self, composed_instances, model_args) + if len(unused_args) > 0 and \ + len(additional_properties_model_instances) == 0 and \ + (self._configuration is None or + not self._configuration.discard_unknown_keys): + raise ApiValueError( + "Invalid input arguments input when making an instance of " + "class %s. Not all inputs were used. The unused input data " + "is %s" % (self.__class__.__name__, unused_args) + ) + + # no need to add additional_properties to var_name_to_model_instances here + # because additional_properties_model_instances will direct us to that + # instance when we use getattr or setattr + # and we update var_name_to_model_instances in setattr + + return [ + composed_instances, + var_name_to_model_instances, + additional_properties_model_instances, + unused_args + ] diff --git a/.generator/templates/partial_header.mustache b/.generator/templates/partial_header.mustache new file mode 100644 index 0000000000..07fc869f36 --- /dev/null +++ b/.generator/templates/partial_header.mustache @@ -0,0 +1,3 @@ +# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. +# This product includes software developed at Datadog (https://www.datadoghq.com/). +# Copyright 2019-Present Datadog, Inc. diff --git a/.generator/templates/python_doc_auth_partial.mustache b/.generator/templates/python_doc_auth_partial.mustache new file mode 100644 index 0000000000..47cc52b301 --- /dev/null +++ b/.generator/templates/python_doc_auth_partial.mustache @@ -0,0 +1,105 @@ +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration() + +# Defining the site is optional and defaults to datadoghq.com +if "DD_SITE" in os.environ: + configuration.server_variables["site"] = os.environ["DD_SITE"] +{{#hasAuthMethods}} +{{#authMethods}} +{{#isBasic}} +{{#isBasicBasic}} + +# Configure HTTP basic authorization: {{{name}}} +configuration = {{{packageName}}}.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) +{{/isBasicBasic}} +{{#isBasicBearer}} + +# Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}} +configuration = {{{packageName}}}.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) +{{/isBasicBearer}} +{{#isHttpSignature}} + +# Configure HTTP message signature: {{{name}}} +# The HTTP Signature Header mechanism that can be used by a client to +# authenticate the sender of a message and ensure that particular headers +# have not been modified in transit. +# +# You can specify the signing key-id, private key path, signing scheme, +# signing algorithm, list of signed headers and signature max validity. +# The 'key_id' parameter is an opaque string that the API server can use +# to lookup the client and validate the signature. +# The 'private_key_path' parameter should be the path to a file that +# contains a DER or base-64 encoded private key. +# The 'private_key_passphrase' parameter is optional. Set the passphrase +# if the private key is encrypted. +# The 'signed_headers' parameter is used to specify the list of +# HTTP headers included when generating the signature for the message. +# You can specify HTTP headers that you want to protect with a cryptographic +# signature. Note that proxies may add, modify or remove HTTP headers +# for legitimate reasons, so you should only add headers that you know +# will not be modified. For example, if you want to protect the HTTP request +# body, you can specify the Digest header. In that case, the client calculates +# the digest of the HTTP request body and includes the digest in the message +# signature. +# The 'signature_max_validity' parameter is optional. It is configured as a +# duration to express when the signature ceases to be valid. The client calculates +# the expiration date every time it generates the cryptographic signature +# of an HTTP request. The API server may have its own security policy +# that controls the maximum validity of the signature. The client max validity +# must be lower than the server max validity. +# The time on the client and server must be synchronized, otherwise the +# server may reject the client signature. +# +# The client must use a combination of private key, signing scheme, +# signing algorithm and hash algorithm that matches the security policy of +# the API server. +# +# See {{{packageName}}}.signing for a list of all supported parameters. +configuration = {{{packageName}}}.Configuration( + host = "{{{basePath}}}", + signing_info = {{{packageName}}}.signing.HttpSigningConfiguration( + key_id = 'my-key-id', + private_key_path = 'private_key.pem', + private_key_passphrase = 'YOUR_PASSPHRASE', + signing_scheme = {{{packageName}}}.signing.SCHEME_HS2019, + signing_algorithm = {{{packageName}}}.signing.ALGORITHM_ECDSA_MODE_FIPS_186_3, + hash_algorithm = {{{packageName}}}.signing.SCHEME_RSA_SHA256, + signed_headers = [ + {{{packageName}}}.signing.HEADER_REQUEST_TARGET, + {{{packageName}}}.signing.HEADER_CREATED, + {{{packageName}}}.signing.HEADER_EXPIRES, + {{{packageName}}}.signing.HEADER_HOST, + {{{packageName}}}.signing.HEADER_DATE, + {{{packageName}}}.signing.HEADER_DIGEST, + 'Content-Type', + 'Content-Length', + 'User-Agent' + ], + signature_max_validity = datetime.timedelta(minutes=5) + ) +) +{{/isHttpSignature}} +{{/isBasic}} +{{#isApiKey}} + +# Configure API key authorization: {{{name}}} +configuration.api_key['{{{name}}}'] = os.getenv('{{{vendorExtensions.x-env-name}}}') +{{/isApiKey}} +{{#isOAuth}} + +# Configure OAuth2 access token for authorization: {{{name}}} +configuration = {{{packageName}}}.Configuration( + host = "{{{basePath}}}" +) +configuration.access_token = 'YOUR_ACCESS_TOKEN' +{{/isOAuth}} +{{/authMethods}} +{{#vendorExtensions.x-unstable}} +configuration.unstable_operations["{{operationId}}"] = True +{{/vendorExtensions.x-unstable}} +{{/hasAuthMethods}} diff --git a/.generator/templates/requirements.mustache b/.generator/templates/requirements.mustache new file mode 100644 index 0000000000..96947f6040 --- /dev/null +++ b/.generator/templates/requirements.mustache @@ -0,0 +1,3 @@ +python_dateutil >= 2.5.3 +setuptools >= 21.0.0 +urllib3 >= 1.25.3 diff --git a/.generator/templates/rest.mustache b/.generator/templates/rest.mustache new file mode 100644 index 0000000000..9e73386489 --- /dev/null +++ b/.generator/templates/rest.mustache @@ -0,0 +1,284 @@ +{{>partial_header}} + +import io +import json +import logging +import re +import ssl +from urllib.parse import urlencode + +import urllib3 + +from {{packageName}}.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError + + +logger = logging.getLogger(__name__) + + +class RESTResponse(io.IOBase): + + def __init__(self, resp): + self.urllib3_response = resp + self.status = resp.status + self.reason = resp.reason + self.data = resp.data + + def getheaders(self): + """Returns a dictionary of the response headers.""" + return self.urllib3_response.getheaders() + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.urllib3_response.getheader(name, default) + + +class RESTClientObject(object): + + def __init__(self, configuration, pools_size=4, maxsize=None): + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE + + addition_pool_args = {} + if configuration.assert_hostname is not None: + addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 + + if configuration.retries is not None: + addition_pool_args['retries'] = configuration.retries + + if configuration.socket_options is not None: + addition_pool_args['socket_options'] = configuration.socket_options + + if maxsize is None: + if configuration.connection_pool_maxsize is not None: + maxsize = configuration.connection_pool_maxsize + else: + maxsize = 4 + + # https pool manager + if configuration.proxy: + self.pool_manager = urllib3.ProxyManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + proxy_headers=configuration.proxy_headers, + **addition_pool_args + ) + else: + self.pool_manager = urllib3.PoolManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + **addition_pool_args + ) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + """Perform requests. + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + """ + method = method.upper() + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 + timeout = urllib3.Timeout(total=_request_timeout) + elif (isinstance(_request_timeout, tuple) and + len(_request_timeout) == 2): + timeout = urllib3.Timeout( + connect=_request_timeout[0], read=_request_timeout[1]) + + if 'Content-Type' not in headers: + headers['Content-Type'] = 'application/json' + + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + if query_params: + url += '?' + urlencode(query_params) + if re.search('json', headers['Content-Type'], re.IGNORECASE): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=False, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=True, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + # Pass a `string` parameter directly in the body to support + # other content types than Json when `body` argument is + # provided in serialized form + elif isinstance(body, str) or isinstance(body, bytes): + request_body = body + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` + else: + r = self.pool_manager.request(method, url, + fields=query_params, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + except urllib3.exceptions.SSLError as e: + msg = "{0}\n{1}".format(type(e).__name__, str(e)) + raise ApiException(status=0, reason=msg) + + if _preload_content: + r = RESTResponse(r) + + # log response body + logger.debug("response body: %s", r.data) + + if not 200 <= r.status <= 299: + if r.status == 401: + raise UnauthorizedException(http_resp=r) + + if r.status == 403: + raise ForbiddenException(http_resp=r) + + if r.status == 404: + raise NotFoundException(http_resp=r) + + if 500 <= r.status <= 599: + raise ServiceException(http_resp=r) + + raise ApiException(http_resp=r) + + return r + + def GET(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("GET", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def HEAD(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("HEAD", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def OPTIONS(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("OPTIONS", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): + return self.request("DELETE", url, + headers=headers, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def POST(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("POST", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PUT", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PATCH(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PATCH", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) diff --git a/.generator/templates/setup.mustache b/.generator/templates/setup.mustache new file mode 100644 index 0000000000..d5154f3fa6 --- /dev/null +++ b/.generator/templates/setup.mustache @@ -0,0 +1,51 @@ +{{>partial_header}} + +from setuptools import setup, find_packages # noqa: H301 + +NAME = "{{{projectName}}}" +VERSION = "{{packageVersion}}" +{{#apiInfo}} +{{#apis}} +{{#-last}} +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools + +REQUIRES = [ + "urllib3 >= 1.25.3", + "python-dateutil", +{{#asyncio}} + "aiohttp >= 3.0.0", +{{/asyncio}} +{{#tornado}} + "tornado>=4.2,<5", +{{/tornado}} +{{#hasHttpSignatureMethods}} + "pem>=19.3.0", + "pycryptodome>=3.9.0", +{{/hasHttpSignatureMethods}} +] + +setup( + name=NAME, + version=VERSION, + description="{{appName}}", + author="{{#infoName}}{{infoName}}{{/infoName}}{{^infoName}}OpenAPI Generator community{{/infoName}}", + author_email="{{#infoEmail}}{{infoEmail}}{{/infoEmail}}{{^infoEmail}}team@openapitools.org{{/infoEmail}}", + url="{{packageUrl}}", + keywords=["OpenAPI", "OpenAPI-Generator", "{{{appName}}}"], + python_requires=">=3.6", + install_requires=REQUIRES, + packages=find_packages(exclude=["test", "tests"]), + include_package_data=True, + {{#licenseInfo}}license="{{licenseInfo}}", + {{/licenseInfo}}long_description="""\ + {{appDescription}} # noqa: E501 + """ +) +{{/-last}} +{{/apis}} +{{/apiInfo}} diff --git a/.generator/templates/setup_cfg.mustache b/.generator/templates/setup_cfg.mustache new file mode 100644 index 0000000000..931f02c5d1 --- /dev/null +++ b/.generator/templates/setup_cfg.mustache @@ -0,0 +1,13 @@ +{{#useNose}} +[nosetests] +logging-clear-handlers=true +verbosity=2 +randomize=true +exe=true +with-coverage=true +cover-package={{{packageName}}} +cover-erase=true + +{{/useNose}} +[flake8] +max-line-length=99 diff --git a/.generator/templates/signing.mustache b/.generator/templates/signing.mustache new file mode 100644 index 0000000000..8dfbf5148f --- /dev/null +++ b/.generator/templates/signing.mustache @@ -0,0 +1,408 @@ +{{>partial_header}} + +from base64 import b64encode +from Crypto.IO import PEM, PKCS8 +from Crypto.Hash import SHA256, SHA512 +from Crypto.PublicKey import RSA, ECC +from Crypto.Signature import PKCS1_v1_5, pss, DSS +from email.utils import formatdate +import json +import os +import re +from time import time +from urllib.parse import urlencode, urlparse + +# The constants below define a subset of HTTP headers that can be included in the +# HTTP signature scheme. Additional headers may be included in the signature. + +# The '(request-target)' header is a calculated field that includes the HTTP verb, +# the URL path and the URL query. +HEADER_REQUEST_TARGET = '(request-target)' +# The time when the HTTP signature was generated. +HEADER_CREATED = '(created)' +# The time when the HTTP signature expires. The API server should reject HTTP requests +# that have expired. +HEADER_EXPIRES = '(expires)' +# The 'Host' header. +HEADER_HOST = 'Host' +# The 'Date' header. +HEADER_DATE = 'Date' +# When the 'Digest' header is included in the HTTP signature, the client automatically +# computes the digest of the HTTP request body, per RFC 3230. +HEADER_DIGEST = 'Digest' +# The 'Authorization' header is automatically generated by the client. It includes +# the list of signed headers and a base64-encoded signature. +HEADER_AUTHORIZATION = 'Authorization' + +# The constants below define the cryptographic schemes for the HTTP signature scheme. +SCHEME_HS2019 = 'hs2019' +SCHEME_RSA_SHA256 = 'rsa-sha256' +SCHEME_RSA_SHA512 = 'rsa-sha512' + +# The constants below define the signature algorithms that can be used for the HTTP +# signature scheme. +ALGORITHM_RSASSA_PSS = 'RSASSA-PSS' +ALGORITHM_RSASSA_PKCS1v15 = 'RSASSA-PKCS1-v1_5' + +ALGORITHM_ECDSA_MODE_FIPS_186_3 = 'fips-186-3' +ALGORITHM_ECDSA_MODE_DETERMINISTIC_RFC6979 = 'deterministic-rfc6979' +ALGORITHM_ECDSA_KEY_SIGNING_ALGORITHMS = { + ALGORITHM_ECDSA_MODE_FIPS_186_3, + ALGORITHM_ECDSA_MODE_DETERMINISTIC_RFC6979 +} + +# The cryptographic hash algorithm for the message signature. +HASH_SHA256 = 'sha256' +HASH_SHA512 = 'sha512' + + +class HttpSigningConfiguration(object): + """The configuration parameters for the HTTP signature security scheme. + The HTTP signature security scheme is used to sign HTTP requests with a private key + which is in possession of the API client. + An 'Authorization' header is calculated by creating a hash of select headers, + and optionally the body of the HTTP request, then signing the hash value using + a private key. The 'Authorization' header is added to outbound HTTP requests. + + NOTE: This class is auto generated by OpenAPI Generator + + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param key_id: A string value specifying the identifier of the cryptographic key, + when signing HTTP requests. + :param signing_scheme: A string value specifying the signature scheme, when + signing HTTP requests. + Supported value are hs2019, rsa-sha256, rsa-sha512. + Avoid using rsa-sha256, rsa-sha512 as they are deprecated. These values are + available for server-side applications that only support the older + HTTP signature algorithms. + :param private_key_path: A string value specifying the path of the file containing + a private key. The private key is used to sign HTTP requests. + :param private_key_passphrase: A string value specifying the passphrase to decrypt + the private key. + :param signed_headers: A list of strings. Each value is the name of a HTTP header + that must be included in the HTTP signature calculation. + The two special signature headers '(request-target)' and '(created)' SHOULD be + included in SignedHeaders. + The '(created)' header expresses when the signature was created. + The '(request-target)' header is a concatenation of the lowercased :method, an + ASCII space, and the :path pseudo-headers. + When signed_headers is not specified, the client defaults to a single value, + '(created)', in the list of HTTP headers. + When SignedHeaders contains the 'Digest' value, the client performs the + following operations: + 1. Calculate a digest of request body, as specified in RFC3230, section 4.3.2. + 2. Set the 'Digest' header in the request body. + 3. Include the 'Digest' header and value in the HTTP signature. + :param signing_algorithm: A string value specifying the signature algorithm, when + signing HTTP requests. + Supported values are: + 1. For RSA keys: RSASSA-PSS, RSASSA-PKCS1-v1_5. + 2. For ECDSA keys: fips-186-3, deterministic-rfc6979. + If None, the signing algorithm is inferred from the private key. + The default signing algorithm for RSA keys is RSASSA-PSS. + The default signing algorithm for ECDSA keys is fips-186-3. + :param hash_algorithm: The hash algorithm for the signature. Supported values are + sha256 and sha512. + If the signing_scheme is rsa-sha256, the hash algorithm must be set + to None or sha256. + If the signing_scheme is rsa-sha512, the hash algorithm must be set + to None or sha512. + :param signature_max_validity: The signature max validity, expressed as + a datetime.timedelta value. It must be a positive value. + """ + def __init__(self, key_id, signing_scheme, private_key_path, + private_key_passphrase=None, + signed_headers=None, + signing_algorithm=None, + hash_algorithm=None, + signature_max_validity=None): + self.key_id = key_id + if signing_scheme not in {SCHEME_HS2019, SCHEME_RSA_SHA256, SCHEME_RSA_SHA512}: + raise Exception("Unsupported security scheme: {0}".format(signing_scheme)) + self.signing_scheme = signing_scheme + if not os.path.exists(private_key_path): + raise Exception("Private key file does not exist") + self.private_key_path = private_key_path + self.private_key_passphrase = private_key_passphrase + self.signing_algorithm = signing_algorithm + self.hash_algorithm = hash_algorithm + if signing_scheme == SCHEME_RSA_SHA256: + if self.hash_algorithm is None: + self.hash_algorithm = HASH_SHA256 + elif self.hash_algorithm != HASH_SHA256: + raise Exception("Hash algorithm must be sha256 when security scheme is %s" % + SCHEME_RSA_SHA256) + elif signing_scheme == SCHEME_RSA_SHA512: + if self.hash_algorithm is None: + self.hash_algorithm = HASH_SHA512 + elif self.hash_algorithm != HASH_SHA512: + raise Exception("Hash algorithm must be sha512 when security scheme is %s" % + SCHEME_RSA_SHA512) + elif signing_scheme == SCHEME_HS2019: + if self.hash_algorithm is None: + self.hash_algorithm = HASH_SHA256 + elif self.hash_algorithm not in {HASH_SHA256, HASH_SHA512}: + raise Exception("Invalid hash algorithm") + if signature_max_validity is not None and signature_max_validity.total_seconds() < 0: + raise Exception("The signature max validity must be a positive value") + self.signature_max_validity = signature_max_validity + # If the user has not provided any signed_headers, the default must be set to '(created)', + # as specified in the 'HTTP signature' standard. + if signed_headers is None or len(signed_headers) == 0: + signed_headers = [HEADER_CREATED] + if self.signature_max_validity is None and HEADER_EXPIRES in signed_headers: + raise Exception( + "Signature max validity must be set when " + "'(expires)' signature parameter is specified") + if len(signed_headers) != len(set(signed_headers)): + raise Exception("Cannot have duplicates in the signed_headers parameter") + if HEADER_AUTHORIZATION in signed_headers: + raise Exception("'Authorization' header cannot be included in signed headers") + self.signed_headers = signed_headers + self.private_key = None + """The private key used to sign HTTP requests. + Initialized when the PEM-encoded private key is loaded from a file. + """ + self.host = None + """The host name, optionally followed by a colon and TCP port number. + """ + self._load_private_key() + + def get_http_signature_headers(self, resource_path, method, headers, body, query_params): + """Create a cryptographic message signature for the HTTP request and add the signed headers. + + :param resource_path : A string representation of the HTTP request resource path. + :param method: A string representation of the HTTP request method, e.g. GET, POST. + :param headers: A dict containing the HTTP request headers. + :param body: The object representing the HTTP request body. + :param query_params: A string representing the HTTP request query parameters. + :return: A dict of HTTP headers that must be added to the outbound HTTP request. + """ + if method is None: + raise Exception("HTTP method must be set") + if resource_path is None: + raise Exception("Resource path must be set") + + signed_headers_list, request_headers_dict = self._get_signed_header_info( + resource_path, method, headers, body, query_params) + + header_items = [ + "{0}: {1}".format(key.lower(), value) for key, value in signed_headers_list] + string_to_sign = "\n".join(header_items) + + digest, digest_prefix = self._get_message_digest(string_to_sign.encode()) + b64_signed_msg = self._sign_digest(digest) + + request_headers_dict[HEADER_AUTHORIZATION] = self._get_authorization_header( + signed_headers_list, b64_signed_msg) + + return request_headers_dict + + def get_public_key(self): + """Returns the public key object associated with the private key. + """ + pubkey = None + if isinstance(self.private_key, RSA.RsaKey): + pubkey = self.private_key.publickey() + elif isinstance(self.private_key, ECC.EccKey): + pubkey = self.private_key.public_key() + return pubkey + + def _load_private_key(self): + """Load the private key used to sign HTTP requests. + The private key is used to sign HTTP requests as defined in + https://datatracker.ietf.org/doc/draft-cavage-http-signatures/. + """ + if self.private_key is not None: + return + with open(self.private_key_path, 'r') as f: + pem_data = f.read() + # Verify PEM Pre-Encapsulation Boundary + r = re.compile(r"\s*-----BEGIN (.*)-----\s+") + m = r.match(pem_data) + if not m: + raise ValueError("Not a valid PEM pre boundary") + pem_header = m.group(1) + if pem_header == 'RSA PRIVATE KEY': + self.private_key = RSA.importKey(pem_data, self.private_key_passphrase) + elif pem_header == 'EC PRIVATE KEY': + self.private_key = ECC.import_key(pem_data, self.private_key_passphrase) + elif pem_header in {'PRIVATE KEY', 'ENCRYPTED PRIVATE KEY'}: + # Key is in PKCS8 format, which is capable of holding many different + # types of private keys, not just EC keys. + (key_binary, pem_header, is_encrypted) = \ + PEM.decode(pem_data, self.private_key_passphrase) + (oid, privkey, params) = \ + PKCS8.unwrap(key_binary, passphrase=self.private_key_passphrase) + if oid == '1.2.840.10045.2.1': + self.private_key = ECC.import_key(pem_data, self.private_key_passphrase) + else: + raise Exception("Unsupported key: {0}. OID: {1}".format(pem_header, oid)) + else: + raise Exception("Unsupported key: {0}".format(pem_header)) + # Validate the specified signature algorithm is compatible with the private key. + if self.signing_algorithm is not None: + supported_algs = None + if isinstance(self.private_key, RSA.RsaKey): + supported_algs = {ALGORITHM_RSASSA_PSS, ALGORITHM_RSASSA_PKCS1v15} + elif isinstance(self.private_key, ECC.EccKey): + supported_algs = ALGORITHM_ECDSA_KEY_SIGNING_ALGORITHMS + if supported_algs is not None and self.signing_algorithm not in supported_algs: + raise Exception( + "Signing algorithm {0} is not compatible with private key".format( + self.signing_algorithm)) + + def _get_signed_header_info(self, resource_path, method, headers, body, query_params): + """Build the HTTP headers (name, value) that need to be included in + the HTTP signature scheme. + + :param resource_path : A string representation of the HTTP request resource path. + :param method: A string representation of the HTTP request method, e.g. GET, POST. + :param headers: A dict containing the HTTP request headers. + :param body: The object (e.g. a dict) representing the HTTP request body. + :param query_params: A string representing the HTTP request query parameters. + :return: A tuple containing two dict objects: + The first dict contains the HTTP headers that are used to calculate + the HTTP signature. + The second dict contains the HTTP headers that must be added to + the outbound HTTP request. + """ + + if body is None: + body = '' + else: + body = json.dumps(body) + + # Build the '(request-target)' HTTP signature parameter. + target_host = urlparse(self.host).netloc + target_path = urlparse(self.host).path + request_target = method.lower() + " " + target_path + resource_path + if query_params: + request_target += "?" + urlencode(query_params) + + # Get UNIX time, e.g. seconds since epoch, not including leap seconds. + now = time() + # Format date per RFC 7231 section-7.1.1.2. An example is: + # Date: Wed, 21 Oct 2015 07:28:00 GMT + cdate = formatdate(timeval=now, localtime=False, usegmt=True) + # The '(created)' value MUST be a Unix timestamp integer value. + # Subsecond precision is not supported. + created = int(now) + if self.signature_max_validity is not None: + expires = now + self.signature_max_validity.total_seconds() + + signed_headers_list = [] + request_headers_dict = {} + for hdr_key in self.signed_headers: + hdr_key = hdr_key.lower() + if hdr_key == HEADER_REQUEST_TARGET: + value = request_target + elif hdr_key == HEADER_CREATED: + value = '{0}'.format(created) + elif hdr_key == HEADER_EXPIRES: + value = '{0}'.format(expires) + elif hdr_key == HEADER_DATE.lower(): + value = cdate + request_headers_dict[HEADER_DATE] = '{0}'.format(cdate) + elif hdr_key == HEADER_DIGEST.lower(): + request_body = body.encode() + body_digest, digest_prefix = self._get_message_digest(request_body) + b64_body_digest = b64encode(body_digest.digest()) + value = digest_prefix + b64_body_digest.decode('ascii') + request_headers_dict[HEADER_DIGEST] = '{0}{1}'.format( + digest_prefix, b64_body_digest.decode('ascii')) + elif hdr_key == HEADER_HOST.lower(): + value = target_host + request_headers_dict[HEADER_HOST] = '{0}'.format(target_host) + else: + value = next((v for k, v in headers.items() if k.lower() == hdr_key), None) + if value is None: + raise Exception( + "Cannot sign HTTP request. " + "Request does not contain the '{0}' header".format(hdr_key)) + signed_headers_list.append((hdr_key, value)) + + return signed_headers_list, request_headers_dict + + def _get_message_digest(self, data): + """Calculates and returns a cryptographic digest of a specified HTTP request. + + :param data: The string representation of the date to be hashed with a cryptographic hash. + :return: A tuple of (digest, prefix). + The digest is a hashing object that contains the cryptographic digest of + the HTTP request. + The prefix is a string that identifies the cryptographc hash. It is used + to generate the 'Digest' header as specified in RFC 3230. + """ + if self.hash_algorithm == HASH_SHA512: + digest = SHA512.new() + prefix = 'SHA-512=' + elif self.hash_algorithm == HASH_SHA256: + digest = SHA256.new() + prefix = 'SHA-256=' + else: + raise Exception("Unsupported hash algorithm: {0}".format(self.hash_algorithm)) + digest.update(data) + return digest, prefix + + def _sign_digest(self, digest): + """Signs a message digest with a private key specified in the signing_info. + + :param digest: A hashing object that contains the cryptographic digest of the HTTP request. + :return: A base-64 string representing the cryptographic signature of the input digest. + """ + sig_alg = self.signing_algorithm + if isinstance(self.private_key, RSA.RsaKey): + if sig_alg is None or sig_alg == ALGORITHM_RSASSA_PSS: + # RSASSA-PSS in Section 8.1 of RFC8017. + signature = pss.new(self.private_key).sign(digest) + elif sig_alg == ALGORITHM_RSASSA_PKCS1v15: + # RSASSA-PKCS1-v1_5 in Section 8.2 of RFC8017. + signature = PKCS1_v1_5.new(self.private_key).sign(digest) + else: + raise Exception("Unsupported signature algorithm: {0}".format(sig_alg)) + elif isinstance(self.private_key, ECC.EccKey): + if sig_alg is None: + sig_alg = ALGORITHM_ECDSA_MODE_FIPS_186_3 + if sig_alg in ALGORITHM_ECDSA_KEY_SIGNING_ALGORITHMS: + # draft-ietf-httpbis-message-signatures-00 does not specify the ECDSA encoding. + # Issue: https://github.com/w3c-ccg/http-signatures/issues/107 + signature = DSS.new(key=self.private_key, mode=sig_alg, + encoding='der').sign(digest) + else: + raise Exception("Unsupported signature algorithm: {0}".format(sig_alg)) + else: + raise Exception("Unsupported private key: {0}".format(type(self.private_key))) + return b64encode(signature) + + def _get_authorization_header(self, signed_headers, signed_msg): + """Calculates and returns the value of the 'Authorization' header when signing HTTP requests. + + :param signed_headers : A list of tuples. Each value is the name of a HTTP header that + must be included in the HTTP signature calculation. + :param signed_msg: A base-64 encoded string representation of the signature. + :return: The string value of the 'Authorization' header, representing the signature + of the HTTP request. + """ + created_ts = None + expires_ts = None + for k, v in signed_headers: + if k == HEADER_CREATED: + created_ts = v + elif k == HEADER_EXPIRES: + expires_ts = v + lower_keys = [k.lower() for k, v in signed_headers] + headers_value = " ".join(lower_keys) + + auth_str = "Signature keyId=\"{0}\",algorithm=\"{1}\",".format( + self.key_id, self.signing_scheme) + if created_ts is not None: + auth_str = auth_str + "created={0},".format(created_ts) + if expires_ts is not None: + auth_str = auth_str + "expires={0},".format(expires_ts) + auth_str = auth_str + "headers=\"{0}\",signature=\"{1}\"".format( + headers_value, signed_msg.decode('ascii')) + + return auth_str diff --git a/.generator/templates/test-requirements.mustache b/.generator/templates/test-requirements.mustache new file mode 100644 index 0000000000..635b816e74 --- /dev/null +++ b/.generator/templates/test-requirements.mustache @@ -0,0 +1,13 @@ +{{#useNose}} +coverage>=4.0.3 +nose>=1.3.7 +pluggy>=0.3.1 +py>=1.4.31 +randomize>=0.13 +{{/useNose}} +{{^useNose}} +pytest-cov>=2.8.1 +{{/useNose}} +{{#hasHttpSignatureMethods}} +pycryptodome>=3.9.0 +{{/hasHttpSignatureMethods}} diff --git a/.generator/templates/tornado/rest.mustache b/.generator/templates/tornado/rest.mustache new file mode 100644 index 0000000000..9e5cc12092 --- /dev/null +++ b/.generator/templates/tornado/rest.mustache @@ -0,0 +1,222 @@ +{{>partial_header}} + +import io +import json +import logging +import re + +# python 2 and python 3 compatibility library +from six.moves.urllib.parse import urlencode +import tornado +import tornado.gen +from tornado import httpclient +from urllib3.filepost import encode_multipart_formdata + +from {{packageName}}.exceptions import ApiException, ApiValueError + +logger = logging.getLogger(__name__) + + +class RESTResponse(io.IOBase): + + def __init__(self, resp): + self.tornado_response = resp + self.status = resp.code + self.reason = resp.reason + + if resp.body: + self.data = resp.body + else: + self.data = None + + def getheaders(self): + """Returns a CIMultiDictProxy of the response headers.""" + return self.tornado_response.headers + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.tornado_response.headers.get(name, default) + + +class RESTClientObject(object): + + def __init__(self, configuration, pools_size=4, maxsize=4): + # maxsize is number of requests to host that are allowed in parallel + + self.ca_certs = configuration.ssl_ca_cert + self.client_key = configuration.key_file + self.client_cert = configuration.cert_file + + self.proxy_port = self.proxy_host = None + + # https pool manager + if configuration.proxy: + self.proxy_port = 80 + self.proxy_host = configuration.proxy + + self.pool_manager = httpclient.AsyncHTTPClient() + + @tornado.gen.coroutine + def request(self, method, url, query_params=None, headers=None, body=None, + post_params=None, _preload_content=True, + _request_timeout=None): + """Execute Request + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _preload_content: this is a non-applicable field for + the AiohttpClient. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + """ + method = method.upper() + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + request = httpclient.HTTPRequest(url) + request.allow_nonstandard_methods = True + request.ca_certs = self.ca_certs + request.client_key = self.client_key + request.client_cert = self.client_cert + request.proxy_host = self.proxy_host + request.proxy_port = self.proxy_port + request.method = method + if headers: + request.headers = headers + if 'Content-Type' not in headers: + request.headers['Content-Type'] = 'application/json' + request.request_timeout = _request_timeout or 5 * 60 + + post_params = post_params or {} + + if query_params: + request.url += '?' + urlencode(query_params) + + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + if re.search('json', headers['Content-Type'], re.IGNORECASE): + if body: + body = json.dumps(body) + request.body = body + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + request.body = urlencode(post_params) + elif headers['Content-Type'] == 'multipart/form-data': + multipart = encode_multipart_formdata(post_params) + request.body, headers['Content-Type'] = multipart + # Pass a `bytes` parameter directly in the body to support + # other content types than Json when `body` argument is provided + # in serialized form + elif isinstance(body, bytes): + request.body = body + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + + r = yield self.pool_manager.fetch(request, raise_error=False) + + if _preload_content: + + r = RESTResponse(r) + + # log response body + logger.debug("response body: %s", r.data) + + if not 200 <= r.status <= 299: + raise ApiException(http_resp=r) + + raise tornado.gen.Return(r) + + @tornado.gen.coroutine + def GET(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + result = yield self.request("GET", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + raise tornado.gen.Return(result) + + @tornado.gen.coroutine + def HEAD(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + result = yield self.request("HEAD", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + raise tornado.gen.Return(result) + + @tornado.gen.coroutine + def OPTIONS(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + result = yield self.request("OPTIONS", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + raise tornado.gen.Return(result) + + @tornado.gen.coroutine + def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): + result = yield self.request("DELETE", url, + headers=headers, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + raise tornado.gen.Return(result) + + @tornado.gen.coroutine + def POST(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + result = yield self.request("POST", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + raise tornado.gen.Return(result) + + @tornado.gen.coroutine + def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + result = yield self.request("PUT", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + raise tornado.gen.Return(result) + + @tornado.gen.coroutine + def PATCH(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + result = yield self.request("PATCH", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + raise tornado.gen.Return(result) diff --git a/.generator/templates/tox.mustache b/.generator/templates/tox.mustache new file mode 100644 index 0000000000..4c771c472b --- /dev/null +++ b/.generator/templates/tox.mustache @@ -0,0 +1,9 @@ +[tox] +envlist = py3 + +[testenv] +deps=-r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +commands= + {{^useNose}}pytest --cov={{{packageName}}}{{/useNose}}{{#useNose}}nosetests{{/useNose}} diff --git a/.generator/templates/travis.mustache b/.generator/templates/travis.mustache new file mode 100644 index 0000000000..a26c984f3d --- /dev/null +++ b/.generator/templates/travis.mustache @@ -0,0 +1,18 @@ +# ref: https://docs.travis-ci.com/user/languages/python +language: python +python: + - "3.6" + - "3.7" + - "3.8" + - "3.9" +# command to install dependencies +install: + - "pip install -r requirements.txt" + - "pip install -r test-requirements.txt" +# command to run tests +{{#useNose}} +script: nosetests +{{/useNose}} +{{^useNose}} +script: pytest --cov={{{packageName}}} +{{/useNose}} diff --git a/docs/v1/APIErrorResponse.md b/docs/v1/APIErrorResponse.md index d4b0f118e6..ad0fdede58 100644 --- a/docs/v1/APIErrorResponse.md +++ b/docs/v1/APIErrorResponse.md @@ -1,6 +1,7 @@ # APIErrorResponse Error response object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSAccount.md b/docs/v1/AWSAccount.md index c8db243d6a..8c68af3891 100644 --- a/docs/v1/AWSAccount.md +++ b/docs/v1/AWSAccount.md @@ -1,6 +1,7 @@ # AWSAccount Returns the AWS account associated with this integration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSAccountAndLambdaRequest.md b/docs/v1/AWSAccountAndLambdaRequest.md index 4c34aae4c7..bb9ecee3bc 100644 --- a/docs/v1/AWSAccountAndLambdaRequest.md +++ b/docs/v1/AWSAccountAndLambdaRequest.md @@ -1,6 +1,7 @@ # AWSAccountAndLambdaRequest AWS account ID and Lambda ARN. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSAccountCreateResponse.md b/docs/v1/AWSAccountCreateResponse.md index e60f6de970..2d6a57c0ee 100644 --- a/docs/v1/AWSAccountCreateResponse.md +++ b/docs/v1/AWSAccountCreateResponse.md @@ -1,6 +1,7 @@ # AWSAccountCreateResponse The Response returned by the AWS Create Account call. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSAccountListResponse.md b/docs/v1/AWSAccountListResponse.md index c5ae988020..fe3b15b09a 100644 --- a/docs/v1/AWSAccountListResponse.md +++ b/docs/v1/AWSAccountListResponse.md @@ -1,6 +1,7 @@ # AWSAccountListResponse List of enabled AWS accounts. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSIntegrationApi.md b/docs/v1/AWSIntegrationApi.md index 29c5d49efa..ad01004c30 100644 --- a/docs/v1/AWSIntegrationApi.md +++ b/docs/v1/AWSIntegrationApi.md @@ -72,6 +72,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->create_aws_account: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -91,6 +92,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -151,6 +153,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->create_aws_tag_filter: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -170,6 +173,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -236,6 +240,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->create_new_aws_external_id: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -255,6 +260,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -321,6 +327,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->delete_aws_account: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -340,6 +347,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -399,6 +407,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->delete_aws_tag_filter: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -418,6 +427,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -472,6 +482,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->list_available_aws_namespaces: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -488,6 +499,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -545,6 +557,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->list_aws_accounts: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -566,6 +579,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -621,6 +635,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->list_aws_tag_filters: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -640,6 +655,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -718,6 +734,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSIntegrationApi->update_aws_account: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -740,6 +757,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/AWSLogsAsyncError.md b/docs/v1/AWSLogsAsyncError.md index 30f69068cb..d720ffd92a 100644 --- a/docs/v1/AWSLogsAsyncError.md +++ b/docs/v1/AWSLogsAsyncError.md @@ -1,6 +1,7 @@ # AWSLogsAsyncError Description of errors. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSLogsAsyncResponse.md b/docs/v1/AWSLogsAsyncResponse.md index 90c64bcd3a..5dca461bbe 100644 --- a/docs/v1/AWSLogsAsyncResponse.md +++ b/docs/v1/AWSLogsAsyncResponse.md @@ -1,6 +1,7 @@ # AWSLogsAsyncResponse A list of all Datadog-AWS logs integrations available in your Datadog organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSLogsIntegrationApi.md b/docs/v1/AWSLogsIntegrationApi.md index 8716841a79..122a7091fa 100644 --- a/docs/v1/AWSLogsIntegrationApi.md +++ b/docs/v1/AWSLogsIntegrationApi.md @@ -62,6 +62,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSLogsIntegrationApi->check_aws_logs_lambda_async: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -81,6 +82,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -139,6 +141,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSLogsIntegrationApi->check_aws_logs_services_async: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -158,6 +161,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -216,6 +220,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSLogsIntegrationApi->create_aws_lambda_arn: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -235,6 +240,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -293,6 +299,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSLogsIntegrationApi->delete_aws_lambda_arn: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -312,6 +319,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -370,6 +378,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSLogsIntegrationApi->enable_aws_log_services: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -389,6 +398,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -443,6 +453,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSLogsIntegrationApi->list_aws_logs_integrations: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -459,6 +470,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -513,6 +525,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AWSLogsIntegrationApi->list_aws_logs_services: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -529,6 +542,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/AWSLogsLambda.md b/docs/v1/AWSLogsLambda.md index 6641959204..f1fb601cd1 100644 --- a/docs/v1/AWSLogsLambda.md +++ b/docs/v1/AWSLogsLambda.md @@ -1,6 +1,7 @@ # AWSLogsLambda Description of the Lambdas. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSLogsListResponse.md b/docs/v1/AWSLogsListResponse.md index 9cae9b51a9..cbc9816b5c 100644 --- a/docs/v1/AWSLogsListResponse.md +++ b/docs/v1/AWSLogsListResponse.md @@ -1,6 +1,7 @@ # AWSLogsListResponse A list of all Datadog-AWS logs integrations available in your Datadog organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSLogsListServicesResponse.md b/docs/v1/AWSLogsListServicesResponse.md index 9b104a8089..3946882f01 100644 --- a/docs/v1/AWSLogsListServicesResponse.md +++ b/docs/v1/AWSLogsListServicesResponse.md @@ -1,6 +1,7 @@ # AWSLogsListServicesResponse The list of current AWS services for which Datadog offers automatic log collection. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSLogsServicesRequest.md b/docs/v1/AWSLogsServicesRequest.md index 8db6f1a5b6..780b0420db 100644 --- a/docs/v1/AWSLogsServicesRequest.md +++ b/docs/v1/AWSLogsServicesRequest.md @@ -1,6 +1,7 @@ # AWSLogsServicesRequest A list of current AWS services for which Datadog offers automatic log collection. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSNamespace.md b/docs/v1/AWSNamespace.md index cf0ce68c2e..d16aca9b3b 100644 --- a/docs/v1/AWSNamespace.md +++ b/docs/v1/AWSNamespace.md @@ -1,6 +1,7 @@ # AWSNamespace The namespace associated with the tag filter entry. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSTagFilter.md b/docs/v1/AWSTagFilter.md index c0afbb2def..0144b54d48 100644 --- a/docs/v1/AWSTagFilter.md +++ b/docs/v1/AWSTagFilter.md @@ -1,6 +1,7 @@ # AWSTagFilter A tag filter. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSTagFilterCreateRequest.md b/docs/v1/AWSTagFilterCreateRequest.md index 4eb0a587db..831e84dd98 100644 --- a/docs/v1/AWSTagFilterCreateRequest.md +++ b/docs/v1/AWSTagFilterCreateRequest.md @@ -1,6 +1,7 @@ # AWSTagFilterCreateRequest The objects used to set an AWS tag filter. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSTagFilterDeleteRequest.md b/docs/v1/AWSTagFilterDeleteRequest.md index adb1e7ea71..629228ebd1 100644 --- a/docs/v1/AWSTagFilterDeleteRequest.md +++ b/docs/v1/AWSTagFilterDeleteRequest.md @@ -1,6 +1,7 @@ # AWSTagFilterDeleteRequest The objects used to delete an AWS tag filter entry. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AWSTagFilterListResponse.md b/docs/v1/AWSTagFilterListResponse.md index 79e5f946d7..255253c4ee 100644 --- a/docs/v1/AWSTagFilterListResponse.md +++ b/docs/v1/AWSTagFilterListResponse.md @@ -1,6 +1,7 @@ # AWSTagFilterListResponse An array of tag filter rules by `namespace` and tag filter string. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AccessRole.md b/docs/v1/AccessRole.md index a865cbb40c..0c13203cb8 100644 --- a/docs/v1/AccessRole.md +++ b/docs/v1/AccessRole.md @@ -1,6 +1,7 @@ # AccessRole The access role of the user. Options are **st** (standard user), **adm** (admin user), or **ro** (read-only user). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AlertGraphWidgetDefinition.md b/docs/v1/AlertGraphWidgetDefinition.md index 654e540de3..e26e340f5c 100644 --- a/docs/v1/AlertGraphWidgetDefinition.md +++ b/docs/v1/AlertGraphWidgetDefinition.md @@ -1,6 +1,7 @@ # AlertGraphWidgetDefinition Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AlertGraphWidgetDefinitionType.md b/docs/v1/AlertGraphWidgetDefinitionType.md index d94d36f7d7..563cf8fc35 100644 --- a/docs/v1/AlertGraphWidgetDefinitionType.md +++ b/docs/v1/AlertGraphWidgetDefinitionType.md @@ -1,6 +1,7 @@ # AlertGraphWidgetDefinitionType Type of the alert graph widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AlertValueWidgetDefinition.md b/docs/v1/AlertValueWidgetDefinition.md index d6429b7716..9c61c0ebbe 100644 --- a/docs/v1/AlertValueWidgetDefinition.md +++ b/docs/v1/AlertValueWidgetDefinition.md @@ -1,6 +1,7 @@ # AlertValueWidgetDefinition Alert values are query values showing the current value of the metric in any monitor defined on your system. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AlertValueWidgetDefinitionType.md b/docs/v1/AlertValueWidgetDefinitionType.md index 7c10d63d94..64ff599233 100644 --- a/docs/v1/AlertValueWidgetDefinitionType.md +++ b/docs/v1/AlertValueWidgetDefinitionType.md @@ -1,6 +1,7 @@ # AlertValueWidgetDefinitionType Type of the alert value widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApiKey.md b/docs/v1/ApiKey.md index e66fd027ea..5048de007a 100644 --- a/docs/v1/ApiKey.md +++ b/docs/v1/ApiKey.md @@ -1,6 +1,7 @@ # ApiKey Datadog API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApiKeyListResponse.md b/docs/v1/ApiKeyListResponse.md index 8190369a7e..9fae0737ca 100644 --- a/docs/v1/ApiKeyListResponse.md +++ b/docs/v1/ApiKeyListResponse.md @@ -1,6 +1,7 @@ # ApiKeyListResponse List of API and application keys available for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApiKeyResponse.md b/docs/v1/ApiKeyResponse.md index b860ca32fd..688ef85c29 100644 --- a/docs/v1/ApiKeyResponse.md +++ b/docs/v1/ApiKeyResponse.md @@ -1,6 +1,7 @@ # ApiKeyResponse An API key with its associated metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApmStatsQueryColumnType.md b/docs/v1/ApmStatsQueryColumnType.md index cdc6b80451..f8550dff78 100644 --- a/docs/v1/ApmStatsQueryColumnType.md +++ b/docs/v1/ApmStatsQueryColumnType.md @@ -1,6 +1,7 @@ # ApmStatsQueryColumnType Column properties. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApmStatsQueryDefinition.md b/docs/v1/ApmStatsQueryDefinition.md index 1578a8b5a8..3f489dd859 100644 --- a/docs/v1/ApmStatsQueryDefinition.md +++ b/docs/v1/ApmStatsQueryDefinition.md @@ -1,6 +1,7 @@ # ApmStatsQueryDefinition The APM stats query for table and distributions widgets. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApmStatsQueryRowType.md b/docs/v1/ApmStatsQueryRowType.md index dbdceedc0f..c2b347fb81 100644 --- a/docs/v1/ApmStatsQueryRowType.md +++ b/docs/v1/ApmStatsQueryRowType.md @@ -1,6 +1,7 @@ # ApmStatsQueryRowType The level of detail for the request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApplicationKey.md b/docs/v1/ApplicationKey.md index 29ee3962d2..60d02f0437 100644 --- a/docs/v1/ApplicationKey.md +++ b/docs/v1/ApplicationKey.md @@ -1,6 +1,7 @@ # ApplicationKey An application key with its associated metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApplicationKeyListResponse.md b/docs/v1/ApplicationKeyListResponse.md index 9a5bab8219..ae00dcf1f4 100644 --- a/docs/v1/ApplicationKeyListResponse.md +++ b/docs/v1/ApplicationKeyListResponse.md @@ -1,6 +1,7 @@ # ApplicationKeyListResponse An application key response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ApplicationKeyResponse.md b/docs/v1/ApplicationKeyResponse.md index 28828008f2..9c90417b6e 100644 --- a/docs/v1/ApplicationKeyResponse.md +++ b/docs/v1/ApplicationKeyResponse.md @@ -1,6 +1,7 @@ # ApplicationKeyResponse An application key response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AuthenticationApi.md b/docs/v1/AuthenticationApi.md index fd76897834..536d271349 100644 --- a/docs/v1/AuthenticationApi.md +++ b/docs/v1/AuthenticationApi.md @@ -48,6 +48,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AuthenticationApi->validate: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -64,6 +65,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/AuthenticationValidationResponse.md b/docs/v1/AuthenticationValidationResponse.md index 9e351c983f..3322abb45f 100644 --- a/docs/v1/AuthenticationValidationResponse.md +++ b/docs/v1/AuthenticationValidationResponse.md @@ -1,6 +1,7 @@ # AuthenticationValidationResponse Represent validation endpoint responses. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AzureAccount.md b/docs/v1/AzureAccount.md index fc66773c5e..b0ccd6ed8a 100644 --- a/docs/v1/AzureAccount.md +++ b/docs/v1/AzureAccount.md @@ -1,6 +1,7 @@ # AzureAccount Datadog-Azure integrations configured for your organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AzureAccountListResponse.md b/docs/v1/AzureAccountListResponse.md index ccf4ce580b..144db3afd5 100644 --- a/docs/v1/AzureAccountListResponse.md +++ b/docs/v1/AzureAccountListResponse.md @@ -1,6 +1,7 @@ # AzureAccountListResponse Accounts configured for your organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/AzureIntegrationApi.md b/docs/v1/AzureIntegrationApi.md index 048cad1e0b..3816f249e9 100644 --- a/docs/v1/AzureIntegrationApi.md +++ b/docs/v1/AzureIntegrationApi.md @@ -65,6 +65,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AzureIntegrationApi->create_azure_integration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -84,6 +85,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -147,6 +149,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AzureIntegrationApi->delete_azure_integration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -166,6 +169,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -220,6 +224,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AzureIntegrationApi->list_azure_integration: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -236,6 +241,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -299,6 +305,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AzureIntegrationApi->update_azure_host_filters: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -318,6 +325,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -381,6 +389,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling AzureIntegrationApi->update_azure_integration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -400,6 +409,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/CancelDowntimesByScopeRequest.md b/docs/v1/CancelDowntimesByScopeRequest.md index 2ba4d479d1..9ebbc9bbf1 100644 --- a/docs/v1/CancelDowntimesByScopeRequest.md +++ b/docs/v1/CancelDowntimesByScopeRequest.md @@ -1,6 +1,7 @@ # CancelDowntimesByScopeRequest Cancel downtimes according to scope. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/CanceledDowntimesIds.md b/docs/v1/CanceledDowntimesIds.md index 2d02527eb1..e4d3728605 100644 --- a/docs/v1/CanceledDowntimesIds.md +++ b/docs/v1/CanceledDowntimesIds.md @@ -1,6 +1,7 @@ # CanceledDowntimesIds Object containing array of IDs of canceled downtimes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ChangeWidgetDefinition.md b/docs/v1/ChangeWidgetDefinition.md index 6cbfdc0e8c..1e71a955a9 100644 --- a/docs/v1/ChangeWidgetDefinition.md +++ b/docs/v1/ChangeWidgetDefinition.md @@ -1,6 +1,7 @@ # ChangeWidgetDefinition The Change graph shows you the change in a value over the time period chosen. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ChangeWidgetDefinitionType.md b/docs/v1/ChangeWidgetDefinitionType.md index 93214fa0f2..3d3bdca350 100644 --- a/docs/v1/ChangeWidgetDefinitionType.md +++ b/docs/v1/ChangeWidgetDefinitionType.md @@ -1,6 +1,7 @@ # ChangeWidgetDefinitionType Type of the change widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ChangeWidgetRequest.md b/docs/v1/ChangeWidgetRequest.md index 61904ec2e6..757652a21f 100644 --- a/docs/v1/ChangeWidgetRequest.md +++ b/docs/v1/ChangeWidgetRequest.md @@ -1,6 +1,7 @@ # ChangeWidgetRequest Updated change widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/CheckCanDeleteMonitorResponse.md b/docs/v1/CheckCanDeleteMonitorResponse.md index eb25e5e7b4..9af024b507 100644 --- a/docs/v1/CheckCanDeleteMonitorResponse.md +++ b/docs/v1/CheckCanDeleteMonitorResponse.md @@ -1,6 +1,7 @@ # CheckCanDeleteMonitorResponse Response of monitor IDs that can or can't be safely deleted. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/CheckCanDeleteMonitorResponseData.md b/docs/v1/CheckCanDeleteMonitorResponseData.md index 4e993d90a5..cd9a7f8998 100644 --- a/docs/v1/CheckCanDeleteMonitorResponseData.md +++ b/docs/v1/CheckCanDeleteMonitorResponseData.md @@ -1,6 +1,7 @@ # CheckCanDeleteMonitorResponseData Wrapper object with the list of monitor IDs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/CheckCanDeleteSLOResponse.md b/docs/v1/CheckCanDeleteSLOResponse.md index cd719e7ec3..c04310b2d1 100644 --- a/docs/v1/CheckCanDeleteSLOResponse.md +++ b/docs/v1/CheckCanDeleteSLOResponse.md @@ -1,6 +1,7 @@ # CheckCanDeleteSLOResponse A service level objective response containing the requested object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/CheckCanDeleteSLOResponseData.md b/docs/v1/CheckCanDeleteSLOResponseData.md index d8bd7de1d6..826f919cc5 100644 --- a/docs/v1/CheckCanDeleteSLOResponseData.md +++ b/docs/v1/CheckCanDeleteSLOResponseData.md @@ -1,6 +1,7 @@ # CheckCanDeleteSLOResponseData An array of service level objective objects. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/CheckStatusWidgetDefinition.md b/docs/v1/CheckStatusWidgetDefinition.md index e05f76ab61..8fed87458f 100644 --- a/docs/v1/CheckStatusWidgetDefinition.md +++ b/docs/v1/CheckStatusWidgetDefinition.md @@ -1,6 +1,7 @@ # CheckStatusWidgetDefinition Check status shows the current status or number of results for any check performed. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/CheckStatusWidgetDefinitionType.md b/docs/v1/CheckStatusWidgetDefinitionType.md index 38c683cd09..8727b40644 100644 --- a/docs/v1/CheckStatusWidgetDefinitionType.md +++ b/docs/v1/CheckStatusWidgetDefinitionType.md @@ -1,6 +1,7 @@ # CheckStatusWidgetDefinitionType Type of the check status widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/Creator.md b/docs/v1/Creator.md index 15c2d2a969..023e476317 100644 --- a/docs/v1/Creator.md +++ b/docs/v1/Creator.md @@ -1,6 +1,7 @@ # Creator Object describing the creator of the shared element. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/Dashboard.md b/docs/v1/Dashboard.md index 1f38fde7bf..26f38e0a08 100644 --- a/docs/v1/Dashboard.md +++ b/docs/v1/Dashboard.md @@ -1,6 +1,7 @@ # Dashboard A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardDeleteResponse.md b/docs/v1/DashboardDeleteResponse.md index c9aeb209d7..54befd3274 100644 --- a/docs/v1/DashboardDeleteResponse.md +++ b/docs/v1/DashboardDeleteResponse.md @@ -1,6 +1,7 @@ # DashboardDeleteResponse Response from the delete dashboard call. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardLayoutType.md b/docs/v1/DashboardLayoutType.md index a24cf1c7d1..24072235ad 100644 --- a/docs/v1/DashboardLayoutType.md +++ b/docs/v1/DashboardLayoutType.md @@ -1,6 +1,7 @@ # DashboardLayoutType Layout type of the dashboard. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardList.md b/docs/v1/DashboardList.md index b12232bab6..a5f19d388f 100644 --- a/docs/v1/DashboardList.md +++ b/docs/v1/DashboardList.md @@ -1,6 +1,7 @@ # DashboardList Your Datadog Dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardListDeleteResponse.md b/docs/v1/DashboardListDeleteResponse.md index d48dabb86a..5c915470f0 100644 --- a/docs/v1/DashboardListDeleteResponse.md +++ b/docs/v1/DashboardListDeleteResponse.md @@ -1,6 +1,7 @@ # DashboardListDeleteResponse Deleted dashboard details. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardListListResponse.md b/docs/v1/DashboardListListResponse.md index 880bf2c43f..28ceaa0d2e 100644 --- a/docs/v1/DashboardListListResponse.md +++ b/docs/v1/DashboardListListResponse.md @@ -1,6 +1,7 @@ # DashboardListListResponse Information on your dashboard lists. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardListsApi.md b/docs/v1/DashboardListsApi.md index 365374be8e..835231293b 100644 --- a/docs/v1/DashboardListsApi.md +++ b/docs/v1/DashboardListsApi.md @@ -70,6 +70,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->create_dashboard_list: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -89,6 +90,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -144,6 +146,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->delete_dashboard_list: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -163,6 +166,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -218,6 +222,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->get_dashboard_list: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -237,6 +242,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -291,6 +297,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->list_dashboard_lists: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -307,6 +314,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -375,6 +383,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->update_dashboard_list: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -395,6 +404,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/DashboardSummary.md b/docs/v1/DashboardSummary.md index 1fc2435c93..2fa874b7d3 100644 --- a/docs/v1/DashboardSummary.md +++ b/docs/v1/DashboardSummary.md @@ -1,6 +1,7 @@ # DashboardSummary Dashboard summary response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardSummaryDefinition.md b/docs/v1/DashboardSummaryDefinition.md index 9cababa371..22566c135c 100644 --- a/docs/v1/DashboardSummaryDefinition.md +++ b/docs/v1/DashboardSummaryDefinition.md @@ -1,6 +1,7 @@ # DashboardSummaryDefinition Dashboard definition. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardTemplateVariable.md b/docs/v1/DashboardTemplateVariable.md index 35b32acf2d..f7218c7950 100644 --- a/docs/v1/DashboardTemplateVariable.md +++ b/docs/v1/DashboardTemplateVariable.md @@ -1,6 +1,7 @@ # DashboardTemplateVariable Template variable. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardTemplateVariablePreset.md b/docs/v1/DashboardTemplateVariablePreset.md index 93aa7f21d1..c3a4316171 100644 --- a/docs/v1/DashboardTemplateVariablePreset.md +++ b/docs/v1/DashboardTemplateVariablePreset.md @@ -1,6 +1,7 @@ # DashboardTemplateVariablePreset Template variables saved views. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardTemplateVariablePresetValue.md b/docs/v1/DashboardTemplateVariablePresetValue.md index 282db95a6f..09473be9b2 100644 --- a/docs/v1/DashboardTemplateVariablePresetValue.md +++ b/docs/v1/DashboardTemplateVariablePresetValue.md @@ -1,6 +1,7 @@ # DashboardTemplateVariablePresetValue Template variables saved views. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DashboardsApi.md b/docs/v1/DashboardsApi.md index 5f7dda722a..88b99d40a6 100644 --- a/docs/v1/DashboardsApi.md +++ b/docs/v1/DashboardsApi.md @@ -89,6 +89,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardsApi->create_dashboard: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -108,6 +109,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -163,6 +165,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardsApi->delete_dashboard: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -182,6 +185,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -237,6 +241,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardsApi->get_dashboard: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -256,6 +261,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -310,6 +316,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardsApi->list_dashboards: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -326,6 +333,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -413,6 +421,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardsApi->update_dashboard: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -433,6 +442,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/DeletedMonitor.md b/docs/v1/DeletedMonitor.md index 98c2237dda..32e380ee92 100644 --- a/docs/v1/DeletedMonitor.md +++ b/docs/v1/DeletedMonitor.md @@ -1,6 +1,7 @@ # DeletedMonitor Response from the delete monitor call. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DistributionWidgetDefinition.md b/docs/v1/DistributionWidgetDefinition.md index 33357bcea7..165f07f497 100644 --- a/docs/v1/DistributionWidgetDefinition.md +++ b/docs/v1/DistributionWidgetDefinition.md @@ -1,6 +1,7 @@ # DistributionWidgetDefinition The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DistributionWidgetDefinitionType.md b/docs/v1/DistributionWidgetDefinitionType.md index ddba11a761..7d5fb08a80 100644 --- a/docs/v1/DistributionWidgetDefinitionType.md +++ b/docs/v1/DistributionWidgetDefinitionType.md @@ -1,6 +1,7 @@ # DistributionWidgetDefinitionType Type of the distribution widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DistributionWidgetRequest.md b/docs/v1/DistributionWidgetRequest.md index c8efb2ed73..4ab4e71f5f 100644 --- a/docs/v1/DistributionWidgetRequest.md +++ b/docs/v1/DistributionWidgetRequest.md @@ -1,6 +1,7 @@ # DistributionWidgetRequest Updated distribution widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/Downtime.md b/docs/v1/Downtime.md index 74bd3742ab..20db9aa77e 100644 --- a/docs/v1/Downtime.md +++ b/docs/v1/Downtime.md @@ -1,6 +1,7 @@ # Downtime Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DowntimeRecurrence.md b/docs/v1/DowntimeRecurrence.md index 5e2b47b957..9950ea76ab 100644 --- a/docs/v1/DowntimeRecurrence.md +++ b/docs/v1/DowntimeRecurrence.md @@ -1,6 +1,7 @@ # DowntimeRecurrence An object defining the recurrence of the downtime. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/DowntimesApi.md b/docs/v1/DowntimesApi.md index ea0a9c9da0..1f350030ff 100644 --- a/docs/v1/DowntimesApi.md +++ b/docs/v1/DowntimesApi.md @@ -57,6 +57,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DowntimesApi->cancel_downtime: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -76,6 +77,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -133,6 +135,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DowntimesApi->cancel_downtimes_by_scope: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -152,6 +155,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -232,6 +236,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DowntimesApi->create_downtime: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -251,6 +256,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -306,6 +312,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DowntimesApi->get_downtime: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -325,6 +332,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -381,6 +389,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DowntimesApi->list_downtimes: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -400,6 +409,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -479,6 +489,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DowntimesApi->update_downtime: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -499,6 +510,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/Event.md b/docs/v1/Event.md index 917985700b..a227f0df7c 100644 --- a/docs/v1/Event.md +++ b/docs/v1/Event.md @@ -1,6 +1,7 @@ # Event Object representing an event. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventAlertType.md b/docs/v1/EventAlertType.md index 83b2727212..2d72a8876d 100644 --- a/docs/v1/EventAlertType.md +++ b/docs/v1/EventAlertType.md @@ -1,6 +1,7 @@ # EventAlertType If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, `recommendation`, and `snapshot`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventListResponse.md b/docs/v1/EventListResponse.md index c2017802d4..dd8d3ae868 100644 --- a/docs/v1/EventListResponse.md +++ b/docs/v1/EventListResponse.md @@ -1,6 +1,7 @@ # EventListResponse An event list response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventPriority.md b/docs/v1/EventPriority.md index b682976171..1950c320e1 100644 --- a/docs/v1/EventPriority.md +++ b/docs/v1/EventPriority.md @@ -1,6 +1,7 @@ # EventPriority The priority of the event. For example, `normal` or `low`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventQueryDefinition.md b/docs/v1/EventQueryDefinition.md index c02002514b..91f8f0d953 100644 --- a/docs/v1/EventQueryDefinition.md +++ b/docs/v1/EventQueryDefinition.md @@ -1,6 +1,7 @@ # EventQueryDefinition The event query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventResponse.md b/docs/v1/EventResponse.md index 9e49c3090e..63e618d335 100644 --- a/docs/v1/EventResponse.md +++ b/docs/v1/EventResponse.md @@ -1,6 +1,7 @@ # EventResponse Object containing an event response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventStreamWidgetDefinition.md b/docs/v1/EventStreamWidgetDefinition.md index f648cba2a5..bf8a4268ab 100644 --- a/docs/v1/EventStreamWidgetDefinition.md +++ b/docs/v1/EventStreamWidgetDefinition.md @@ -1,6 +1,7 @@ # EventStreamWidgetDefinition The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventStreamWidgetDefinitionType.md b/docs/v1/EventStreamWidgetDefinitionType.md index c74a291621..9756c633d0 100644 --- a/docs/v1/EventStreamWidgetDefinitionType.md +++ b/docs/v1/EventStreamWidgetDefinitionType.md @@ -1,6 +1,7 @@ # EventStreamWidgetDefinitionType Type of the event stream widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventTimelineWidgetDefinition.md b/docs/v1/EventTimelineWidgetDefinition.md index a6ee22e950..7f2670c8fc 100644 --- a/docs/v1/EventTimelineWidgetDefinition.md +++ b/docs/v1/EventTimelineWidgetDefinition.md @@ -1,6 +1,7 @@ # EventTimelineWidgetDefinition The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventTimelineWidgetDefinitionType.md b/docs/v1/EventTimelineWidgetDefinitionType.md index b99df57730..a9e8b8848d 100644 --- a/docs/v1/EventTimelineWidgetDefinitionType.md +++ b/docs/v1/EventTimelineWidgetDefinitionType.md @@ -1,6 +1,7 @@ # EventTimelineWidgetDefinitionType Type of the event timeline widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/EventsApi.md b/docs/v1/EventsApi.md index 994965a2ac..a0af126254 100644 --- a/docs/v1/EventsApi.md +++ b/docs/v1/EventsApi.md @@ -54,6 +54,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling EventsApi->get_event: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -73,6 +74,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -142,6 +144,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling EventsApi->list_events: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -166,6 +169,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/FormulaAndFunctionEventAggregation.md b/docs/v1/FormulaAndFunctionEventAggregation.md index c336a6274e..9e47946ee8 100644 --- a/docs/v1/FormulaAndFunctionEventAggregation.md +++ b/docs/v1/FormulaAndFunctionEventAggregation.md @@ -1,6 +1,7 @@ # FormulaAndFunctionEventAggregation Aggregation methods for event platform queries. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionEventQueryDefinition.md b/docs/v1/FormulaAndFunctionEventQueryDefinition.md index eff502bc4e..ee0ce7a5d1 100644 --- a/docs/v1/FormulaAndFunctionEventQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionEventQueryDefinition.md @@ -1,6 +1,7 @@ # FormulaAndFunctionEventQueryDefinition A formula and functions events query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md b/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md index 1717dc225a..96a6bfd586 100644 --- a/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md +++ b/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md @@ -1,6 +1,7 @@ # FormulaAndFunctionEventQueryDefinitionCompute Compute options. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md b/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md index 643e409715..f47245ac54 100644 --- a/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md +++ b/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md @@ -1,6 +1,7 @@ # FormulaAndFunctionEventQueryDefinitionSearch Search options. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionEventQueryGroupBy.md b/docs/v1/FormulaAndFunctionEventQueryGroupBy.md index 861e5a04cd..4b9e0d8c61 100644 --- a/docs/v1/FormulaAndFunctionEventQueryGroupBy.md +++ b/docs/v1/FormulaAndFunctionEventQueryGroupBy.md @@ -1,6 +1,7 @@ # FormulaAndFunctionEventQueryGroupBy List of objects used to group by. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md b/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md index e2e171e9e8..8a5024d63c 100644 --- a/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md +++ b/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md @@ -1,6 +1,7 @@ # FormulaAndFunctionEventQueryGroupBySort Options for sorting group by results. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionEventsDataSource.md b/docs/v1/FormulaAndFunctionEventsDataSource.md index 38d097b448..31d61e198b 100644 --- a/docs/v1/FormulaAndFunctionEventsDataSource.md +++ b/docs/v1/FormulaAndFunctionEventsDataSource.md @@ -1,6 +1,7 @@ # FormulaAndFunctionEventsDataSource Data source for event platform-based queries. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionMetricAggregation.md b/docs/v1/FormulaAndFunctionMetricAggregation.md index 2cb84d33f4..0029cdf5ce 100644 --- a/docs/v1/FormulaAndFunctionMetricAggregation.md +++ b/docs/v1/FormulaAndFunctionMetricAggregation.md @@ -1,6 +1,7 @@ # FormulaAndFunctionMetricAggregation The aggregation methods available for metrics queries. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionMetricDataSource.md b/docs/v1/FormulaAndFunctionMetricDataSource.md index 6010eea37e..684dae2c66 100644 --- a/docs/v1/FormulaAndFunctionMetricDataSource.md +++ b/docs/v1/FormulaAndFunctionMetricDataSource.md @@ -1,6 +1,7 @@ # FormulaAndFunctionMetricDataSource Data source for metrics queries. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionMetricQueryDefinition.md b/docs/v1/FormulaAndFunctionMetricQueryDefinition.md index 469cc7b909..b085c376b0 100644 --- a/docs/v1/FormulaAndFunctionMetricQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionMetricQueryDefinition.md @@ -1,6 +1,7 @@ # FormulaAndFunctionMetricQueryDefinition A formula and functions metrics query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionProcessQueryDataSource.md b/docs/v1/FormulaAndFunctionProcessQueryDataSource.md index 3bd01be740..087261185f 100644 --- a/docs/v1/FormulaAndFunctionProcessQueryDataSource.md +++ b/docs/v1/FormulaAndFunctionProcessQueryDataSource.md @@ -1,6 +1,7 @@ # FormulaAndFunctionProcessQueryDataSource Data sources that rely on the process backend. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionProcessQueryDefinition.md b/docs/v1/FormulaAndFunctionProcessQueryDefinition.md index 83355976ad..808bb6a3d4 100644 --- a/docs/v1/FormulaAndFunctionProcessQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionProcessQueryDefinition.md @@ -1,6 +1,7 @@ # FormulaAndFunctionProcessQueryDefinition Process query using formulas and functions. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionQueryDefinition.md b/docs/v1/FormulaAndFunctionQueryDefinition.md index 3c5d431a59..9b99a53698 100644 --- a/docs/v1/FormulaAndFunctionQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionQueryDefinition.md @@ -1,6 +1,7 @@ # FormulaAndFunctionQueryDefinition A formula and function query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FormulaAndFunctionResponseFormat.md b/docs/v1/FormulaAndFunctionResponseFormat.md index a0ec233003..292dab0ee2 100644 --- a/docs/v1/FormulaAndFunctionResponseFormat.md +++ b/docs/v1/FormulaAndFunctionResponseFormat.md @@ -1,6 +1,7 @@ # FormulaAndFunctionResponseFormat Timeseries or Scalar response. **This feature is currently in beta.** + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FreeTextWidgetDefinition.md b/docs/v1/FreeTextWidgetDefinition.md index 3a2c5dad13..52192451a2 100644 --- a/docs/v1/FreeTextWidgetDefinition.md +++ b/docs/v1/FreeTextWidgetDefinition.md @@ -1,6 +1,7 @@ # FreeTextWidgetDefinition Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/FreeTextWidgetDefinitionType.md b/docs/v1/FreeTextWidgetDefinitionType.md index 4657465c55..7616b4cb5e 100644 --- a/docs/v1/FreeTextWidgetDefinitionType.md +++ b/docs/v1/FreeTextWidgetDefinitionType.md @@ -1,6 +1,7 @@ # FreeTextWidgetDefinitionType Type of the free text widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GCPAccount.md b/docs/v1/GCPAccount.md index d068203c75..410e205cea 100644 --- a/docs/v1/GCPAccount.md +++ b/docs/v1/GCPAccount.md @@ -1,6 +1,7 @@ # GCPAccount Your Google Cloud Platform Account. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GCPAccountListResponse.md b/docs/v1/GCPAccountListResponse.md index c0c0ca2bc9..ba5cf8609b 100644 --- a/docs/v1/GCPAccountListResponse.md +++ b/docs/v1/GCPAccountListResponse.md @@ -1,6 +1,7 @@ # GCPAccountListResponse Array of GCP account responses. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GCPIntegrationApi.md b/docs/v1/GCPIntegrationApi.md index 84936ea900..c392bc66fa 100644 --- a/docs/v1/GCPIntegrationApi.md +++ b/docs/v1/GCPIntegrationApi.md @@ -70,6 +70,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling GCPIntegrationApi->create_gcp_integration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -89,6 +90,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -158,6 +160,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling GCPIntegrationApi->delete_gcp_integration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -177,6 +180,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -231,6 +235,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling GCPIntegrationApi->list_gcp_integration: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -247,6 +252,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -316,6 +322,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling GCPIntegrationApi->update_gcp_integration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -335,6 +342,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/GeomapWidgetDefinition.md b/docs/v1/GeomapWidgetDefinition.md index f7f5419c70..2f4317c13b 100644 --- a/docs/v1/GeomapWidgetDefinition.md +++ b/docs/v1/GeomapWidgetDefinition.md @@ -1,6 +1,7 @@ # GeomapWidgetDefinition This visualization displays a series of values by country on a world map. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GeomapWidgetDefinitionStyle.md b/docs/v1/GeomapWidgetDefinitionStyle.md index d8ff7a6ee0..a42323429f 100644 --- a/docs/v1/GeomapWidgetDefinitionStyle.md +++ b/docs/v1/GeomapWidgetDefinitionStyle.md @@ -1,6 +1,7 @@ # GeomapWidgetDefinitionStyle The style to apply to the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GeomapWidgetDefinitionType.md b/docs/v1/GeomapWidgetDefinitionType.md index 09b725093f..f34057ca49 100644 --- a/docs/v1/GeomapWidgetDefinitionType.md +++ b/docs/v1/GeomapWidgetDefinitionType.md @@ -1,6 +1,7 @@ # GeomapWidgetDefinitionType Type of the geomap widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GeomapWidgetDefinitionView.md b/docs/v1/GeomapWidgetDefinitionView.md index 0afe5f608a..bc81e73fd9 100644 --- a/docs/v1/GeomapWidgetDefinitionView.md +++ b/docs/v1/GeomapWidgetDefinitionView.md @@ -1,6 +1,7 @@ # GeomapWidgetDefinitionView The view of the world that the map should render. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GeomapWidgetRequest.md b/docs/v1/GeomapWidgetRequest.md index e9dbf79937..b2a51c6341 100644 --- a/docs/v1/GeomapWidgetRequest.md +++ b/docs/v1/GeomapWidgetRequest.md @@ -1,6 +1,7 @@ # GeomapWidgetRequest An updated geomap widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GraphSnapshot.md b/docs/v1/GraphSnapshot.md index d9802ead48..f4ad77ec0d 100644 --- a/docs/v1/GraphSnapshot.md +++ b/docs/v1/GraphSnapshot.md @@ -1,6 +1,7 @@ # GraphSnapshot Object representing a graph snapshot. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GroupWidgetDefinition.md b/docs/v1/GroupWidgetDefinition.md index 92773ff7e3..863d360d5d 100644 --- a/docs/v1/GroupWidgetDefinition.md +++ b/docs/v1/GroupWidgetDefinition.md @@ -1,6 +1,7 @@ # GroupWidgetDefinition The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/GroupWidgetDefinitionType.md b/docs/v1/GroupWidgetDefinitionType.md index 63066ca267..57ce99f154 100644 --- a/docs/v1/GroupWidgetDefinitionType.md +++ b/docs/v1/GroupWidgetDefinitionType.md @@ -1,6 +1,7 @@ # GroupWidgetDefinitionType Type of the group widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HTTPMethod.md b/docs/v1/HTTPMethod.md index 4388cd21a8..47394c9d25 100644 --- a/docs/v1/HTTPMethod.md +++ b/docs/v1/HTTPMethod.md @@ -1,6 +1,7 @@ # HTTPMethod The HTTP method. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HeatMapWidgetDefinition.md b/docs/v1/HeatMapWidgetDefinition.md index 88bc140c1d..d15ee914c9 100644 --- a/docs/v1/HeatMapWidgetDefinition.md +++ b/docs/v1/HeatMapWidgetDefinition.md @@ -1,6 +1,7 @@ # HeatMapWidgetDefinition The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HeatMapWidgetDefinitionType.md b/docs/v1/HeatMapWidgetDefinitionType.md index c90fae6458..d31b0f2039 100644 --- a/docs/v1/HeatMapWidgetDefinitionType.md +++ b/docs/v1/HeatMapWidgetDefinitionType.md @@ -1,6 +1,7 @@ # HeatMapWidgetDefinitionType Type of the heat map widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HeatMapWidgetRequest.md b/docs/v1/HeatMapWidgetRequest.md index a491018b97..c2c8f2950c 100644 --- a/docs/v1/HeatMapWidgetRequest.md +++ b/docs/v1/HeatMapWidgetRequest.md @@ -1,6 +1,7 @@ # HeatMapWidgetRequest Updated heat map widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/Host.md b/docs/v1/Host.md index 299d0d00ca..1bbf85fad8 100644 --- a/docs/v1/Host.md +++ b/docs/v1/Host.md @@ -1,6 +1,7 @@ # Host Object representing a host. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostListResponse.md b/docs/v1/HostListResponse.md index b393468702..614c9abd44 100644 --- a/docs/v1/HostListResponse.md +++ b/docs/v1/HostListResponse.md @@ -1,6 +1,7 @@ # HostListResponse Response with Host information from Datadog. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMapRequest.md b/docs/v1/HostMapRequest.md index 6661d53e3c..61ace7d389 100644 --- a/docs/v1/HostMapRequest.md +++ b/docs/v1/HostMapRequest.md @@ -1,6 +1,7 @@ # HostMapRequest Updated host map. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMapWidgetDefinition.md b/docs/v1/HostMapWidgetDefinition.md index ea4903228f..8fc53c86b6 100644 --- a/docs/v1/HostMapWidgetDefinition.md +++ b/docs/v1/HostMapWidgetDefinition.md @@ -1,6 +1,7 @@ # HostMapWidgetDefinition The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMapWidgetDefinitionRequests.md b/docs/v1/HostMapWidgetDefinitionRequests.md index 1ab757dbf6..64fb3e44c3 100644 --- a/docs/v1/HostMapWidgetDefinitionRequests.md +++ b/docs/v1/HostMapWidgetDefinitionRequests.md @@ -1,6 +1,7 @@ # HostMapWidgetDefinitionRequests List of definitions. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMapWidgetDefinitionStyle.md b/docs/v1/HostMapWidgetDefinitionStyle.md index c48d2178a6..5955a503dc 100644 --- a/docs/v1/HostMapWidgetDefinitionStyle.md +++ b/docs/v1/HostMapWidgetDefinitionStyle.md @@ -1,6 +1,7 @@ # HostMapWidgetDefinitionStyle The style to apply to the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMapWidgetDefinitionType.md b/docs/v1/HostMapWidgetDefinitionType.md index d22f0b8c67..135db7f6bf 100644 --- a/docs/v1/HostMapWidgetDefinitionType.md +++ b/docs/v1/HostMapWidgetDefinitionType.md @@ -1,6 +1,7 @@ # HostMapWidgetDefinitionType Type of the host map widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMeta.md b/docs/v1/HostMeta.md index ece5c20060..ee7e36837d 100644 --- a/docs/v1/HostMeta.md +++ b/docs/v1/HostMeta.md @@ -1,6 +1,7 @@ # HostMeta Metadata associated with your host. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMetrics.md b/docs/v1/HostMetrics.md index 3a4879df8e..7b95b9e3cc 100644 --- a/docs/v1/HostMetrics.md +++ b/docs/v1/HostMetrics.md @@ -1,6 +1,7 @@ # HostMetrics Host Metrics collected. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMuteResponse.md b/docs/v1/HostMuteResponse.md index e9c91edc9c..511ad369bd 100644 --- a/docs/v1/HostMuteResponse.md +++ b/docs/v1/HostMuteResponse.md @@ -1,6 +1,7 @@ # HostMuteResponse Response with the list of muted host for your organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostMuteSettings.md b/docs/v1/HostMuteSettings.md index 63dbe9521d..cd9993f845 100644 --- a/docs/v1/HostMuteSettings.md +++ b/docs/v1/HostMuteSettings.md @@ -1,6 +1,7 @@ # HostMuteSettings Combination of settings to mute a host. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostTags.md b/docs/v1/HostTags.md index c1cc5cdf0f..6dc4c15ce7 100644 --- a/docs/v1/HostTags.md +++ b/docs/v1/HostTags.md @@ -1,6 +1,7 @@ # HostTags Set of tags to associate with your host. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostTotals.md b/docs/v1/HostTotals.md index 24f7a947c9..a290bdbd66 100644 --- a/docs/v1/HostTotals.md +++ b/docs/v1/HostTotals.md @@ -1,6 +1,7 @@ # HostTotals Total number of host currently monitored by Datadog. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/HostsApi.md b/docs/v1/HostsApi.md index ca20058d1c..897235d7c3 100644 --- a/docs/v1/HostsApi.md +++ b/docs/v1/HostsApi.md @@ -57,6 +57,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling HostsApi->get_host_totals: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -76,6 +77,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -139,6 +141,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling HostsApi->list_hosts: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -165,6 +168,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -225,6 +229,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling HostsApi->mute_host: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -245,6 +250,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -300,6 +306,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling HostsApi->unmute_host: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -319,6 +326,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/IFrameWidgetDefinition.md b/docs/v1/IFrameWidgetDefinition.md index 8749be098d..70a0e3999c 100644 --- a/docs/v1/IFrameWidgetDefinition.md +++ b/docs/v1/IFrameWidgetDefinition.md @@ -1,6 +1,7 @@ # IFrameWidgetDefinition The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IFrameWidgetDefinitionType.md b/docs/v1/IFrameWidgetDefinitionType.md index 43841f855d..571c762ce8 100644 --- a/docs/v1/IFrameWidgetDefinitionType.md +++ b/docs/v1/IFrameWidgetDefinitionType.md @@ -1,6 +1,7 @@ # IFrameWidgetDefinitionType Type of the iframe widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPPrefixesAPI.md b/docs/v1/IPPrefixesAPI.md index 9dc974fa2c..0286edec29 100644 --- a/docs/v1/IPPrefixesAPI.md +++ b/docs/v1/IPPrefixesAPI.md @@ -1,6 +1,7 @@ # IPPrefixesAPI Available prefix information for the API endpoints. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPPrefixesAPM.md b/docs/v1/IPPrefixesAPM.md index 2ade44c808..34784596fe 100644 --- a/docs/v1/IPPrefixesAPM.md +++ b/docs/v1/IPPrefixesAPM.md @@ -1,6 +1,7 @@ # IPPrefixesAPM Available prefix information for the APM endpoints. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPPrefixesAgents.md b/docs/v1/IPPrefixesAgents.md index 93349e1268..ccbe8a2c4b 100644 --- a/docs/v1/IPPrefixesAgents.md +++ b/docs/v1/IPPrefixesAgents.md @@ -1,6 +1,7 @@ # IPPrefixesAgents Available prefix information for the Agent endpoints. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPPrefixesLogs.md b/docs/v1/IPPrefixesLogs.md index 2ab035cc31..6f19c409fd 100644 --- a/docs/v1/IPPrefixesLogs.md +++ b/docs/v1/IPPrefixesLogs.md @@ -1,6 +1,7 @@ # IPPrefixesLogs Available prefix information for the Logs endpoints. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPPrefixesProcess.md b/docs/v1/IPPrefixesProcess.md index 2df463e66b..4e489f0520 100644 --- a/docs/v1/IPPrefixesProcess.md +++ b/docs/v1/IPPrefixesProcess.md @@ -1,6 +1,7 @@ # IPPrefixesProcess Available prefix information for the Process endpoints. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPPrefixesSynthetics.md b/docs/v1/IPPrefixesSynthetics.md index ff36a2e86e..3d0b88710d 100644 --- a/docs/v1/IPPrefixesSynthetics.md +++ b/docs/v1/IPPrefixesSynthetics.md @@ -1,6 +1,7 @@ # IPPrefixesSynthetics Available prefix information for the Synthetics endpoints. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPPrefixesWebhooks.md b/docs/v1/IPPrefixesWebhooks.md index db4fc024d9..7e44db40bf 100644 --- a/docs/v1/IPPrefixesWebhooks.md +++ b/docs/v1/IPPrefixesWebhooks.md @@ -1,6 +1,7 @@ # IPPrefixesWebhooks Available prefix information for the Webhook endpoints. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPRanges.md b/docs/v1/IPRanges.md index 456928c511..defbbc14e8 100644 --- a/docs/v1/IPRanges.md +++ b/docs/v1/IPRanges.md @@ -1,6 +1,7 @@ # IPRanges IP ranges. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IPRangesApi.md b/docs/v1/IPRangesApi.md index 15879abdd1..0f7655b6f0 100644 --- a/docs/v1/IPRangesApi.md +++ b/docs/v1/IPRangesApi.md @@ -44,6 +44,7 @@ with ApiClient() as api_client: print("Exception when calling IPRangesApi->get_ip_ranges: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -60,6 +61,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/IdpFormData.md b/docs/v1/IdpFormData.md index 648d9d3f82..95307a11b5 100644 --- a/docs/v1/IdpFormData.md +++ b/docs/v1/IdpFormData.md @@ -1,6 +1,7 @@ # IdpFormData Object describing the IdP configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/IdpResponse.md b/docs/v1/IdpResponse.md index 929324afa1..c345673a23 100644 --- a/docs/v1/IdpResponse.md +++ b/docs/v1/IdpResponse.md @@ -1,6 +1,7 @@ # IdpResponse The IdP response object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ImageWidgetDefinition.md b/docs/v1/ImageWidgetDefinition.md index f5e3baca3a..65976f4f7a 100644 --- a/docs/v1/ImageWidgetDefinition.md +++ b/docs/v1/ImageWidgetDefinition.md @@ -1,6 +1,7 @@ # ImageWidgetDefinition The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ImageWidgetDefinitionType.md b/docs/v1/ImageWidgetDefinitionType.md index 0c8f44ee7d..ed1fbb6093 100644 --- a/docs/v1/ImageWidgetDefinitionType.md +++ b/docs/v1/ImageWidgetDefinitionType.md @@ -1,6 +1,7 @@ # ImageWidgetDefinitionType Type of the image widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/KeyManagementApi.md b/docs/v1/KeyManagementApi.md index 7fe0268306..6a8ff0798b 100644 --- a/docs/v1/KeyManagementApi.md +++ b/docs/v1/KeyManagementApi.md @@ -67,6 +67,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->create_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -86,6 +87,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -145,6 +147,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->create_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -164,6 +167,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -220,6 +224,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->delete_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -239,6 +244,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -295,6 +301,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->delete_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -314,6 +321,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -369,6 +377,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->get_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -388,6 +397,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -443,6 +453,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->get_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -462,6 +473,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -516,6 +528,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->list_api_keys: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -532,6 +545,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -585,6 +599,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->list_application_keys: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -601,6 +616,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -661,6 +677,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->update_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -681,6 +698,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -742,6 +760,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->update_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -762,6 +781,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/Log.md b/docs/v1/Log.md index a3ee1523f3..a045f03d7f 100644 --- a/docs/v1/Log.md +++ b/docs/v1/Log.md @@ -1,6 +1,7 @@ # Log Object describing a log after being processed and stored by Datadog. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogContent.md b/docs/v1/LogContent.md index 36857041ff..c35b736d44 100644 --- a/docs/v1/LogContent.md +++ b/docs/v1/LogContent.md @@ -1,6 +1,7 @@ # LogContent JSON object containing all log attributes and their associated values. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogQueryDefinition.md b/docs/v1/LogQueryDefinition.md index 80277820fa..c044e17d0a 100644 --- a/docs/v1/LogQueryDefinition.md +++ b/docs/v1/LogQueryDefinition.md @@ -1,6 +1,7 @@ # LogQueryDefinition The log query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogQueryDefinitionGroupBy.md b/docs/v1/LogQueryDefinitionGroupBy.md index 41d7991b92..02775bd810 100644 --- a/docs/v1/LogQueryDefinitionGroupBy.md +++ b/docs/v1/LogQueryDefinitionGroupBy.md @@ -1,6 +1,7 @@ # LogQueryDefinitionGroupBy Defined items in the group. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogQueryDefinitionGroupBySort.md b/docs/v1/LogQueryDefinitionGroupBySort.md index 3565b1112a..b75a27a7b7 100644 --- a/docs/v1/LogQueryDefinitionGroupBySort.md +++ b/docs/v1/LogQueryDefinitionGroupBySort.md @@ -1,6 +1,7 @@ # LogQueryDefinitionGroupBySort Define a sorting method. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogQueryDefinitionSearch.md b/docs/v1/LogQueryDefinitionSearch.md index 3f36abd8f2..7cd6db3a17 100644 --- a/docs/v1/LogQueryDefinitionSearch.md +++ b/docs/v1/LogQueryDefinitionSearch.md @@ -1,6 +1,7 @@ # LogQueryDefinitionSearch The query being made on the logs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogStreamWidgetDefinition.md b/docs/v1/LogStreamWidgetDefinition.md index 7db6b917ca..7f54310ff3 100644 --- a/docs/v1/LogStreamWidgetDefinition.md +++ b/docs/v1/LogStreamWidgetDefinition.md @@ -1,6 +1,7 @@ # LogStreamWidgetDefinition The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogStreamWidgetDefinitionType.md b/docs/v1/LogStreamWidgetDefinitionType.md index de515f62c6..5df4c4f49a 100644 --- a/docs/v1/LogStreamWidgetDefinitionType.md +++ b/docs/v1/LogStreamWidgetDefinitionType.md @@ -1,6 +1,7 @@ # LogStreamWidgetDefinitionType Type of the log stream widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsAPIError.md b/docs/v1/LogsAPIError.md index 8626f5146e..5bce92653d 100644 --- a/docs/v1/LogsAPIError.md +++ b/docs/v1/LogsAPIError.md @@ -1,6 +1,7 @@ # LogsAPIError Error returned by the Logs API + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsAPIErrorResponse.md b/docs/v1/LogsAPIErrorResponse.md index 68d2a62d05..bd312a82de 100644 --- a/docs/v1/LogsAPIErrorResponse.md +++ b/docs/v1/LogsAPIErrorResponse.md @@ -1,6 +1,7 @@ # LogsAPIErrorResponse Response returned by the Logs API when errors occur. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsApi.md b/docs/v1/LogsApi.md index a57441c50e..ba7c721a6a 100644 --- a/docs/v1/LogsApi.md +++ b/docs/v1/LogsApi.md @@ -64,6 +64,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsApi->list_logs: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -83,6 +84,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/LogsArithmeticProcessor.md b/docs/v1/LogsArithmeticProcessor.md index 4b9fa90825..2f393fc52e 100644 --- a/docs/v1/LogsArithmeticProcessor.md +++ b/docs/v1/LogsArithmeticProcessor.md @@ -1,6 +1,7 @@ # LogsArithmeticProcessor Use the Arithmetic Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This enables you to remap different time attributes with different units into a single attribute, or to compute operations on attributes within the same log. The formula can use parentheses and the basic arithmetic operators `-`, `+`, `*`, `/`. By default, the calculation is skipped if an attribute is missing. Select “Replace missing attribute by 0” to automatically populate missing attribute values with 0 to ensure that the calculation is done. An attribute is missing if it is not found in the log attributes, or if it cannot be converted to a number. *Notes*: - The operator `-` needs to be space split in the formula as it can also be contained in attribute names. - If the target attribute already exists, it is overwritten by the result of the formula. - Results are rounded up to the 9th decimal. For example, if the result of the formula is `0.1234567891`, the actual value stored for the attribute is `0.123456789`. - If you need to scale a unit of measure, see [Scale Filter](https://docs.datadoghq.com/logs/processing/parsing/?tab=filter#matcher-and-filter). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsArithmeticProcessorType.md b/docs/v1/LogsArithmeticProcessorType.md index 948b78de8f..0272f7aaf0 100644 --- a/docs/v1/LogsArithmeticProcessorType.md +++ b/docs/v1/LogsArithmeticProcessorType.md @@ -1,6 +1,7 @@ # LogsArithmeticProcessorType Type of logs arithmetic processor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsAttributeRemapper.md b/docs/v1/LogsAttributeRemapper.md index a08fa29dd8..e709485d1e 100644 --- a/docs/v1/LogsAttributeRemapper.md +++ b/docs/v1/LogsAttributeRemapper.md @@ -1,6 +1,7 @@ # LogsAttributeRemapper The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the [Tag Best Practice documentation](https://docs.datadoghq.com/logs/guide/log-parsing-best-practice). Some additional constraints are applied as `:` or `,` are not allowed in the target tag/attribute name. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsAttributeRemapperType.md b/docs/v1/LogsAttributeRemapperType.md index 335ccf0a4b..31188d944d 100644 --- a/docs/v1/LogsAttributeRemapperType.md +++ b/docs/v1/LogsAttributeRemapperType.md @@ -1,6 +1,7 @@ # LogsAttributeRemapperType Type of logs attribute remapper. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsCategoryProcessor.md b/docs/v1/LogsCategoryProcessor.md index 9417dd0f12..ebbc316018 100644 --- a/docs/v1/LogsCategoryProcessor.md +++ b/docs/v1/LogsCategoryProcessor.md @@ -1,6 +1,7 @@ # LogsCategoryProcessor Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. **Notes**: - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsCategoryProcessorCategory.md b/docs/v1/LogsCategoryProcessorCategory.md index 38779573c6..c4a32da83c 100644 --- a/docs/v1/LogsCategoryProcessorCategory.md +++ b/docs/v1/LogsCategoryProcessorCategory.md @@ -1,6 +1,7 @@ # LogsCategoryProcessorCategory Object describing the logs filter. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsCategoryProcessorType.md b/docs/v1/LogsCategoryProcessorType.md index 75f90a653f..37cf5d4ad3 100644 --- a/docs/v1/LogsCategoryProcessorType.md +++ b/docs/v1/LogsCategoryProcessorType.md @@ -1,6 +1,7 @@ # LogsCategoryProcessorType Type of logs category processor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsDateRemapper.md b/docs/v1/LogsDateRemapper.md index f2fbcc2fe3..1da2f743e0 100644 --- a/docs/v1/LogsDateRemapper.md +++ b/docs/v1/LogsDateRemapper.md @@ -1,6 +1,7 @@ # LogsDateRemapper As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - `timestamp` - `date` - `_timestamp` - `Timestamp` - `eventTime` - `published_date` If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. **Note:** If your logs don’t contain any of the default attributes and you haven’t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsDateRemapperType.md b/docs/v1/LogsDateRemapperType.md index 6cd11d04db..dd6126ec9d 100644 --- a/docs/v1/LogsDateRemapperType.md +++ b/docs/v1/LogsDateRemapperType.md @@ -1,6 +1,7 @@ # LogsDateRemapperType Type of logs date remapper. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsExclusion.md b/docs/v1/LogsExclusion.md index 1141338eb3..8927f3b0ca 100644 --- a/docs/v1/LogsExclusion.md +++ b/docs/v1/LogsExclusion.md @@ -1,6 +1,7 @@ # LogsExclusion Represents the index exclusion filter object from configuration API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsExclusionFilter.md b/docs/v1/LogsExclusionFilter.md index bce3043cb6..0cc2a54093 100644 --- a/docs/v1/LogsExclusionFilter.md +++ b/docs/v1/LogsExclusionFilter.md @@ -1,6 +1,7 @@ # LogsExclusionFilter Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsFilter.md b/docs/v1/LogsFilter.md index a57ade26c7..564d489761 100644 --- a/docs/v1/LogsFilter.md +++ b/docs/v1/LogsFilter.md @@ -1,6 +1,7 @@ # LogsFilter Filter for logs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsGeoIPParser.md b/docs/v1/LogsGeoIPParser.md index ca4482def5..5b2737bce2 100644 --- a/docs/v1/LogsGeoIPParser.md +++ b/docs/v1/LogsGeoIPParser.md @@ -1,6 +1,7 @@ # LogsGeoIPParser The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsGeoIPParserType.md b/docs/v1/LogsGeoIPParserType.md index 5521bd7c0b..5f9bd42711 100644 --- a/docs/v1/LogsGeoIPParserType.md +++ b/docs/v1/LogsGeoIPParserType.md @@ -1,6 +1,7 @@ # LogsGeoIPParserType Type of GeoIP parser. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsGrokParser.md b/docs/v1/LogsGrokParser.md index 4df8fc48d2..fd4f567e52 100644 --- a/docs/v1/LogsGrokParser.md +++ b/docs/v1/LogsGrokParser.md @@ -1,6 +1,7 @@ # LogsGrokParser Create custom grok rules to parse the full message or [a specific attribute of your raw event](https://docs.datadoghq.com/logs/processing/parsing/#advanced-settings). For more information, see the [parsing section](https://docs.datadoghq.com/logs/processing/parsing). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsGrokParserRules.md b/docs/v1/LogsGrokParserRules.md index 6003438da8..fc8f2085c2 100644 --- a/docs/v1/LogsGrokParserRules.md +++ b/docs/v1/LogsGrokParserRules.md @@ -1,6 +1,7 @@ # LogsGrokParserRules Set of rules for the grok parser. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsGrokParserType.md b/docs/v1/LogsGrokParserType.md index a5f6f606c1..0d262b58fc 100644 --- a/docs/v1/LogsGrokParserType.md +++ b/docs/v1/LogsGrokParserType.md @@ -1,6 +1,7 @@ # LogsGrokParserType Type of logs grok parser. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsIndex.md b/docs/v1/LogsIndex.md index fdccffddd9..4653746fe7 100644 --- a/docs/v1/LogsIndex.md +++ b/docs/v1/LogsIndex.md @@ -1,6 +1,7 @@ # LogsIndex Object describing a Datadog Log index. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsIndexListResponse.md b/docs/v1/LogsIndexListResponse.md index fa489fea97..b0ba7e0684 100644 --- a/docs/v1/LogsIndexListResponse.md +++ b/docs/v1/LogsIndexListResponse.md @@ -1,6 +1,7 @@ # LogsIndexListResponse Object with all Index configurations for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsIndexUpdateRequest.md b/docs/v1/LogsIndexUpdateRequest.md index 8ad008a888..cb95eab898 100644 --- a/docs/v1/LogsIndexUpdateRequest.md +++ b/docs/v1/LogsIndexUpdateRequest.md @@ -1,6 +1,7 @@ # LogsIndexUpdateRequest Object for updating a Datadog Log index. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsIndexesApi.md b/docs/v1/LogsIndexesApi.md index 63cb3b80f2..cafc96d4a7 100644 --- a/docs/v1/LogsIndexesApi.md +++ b/docs/v1/LogsIndexesApi.md @@ -76,6 +76,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsIndexesApi->create_logs_index: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -95,6 +96,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -150,6 +152,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsIndexesApi->get_logs_index: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -169,6 +172,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -223,6 +227,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsIndexesApi->get_logs_index_order: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -239,6 +244,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -292,6 +298,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsIndexesApi->list_log_indexes: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -308,6 +315,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -380,6 +388,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsIndexesApi->update_logs_index: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -400,6 +409,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -458,6 +468,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsIndexesApi->update_logs_index_order: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -477,6 +488,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/LogsIndexesOrder.md b/docs/v1/LogsIndexesOrder.md index 445871531c..f4e724f8b7 100644 --- a/docs/v1/LogsIndexesOrder.md +++ b/docs/v1/LogsIndexesOrder.md @@ -1,6 +1,7 @@ # LogsIndexesOrder Object containing the ordered list of log index names. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsListRequest.md b/docs/v1/LogsListRequest.md index 4d327069f1..0630ea027e 100644 --- a/docs/v1/LogsListRequest.md +++ b/docs/v1/LogsListRequest.md @@ -1,6 +1,7 @@ # LogsListRequest Object to send with the request to retrieve a list of logs from your Organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsListRequestTime.md b/docs/v1/LogsListRequestTime.md index 1795ecca48..fd81d5ed8e 100644 --- a/docs/v1/LogsListRequestTime.md +++ b/docs/v1/LogsListRequestTime.md @@ -1,6 +1,7 @@ # LogsListRequestTime Timeframe to retrieve the log from. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsListResponse.md b/docs/v1/LogsListResponse.md index 0b90e7e23a..862faafe0d 100644 --- a/docs/v1/LogsListResponse.md +++ b/docs/v1/LogsListResponse.md @@ -1,6 +1,7 @@ # LogsListResponse Response object with all logs matching the request and pagination information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsLookupProcessor.md b/docs/v1/LogsLookupProcessor.md index 9b24b2eea3..5e0db69870 100644 --- a/docs/v1/LogsLookupProcessor.md +++ b/docs/v1/LogsLookupProcessor.md @@ -1,6 +1,7 @@ # LogsLookupProcessor Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsLookupProcessorType.md b/docs/v1/LogsLookupProcessorType.md index c5f5602ad9..66b4784659 100644 --- a/docs/v1/LogsLookupProcessorType.md +++ b/docs/v1/LogsLookupProcessorType.md @@ -1,6 +1,7 @@ # LogsLookupProcessorType Type of logs lookup processor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsMessageRemapper.md b/docs/v1/LogsMessageRemapper.md index 3990b12f06..4c2f83fd02 100644 --- a/docs/v1/LogsMessageRemapper.md +++ b/docs/v1/LogsMessageRemapper.md @@ -1,6 +1,7 @@ # LogsMessageRemapper The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. **Note:** If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsMessageRemapperType.md b/docs/v1/LogsMessageRemapperType.md index 1a49d85622..13d5db22a3 100644 --- a/docs/v1/LogsMessageRemapperType.md +++ b/docs/v1/LogsMessageRemapperType.md @@ -1,6 +1,7 @@ # LogsMessageRemapperType Type of logs message remapper. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsPipeline.md b/docs/v1/LogsPipeline.md index b3b77e2e99..0533414924 100644 --- a/docs/v1/LogsPipeline.md +++ b/docs/v1/LogsPipeline.md @@ -1,6 +1,7 @@ # LogsPipeline Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. **Note**: These endpoints are only available for admin users. Make sure to use an application key created by an admin. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsPipelineList.md b/docs/v1/LogsPipelineList.md index 39ccb3868b..8629702c65 100644 --- a/docs/v1/LogsPipelineList.md +++ b/docs/v1/LogsPipelineList.md @@ -1,6 +1,7 @@ # LogsPipelineList Array of pipeline ID strings. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsPipelineProcessor.md b/docs/v1/LogsPipelineProcessor.md index c826ef3e25..ac907912e9 100644 --- a/docs/v1/LogsPipelineProcessor.md +++ b/docs/v1/LogsPipelineProcessor.md @@ -1,6 +1,7 @@ # LogsPipelineProcessor Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsPipelineProcessorType.md b/docs/v1/LogsPipelineProcessorType.md index 4cabfe94c9..4d9ad03f0a 100644 --- a/docs/v1/LogsPipelineProcessorType.md +++ b/docs/v1/LogsPipelineProcessorType.md @@ -1,6 +1,7 @@ # LogsPipelineProcessorType Type of logs pipeline processor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsPipelinesApi.md b/docs/v1/LogsPipelinesApi.md index a44e50fbd9..28d5a1be6e 100644 --- a/docs/v1/LogsPipelinesApi.md +++ b/docs/v1/LogsPipelinesApi.md @@ -71,6 +71,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsPipelinesApi->create_logs_pipeline: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -90,6 +91,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -144,6 +146,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsPipelinesApi->delete_logs_pipeline: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -163,6 +166,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -218,6 +222,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsPipelinesApi->get_logs_pipeline: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -237,6 +242,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -291,6 +297,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsPipelinesApi->get_logs_pipeline_order: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -307,6 +314,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -360,6 +368,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsPipelinesApi->list_logs_pipelines: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -376,6 +385,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -443,6 +453,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsPipelinesApi->update_logs_pipeline: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -463,6 +474,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -520,6 +532,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsPipelinesApi->update_logs_pipeline_order: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -539,6 +552,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/LogsPipelinesOrder.md b/docs/v1/LogsPipelinesOrder.md index 6750fce674..7b6887d6fc 100644 --- a/docs/v1/LogsPipelinesOrder.md +++ b/docs/v1/LogsPipelinesOrder.md @@ -1,6 +1,7 @@ # LogsPipelinesOrder Object containing the ordered list of pipeline IDs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsProcessor.md b/docs/v1/LogsProcessor.md index 31aae8926c..25c1ef5840 100644 --- a/docs/v1/LogsProcessor.md +++ b/docs/v1/LogsProcessor.md @@ -1,6 +1,7 @@ # LogsProcessor Definition of a logs processor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsQueryCompute.md b/docs/v1/LogsQueryCompute.md index 5f9067c5d4..edf1b0747d 100644 --- a/docs/v1/LogsQueryCompute.md +++ b/docs/v1/LogsQueryCompute.md @@ -1,6 +1,7 @@ # LogsQueryCompute Define computation for a log query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsServiceRemapper.md b/docs/v1/LogsServiceRemapper.md index 5a17ae62a5..9c036c6fb8 100644 --- a/docs/v1/LogsServiceRemapper.md +++ b/docs/v1/LogsServiceRemapper.md @@ -1,6 +1,7 @@ # LogsServiceRemapper Use this processor if you want to assign one or more attributes as the official service. **Note:** If multiple service remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsServiceRemapperType.md b/docs/v1/LogsServiceRemapperType.md index e52398acd7..8f6712f3f0 100644 --- a/docs/v1/LogsServiceRemapperType.md +++ b/docs/v1/LogsServiceRemapperType.md @@ -1,6 +1,7 @@ # LogsServiceRemapperType Type of logs service remapper. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsSort.md b/docs/v1/LogsSort.md index 76e95bb024..4dbab728d9 100644 --- a/docs/v1/LogsSort.md +++ b/docs/v1/LogsSort.md @@ -1,6 +1,7 @@ # LogsSort Time-ascending `asc` or time-descending `desc`results. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsStatusRemapper.md b/docs/v1/LogsStatusRemapper.md index 6ddb7839f8..b30149b303 100644 --- a/docs/v1/LogsStatusRemapper.md +++ b/docs/v1/LogsStatusRemapper.md @@ -1,6 +1,7 @@ # LogsStatusRemapper Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with `emerg` or f (case-insensitive) map to `emerg` (0) - Strings beginning with `a` (case-insensitive) map to `alert` (1) - Strings beginning with `c` (case-insensitive) map to `critical` (2) - Strings beginning with `err` (case-insensitive) map to `error` (3) - Strings beginning with `w` (case-insensitive) map to `warning` (4) - Strings beginning with `n` (case-insensitive) map to `notice` (5) - Strings beginning with `i` (case-insensitive) map to `info` (6) - Strings beginning with `d`, `trace` or `verbose` (case-insensitive) map to `debug` (7) - Strings beginning with `o` or matching `OK` or `Success` (case-insensitive) map to OK - All others map to `info` (6) **Note:** If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsStatusRemapperType.md b/docs/v1/LogsStatusRemapperType.md index fe33ef9757..f22f2c945b 100644 --- a/docs/v1/LogsStatusRemapperType.md +++ b/docs/v1/LogsStatusRemapperType.md @@ -1,6 +1,7 @@ # LogsStatusRemapperType Type of logs status remapper. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsStringBuilderProcessor.md b/docs/v1/LogsStringBuilderProcessor.md index d24e11f6bb..9fc429d5db 100644 --- a/docs/v1/LogsStringBuilderProcessor.md +++ b/docs/v1/LogsStringBuilderProcessor.md @@ -1,6 +1,7 @@ # LogsStringBuilderProcessor Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax `%{attribute_path}`. **Notes**: - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsStringBuilderProcessorType.md b/docs/v1/LogsStringBuilderProcessorType.md index 8edff49a9b..8c09ed2a87 100644 --- a/docs/v1/LogsStringBuilderProcessorType.md +++ b/docs/v1/LogsStringBuilderProcessorType.md @@ -1,6 +1,7 @@ # LogsStringBuilderProcessorType Type of logs string builder processor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsTraceRemapper.md b/docs/v1/LogsTraceRemapper.md index 257b20f4c2..d3424e73e0 100644 --- a/docs/v1/LogsTraceRemapper.md +++ b/docs/v1/LogsTraceRemapper.md @@ -1,6 +1,7 @@ # LogsTraceRemapper There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on [how to inject a trace ID in the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces) and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsTraceRemapperType.md b/docs/v1/LogsTraceRemapperType.md index a5c3c3e68b..9ddf57d6c1 100644 --- a/docs/v1/LogsTraceRemapperType.md +++ b/docs/v1/LogsTraceRemapperType.md @@ -1,6 +1,7 @@ # LogsTraceRemapperType Type of logs trace remapper. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsURLParser.md b/docs/v1/LogsURLParser.md index 2237d6121b..d7f75a76a6 100644 --- a/docs/v1/LogsURLParser.md +++ b/docs/v1/LogsURLParser.md @@ -1,6 +1,7 @@ # LogsURLParser This processor extracts query parameters and other important parameters from a URL. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsURLParserType.md b/docs/v1/LogsURLParserType.md index 7a6105026b..64c7422d94 100644 --- a/docs/v1/LogsURLParserType.md +++ b/docs/v1/LogsURLParserType.md @@ -1,6 +1,7 @@ # LogsURLParserType Type of logs URL parser. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsUserAgentParser.md b/docs/v1/LogsUserAgentParser.md index d76bbc4db4..361738ad0c 100644 --- a/docs/v1/LogsUserAgentParser.md +++ b/docs/v1/LogsUserAgentParser.md @@ -1,6 +1,7 @@ # LogsUserAgentParser The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/LogsUserAgentParserType.md b/docs/v1/LogsUserAgentParserType.md index 75c6f79faf..34d92039d0 100644 --- a/docs/v1/LogsUserAgentParserType.md +++ b/docs/v1/LogsUserAgentParserType.md @@ -1,6 +1,7 @@ # LogsUserAgentParserType Type of logs User-Agent parser. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MetricMetadata.md b/docs/v1/MetricMetadata.md index 169db77ff7..df7ab07f3a 100644 --- a/docs/v1/MetricMetadata.md +++ b/docs/v1/MetricMetadata.md @@ -1,6 +1,7 @@ # MetricMetadata Object with all metric related metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MetricSearchResponse.md b/docs/v1/MetricSearchResponse.md index c4e94f0864..2a7ca9550b 100644 --- a/docs/v1/MetricSearchResponse.md +++ b/docs/v1/MetricSearchResponse.md @@ -1,6 +1,7 @@ # MetricSearchResponse Object containing the list of metrics matching the search query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MetricSearchResponseResults.md b/docs/v1/MetricSearchResponseResults.md index da9cbf4409..83e1ed1407 100644 --- a/docs/v1/MetricSearchResponseResults.md +++ b/docs/v1/MetricSearchResponseResults.md @@ -1,6 +1,7 @@ # MetricSearchResponseResults Search result. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MetricsApi.md b/docs/v1/MetricsApi.md index 21eb16f3f1..ebe586365a 100644 --- a/docs/v1/MetricsApi.md +++ b/docs/v1/MetricsApi.md @@ -57,6 +57,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->get_metric_metadata: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -76,6 +77,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -141,6 +143,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->list_active_metrics: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -161,6 +164,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -216,6 +220,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->list_metrics: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -235,6 +240,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -292,6 +298,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->query_metrics: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -313,6 +320,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -377,6 +385,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->update_metric_metadata: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -397,6 +406,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/MetricsListResponse.md b/docs/v1/MetricsListResponse.md index fa99d07307..bda67f2dde 100644 --- a/docs/v1/MetricsListResponse.md +++ b/docs/v1/MetricsListResponse.md @@ -1,6 +1,7 @@ # MetricsListResponse Object listing all metric names stored by Datadog since a given time. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MetricsQueryMetadata.md b/docs/v1/MetricsQueryMetadata.md index 50ee8443fd..d5d2061172 100644 --- a/docs/v1/MetricsQueryMetadata.md +++ b/docs/v1/MetricsQueryMetadata.md @@ -1,6 +1,7 @@ # MetricsQueryMetadata Object containing all metric names returned and their associated metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MetricsQueryResponse.md b/docs/v1/MetricsQueryResponse.md index 811fb961de..ed5fed2b63 100644 --- a/docs/v1/MetricsQueryResponse.md +++ b/docs/v1/MetricsQueryResponse.md @@ -1,6 +1,7 @@ # MetricsQueryResponse Response Object that includes your query and the list of metrics retrieved. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MetricsQueryUnit.md b/docs/v1/MetricsQueryUnit.md index 20f8d1029b..013186e96f 100644 --- a/docs/v1/MetricsQueryUnit.md +++ b/docs/v1/MetricsQueryUnit.md @@ -1,6 +1,7 @@ # MetricsQueryUnit Object containing the metric unit family, scale factor, name, and short name. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/Monitor.md b/docs/v1/Monitor.md index a73a0a0931..3b9cd33669 100644 --- a/docs/v1/Monitor.md +++ b/docs/v1/Monitor.md @@ -1,6 +1,7 @@ # Monitor Object describing a monitor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorDeviceID.md b/docs/v1/MonitorDeviceID.md index 92f3b6728c..4010d281e7 100644 --- a/docs/v1/MonitorDeviceID.md +++ b/docs/v1/MonitorDeviceID.md @@ -1,6 +1,7 @@ # MonitorDeviceID ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorOptions.md b/docs/v1/MonitorOptions.md index 6a16d44f9d..78ced35032 100644 --- a/docs/v1/MonitorOptions.md +++ b/docs/v1/MonitorOptions.md @@ -1,6 +1,7 @@ # MonitorOptions List of options associated with your monitor. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorOptionsAggregation.md b/docs/v1/MonitorOptionsAggregation.md index 4681ce7118..c9c671dd86 100644 --- a/docs/v1/MonitorOptionsAggregation.md +++ b/docs/v1/MonitorOptionsAggregation.md @@ -1,6 +1,7 @@ # MonitorOptionsAggregation Type of aggregation performed in the monitor query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorOverallStates.md b/docs/v1/MonitorOverallStates.md index b954ed6e9e..e5eaff56e8 100644 --- a/docs/v1/MonitorOverallStates.md +++ b/docs/v1/MonitorOverallStates.md @@ -1,6 +1,7 @@ # MonitorOverallStates The different states your monitor can be in. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorState.md b/docs/v1/MonitorState.md index 2d3798d779..ba61951e28 100644 --- a/docs/v1/MonitorState.md +++ b/docs/v1/MonitorState.md @@ -1,6 +1,7 @@ # MonitorState Wrapper object with the different monitor states. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorStateGroup.md b/docs/v1/MonitorStateGroup.md index 00dc66f178..22af64ad1b 100644 --- a/docs/v1/MonitorStateGroup.md +++ b/docs/v1/MonitorStateGroup.md @@ -1,6 +1,7 @@ # MonitorStateGroup Monitor state for a single group. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorSummaryWidgetDefinition.md b/docs/v1/MonitorSummaryWidgetDefinition.md index 9352d3cfc5..3ecb36d71f 100644 --- a/docs/v1/MonitorSummaryWidgetDefinition.md +++ b/docs/v1/MonitorSummaryWidgetDefinition.md @@ -1,6 +1,7 @@ # MonitorSummaryWidgetDefinition The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorSummaryWidgetDefinitionType.md b/docs/v1/MonitorSummaryWidgetDefinitionType.md index c88d753ed1..6435602096 100644 --- a/docs/v1/MonitorSummaryWidgetDefinitionType.md +++ b/docs/v1/MonitorSummaryWidgetDefinitionType.md @@ -1,6 +1,7 @@ # MonitorSummaryWidgetDefinitionType Type of the monitor summary widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorThresholdWindowOptions.md b/docs/v1/MonitorThresholdWindowOptions.md index f4c5f03caf..438423d3ad 100644 --- a/docs/v1/MonitorThresholdWindowOptions.md +++ b/docs/v1/MonitorThresholdWindowOptions.md @@ -1,6 +1,7 @@ # MonitorThresholdWindowOptions Alerting time window options. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorThresholds.md b/docs/v1/MonitorThresholds.md index e4b6515a80..b1403f4d12 100644 --- a/docs/v1/MonitorThresholds.md +++ b/docs/v1/MonitorThresholds.md @@ -1,6 +1,7 @@ # MonitorThresholds List of the different monitor threshold available. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorType.md b/docs/v1/MonitorType.md index f7e9e83542..2dc4d73828 100644 --- a/docs/v1/MonitorType.md +++ b/docs/v1/MonitorType.md @@ -1,6 +1,7 @@ # MonitorType The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorUpdateRequest.md b/docs/v1/MonitorUpdateRequest.md index a449c2f205..de721b9e24 100644 --- a/docs/v1/MonitorUpdateRequest.md +++ b/docs/v1/MonitorUpdateRequest.md @@ -1,6 +1,7 @@ # MonitorUpdateRequest Object describing a monitor update request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/MonitorsApi.md b/docs/v1/MonitorsApi.md index acee115def..1876171132 100644 --- a/docs/v1/MonitorsApi.md +++ b/docs/v1/MonitorsApi.md @@ -61,6 +61,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MonitorsApi->check_can_delete_monitor: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -80,6 +81,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -212,6 +214,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MonitorsApi->create_monitor: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -231,6 +234,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -296,6 +300,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MonitorsApi->delete_monitor: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -316,6 +321,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -383,6 +389,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MonitorsApi->get_monitor: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -403,6 +410,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -467,6 +475,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MonitorsApi->list_monitors: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -493,6 +502,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -625,6 +635,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MonitorsApi->update_monitor: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -645,6 +656,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -778,6 +790,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MonitorsApi->validate_monitor: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -797,6 +810,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/NoteWidgetDefinition.md b/docs/v1/NoteWidgetDefinition.md index ae3a0c3f3d..39be84a26c 100644 --- a/docs/v1/NoteWidgetDefinition.md +++ b/docs/v1/NoteWidgetDefinition.md @@ -1,6 +1,7 @@ # NoteWidgetDefinition The notes and links widget is similar to free text widget, but allows for more formatting options. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/NoteWidgetDefinitionType.md b/docs/v1/NoteWidgetDefinitionType.md index 24ebc12b8e..d686931861 100644 --- a/docs/v1/NoteWidgetDefinitionType.md +++ b/docs/v1/NoteWidgetDefinitionType.md @@ -1,6 +1,7 @@ # NoteWidgetDefinitionType Type of the note widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/Organization.md b/docs/v1/Organization.md index f7b397c105..a933834143 100644 --- a/docs/v1/Organization.md +++ b/docs/v1/Organization.md @@ -1,6 +1,7 @@ # Organization Create, edit, and manage organizations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationBilling.md b/docs/v1/OrganizationBilling.md index 893735a0b0..53747c90e7 100644 --- a/docs/v1/OrganizationBilling.md +++ b/docs/v1/OrganizationBilling.md @@ -1,6 +1,7 @@ # OrganizationBilling A JSON array of billing type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationCreateBody.md b/docs/v1/OrganizationCreateBody.md index e60e45c790..4f79b29321 100644 --- a/docs/v1/OrganizationCreateBody.md +++ b/docs/v1/OrganizationCreateBody.md @@ -1,6 +1,7 @@ # OrganizationCreateBody Object describing an organization to create. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationCreateResponse.md b/docs/v1/OrganizationCreateResponse.md index 4a44dd2d85..02ced763a8 100644 --- a/docs/v1/OrganizationCreateResponse.md +++ b/docs/v1/OrganizationCreateResponse.md @@ -1,6 +1,7 @@ # OrganizationCreateResponse Response object for an organization creation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationListResponse.md b/docs/v1/OrganizationListResponse.md index 60aaae9a0d..79a7be61ef 100644 --- a/docs/v1/OrganizationListResponse.md +++ b/docs/v1/OrganizationListResponse.md @@ -1,6 +1,7 @@ # OrganizationListResponse Response with the list of organizations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationResponse.md b/docs/v1/OrganizationResponse.md index b35c234ffb..d74bf83190 100644 --- a/docs/v1/OrganizationResponse.md +++ b/docs/v1/OrganizationResponse.md @@ -1,6 +1,7 @@ # OrganizationResponse Response with an organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationSettings.md b/docs/v1/OrganizationSettings.md index 49ae37c987..8fa7a62829 100644 --- a/docs/v1/OrganizationSettings.md +++ b/docs/v1/OrganizationSettings.md @@ -1,6 +1,7 @@ # OrganizationSettings A JSON array of settings. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationSettingsSaml.md b/docs/v1/OrganizationSettingsSaml.md index 2cbf98e543..1d04260b70 100644 --- a/docs/v1/OrganizationSettingsSaml.md +++ b/docs/v1/OrganizationSettingsSaml.md @@ -1,6 +1,7 @@ # OrganizationSettingsSaml Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md b/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md index 3c5d0ccd9c..e51d6a781e 100644 --- a/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md +++ b/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md @@ -1,6 +1,7 @@ # OrganizationSettingsSamlAutocreateUsersDomains Has two properties, `enabled` (boolean) and `domains`, which is a list of domains without the @ symbol. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md b/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md index 5607fb473f..1fd5258be1 100644 --- a/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md +++ b/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md @@ -1,6 +1,7 @@ # OrganizationSettingsSamlIdpInitiatedLogin Has one property enabled (boolean). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationSettingsSamlStrictMode.md b/docs/v1/OrganizationSettingsSamlStrictMode.md index 419a739e3c..1c05fb1901 100644 --- a/docs/v1/OrganizationSettingsSamlStrictMode.md +++ b/docs/v1/OrganizationSettingsSamlStrictMode.md @@ -1,6 +1,7 @@ # OrganizationSettingsSamlStrictMode Has one property enabled (boolean). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationSubscription.md b/docs/v1/OrganizationSubscription.md index b8bdd57e7e..a11535ba83 100644 --- a/docs/v1/OrganizationSubscription.md +++ b/docs/v1/OrganizationSubscription.md @@ -1,6 +1,7 @@ # OrganizationSubscription Subscription definition. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/OrganizationsApi.md b/docs/v1/OrganizationsApi.md index 5175b33010..938c1cfbd9 100644 --- a/docs/v1/OrganizationsApi.md +++ b/docs/v1/OrganizationsApi.md @@ -65,6 +65,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling OrganizationsApi->create_child_org: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -84,6 +85,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -139,6 +141,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling OrganizationsApi->get_org: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -158,6 +161,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -212,6 +216,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling OrganizationsApi->list_orgs: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -228,6 +233,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -317,6 +323,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling OrganizationsApi->update_org: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -337,6 +344,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -393,6 +401,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling OrganizationsApi->upload_id_p_for_org: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -413,6 +422,7 @@ Name | Type | Description | Notes - **Content-Type**: multipart/form-data - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/PagerDutyIntegrationApi.md b/docs/v1/PagerDutyIntegrationApi.md index f41a2f6663..6cf385e134 100644 --- a/docs/v1/PagerDutyIntegrationApi.md +++ b/docs/v1/PagerDutyIntegrationApi.md @@ -59,6 +59,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling PagerDutyIntegrationApi->create_pager_duty_integration_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -78,6 +79,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -132,6 +134,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling PagerDutyIntegrationApi->delete_pager_duty_integration_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -151,6 +154,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -206,6 +210,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling PagerDutyIntegrationApi->get_pager_duty_integration_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -225,6 +230,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -282,6 +288,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling PagerDutyIntegrationApi->update_pager_duty_integration_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -302,6 +309,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/PagerDutyService.md b/docs/v1/PagerDutyService.md index 0a756e93bb..05b47ba9c0 100644 --- a/docs/v1/PagerDutyService.md +++ b/docs/v1/PagerDutyService.md @@ -1,6 +1,7 @@ # PagerDutyService The PagerDuty service that is available for integration with Datadog. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/PagerDutyServiceKey.md b/docs/v1/PagerDutyServiceKey.md index ca3ae4cdc8..40003e794b 100644 --- a/docs/v1/PagerDutyServiceKey.md +++ b/docs/v1/PagerDutyServiceKey.md @@ -1,6 +1,7 @@ # PagerDutyServiceKey PagerDuty service object key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/PagerDutyServiceName.md b/docs/v1/PagerDutyServiceName.md index f48aff95ca..cc9f0fab63 100644 --- a/docs/v1/PagerDutyServiceName.md +++ b/docs/v1/PagerDutyServiceName.md @@ -1,6 +1,7 @@ # PagerDutyServiceName PagerDuty service object name. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/Point.md b/docs/v1/Point.md index f05557eb83..eb27ee1299 100644 --- a/docs/v1/Point.md +++ b/docs/v1/Point.md @@ -1,6 +1,7 @@ # Point Array of timeseries points. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ProcessQueryDefinition.md b/docs/v1/ProcessQueryDefinition.md index dc9a0095b7..c057a3a9db 100644 --- a/docs/v1/ProcessQueryDefinition.md +++ b/docs/v1/ProcessQueryDefinition.md @@ -1,6 +1,7 @@ # ProcessQueryDefinition The process query to use in the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/QuerySortOrder.md b/docs/v1/QuerySortOrder.md index 3aa30f45d5..286472ed01 100644 --- a/docs/v1/QuerySortOrder.md +++ b/docs/v1/QuerySortOrder.md @@ -1,6 +1,7 @@ # QuerySortOrder Direction of sort. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/QueryValueWidgetDefinition.md b/docs/v1/QueryValueWidgetDefinition.md index 9faa9b2369..85e6e0c2b6 100644 --- a/docs/v1/QueryValueWidgetDefinition.md +++ b/docs/v1/QueryValueWidgetDefinition.md @@ -1,6 +1,7 @@ # QueryValueWidgetDefinition Query values display the current value of a given metric, APM, or log query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/QueryValueWidgetDefinitionType.md b/docs/v1/QueryValueWidgetDefinitionType.md index 8e7a26be4f..f7f2ed9196 100644 --- a/docs/v1/QueryValueWidgetDefinitionType.md +++ b/docs/v1/QueryValueWidgetDefinitionType.md @@ -1,6 +1,7 @@ # QueryValueWidgetDefinitionType Type of the query value widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/QueryValueWidgetRequest.md b/docs/v1/QueryValueWidgetRequest.md index 9d487d6096..1d94041809 100644 --- a/docs/v1/QueryValueWidgetRequest.md +++ b/docs/v1/QueryValueWidgetRequest.md @@ -1,6 +1,7 @@ # QueryValueWidgetRequest Updated query value widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOBulkDelete.md b/docs/v1/SLOBulkDelete.md index 688d141e0c..a76df1229d 100644 --- a/docs/v1/SLOBulkDelete.md +++ b/docs/v1/SLOBulkDelete.md @@ -1,6 +1,7 @@ # SLOBulkDelete A map of service level objective object IDs to arrays of timeframes, which indicate the thresholds to delete for each ID. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOBulkDeleteError.md b/docs/v1/SLOBulkDeleteError.md index 19b802e246..0683597181 100644 --- a/docs/v1/SLOBulkDeleteError.md +++ b/docs/v1/SLOBulkDeleteError.md @@ -1,6 +1,7 @@ # SLOBulkDeleteError Object describing the error. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOBulkDeleteResponse.md b/docs/v1/SLOBulkDeleteResponse.md index 2512e7d1c3..56b49f34a3 100644 --- a/docs/v1/SLOBulkDeleteResponse.md +++ b/docs/v1/SLOBulkDeleteResponse.md @@ -1,6 +1,7 @@ # SLOBulkDeleteResponse The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the \"data\" and \"error\" fields in this response indicate which deletions succeeded and failed. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOBulkDeleteResponseData.md b/docs/v1/SLOBulkDeleteResponseData.md index f2aea7b7e6..8c071fbe5e 100644 --- a/docs/v1/SLOBulkDeleteResponseData.md +++ b/docs/v1/SLOBulkDeleteResponseData.md @@ -1,6 +1,7 @@ # SLOBulkDeleteResponseData An array of service level objective objects. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrection.md b/docs/v1/SLOCorrection.md index 76f9c45b23..9008d8256c 100644 --- a/docs/v1/SLOCorrection.md +++ b/docs/v1/SLOCorrection.md @@ -1,6 +1,7 @@ # SLOCorrection The response object of a list of SLO corrections + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionCategory.md b/docs/v1/SLOCorrectionCategory.md index 038f4e72df..375c2cf973 100644 --- a/docs/v1/SLOCorrectionCategory.md +++ b/docs/v1/SLOCorrectionCategory.md @@ -1,6 +1,7 @@ # SLOCorrectionCategory Category the SLO correction belongs to + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionCreateData.md b/docs/v1/SLOCorrectionCreateData.md index 4545cee242..4bfe0edce7 100644 --- a/docs/v1/SLOCorrectionCreateData.md +++ b/docs/v1/SLOCorrectionCreateData.md @@ -1,6 +1,7 @@ # SLOCorrectionCreateData The data object associated with the SLO correction to be created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionCreateRequest.md b/docs/v1/SLOCorrectionCreateRequest.md index 82f2cd6b9d..2f74974d00 100644 --- a/docs/v1/SLOCorrectionCreateRequest.md +++ b/docs/v1/SLOCorrectionCreateRequest.md @@ -1,6 +1,7 @@ # SLOCorrectionCreateRequest An object that defines a correction to be applied to an SLO + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionCreateRequestAttributes.md b/docs/v1/SLOCorrectionCreateRequestAttributes.md index f40bf225fd..877ab2cdcb 100644 --- a/docs/v1/SLOCorrectionCreateRequestAttributes.md +++ b/docs/v1/SLOCorrectionCreateRequestAttributes.md @@ -1,6 +1,7 @@ # SLOCorrectionCreateRequestAttributes The attribute object associated with the SLO correction to be created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionListResponse.md b/docs/v1/SLOCorrectionListResponse.md index 7f10a243c0..3d524dfcd5 100644 --- a/docs/v1/SLOCorrectionListResponse.md +++ b/docs/v1/SLOCorrectionListResponse.md @@ -1,6 +1,7 @@ # SLOCorrectionListResponse A list of SLO correction objects + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionResponse.md b/docs/v1/SLOCorrectionResponse.md index b59c9b7a41..ae05ec9690 100644 --- a/docs/v1/SLOCorrectionResponse.md +++ b/docs/v1/SLOCorrectionResponse.md @@ -1,6 +1,7 @@ # SLOCorrectionResponse The response object of an SLO correction + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionResponseAttributes.md b/docs/v1/SLOCorrectionResponseAttributes.md index 8b7466bad8..e3791c5c92 100644 --- a/docs/v1/SLOCorrectionResponseAttributes.md +++ b/docs/v1/SLOCorrectionResponseAttributes.md @@ -1,6 +1,7 @@ # SLOCorrectionResponseAttributes The attribute object associated with the SLO correction + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionType.md b/docs/v1/SLOCorrectionType.md index 54583e7b18..5fd4066672 100644 --- a/docs/v1/SLOCorrectionType.md +++ b/docs/v1/SLOCorrectionType.md @@ -1,6 +1,7 @@ # SLOCorrectionType SLO correction resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionUpdateData.md b/docs/v1/SLOCorrectionUpdateData.md index 6656b4a3fa..9f50add8d8 100644 --- a/docs/v1/SLOCorrectionUpdateData.md +++ b/docs/v1/SLOCorrectionUpdateData.md @@ -1,6 +1,7 @@ # SLOCorrectionUpdateData The data object associated with the SLO correction to be updated + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionUpdateRequest.md b/docs/v1/SLOCorrectionUpdateRequest.md index d16c49c963..bbb815ab13 100644 --- a/docs/v1/SLOCorrectionUpdateRequest.md +++ b/docs/v1/SLOCorrectionUpdateRequest.md @@ -1,6 +1,7 @@ # SLOCorrectionUpdateRequest An object that defines a correction to be applied to an SLO + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOCorrectionUpdateRequestAttributes.md b/docs/v1/SLOCorrectionUpdateRequestAttributes.md index e3343ea50c..10904c1a74 100644 --- a/docs/v1/SLOCorrectionUpdateRequestAttributes.md +++ b/docs/v1/SLOCorrectionUpdateRequestAttributes.md @@ -1,6 +1,7 @@ # SLOCorrectionUpdateRequestAttributes The attribute object associated with the SLO correction to be updated + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLODeleteResponse.md b/docs/v1/SLODeleteResponse.md index 318d3ca4d8..fe25c57f2e 100644 --- a/docs/v1/SLODeleteResponse.md +++ b/docs/v1/SLODeleteResponse.md @@ -1,6 +1,7 @@ # SLODeleteResponse A response list of all service level objective deleted. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOErrorBudgetRemainingData.md b/docs/v1/SLOErrorBudgetRemainingData.md index a4ea32903d..76f6461112 100644 --- a/docs/v1/SLOErrorBudgetRemainingData.md +++ b/docs/v1/SLOErrorBudgetRemainingData.md @@ -1,6 +1,7 @@ # SLOErrorBudgetRemainingData A mapping of threshold `timeframe` to the remaining error budget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOErrorTimeframe.md b/docs/v1/SLOErrorTimeframe.md index 19a30ed727..b6d9c26368 100644 --- a/docs/v1/SLOErrorTimeframe.md +++ b/docs/v1/SLOErrorTimeframe.md @@ -1,6 +1,7 @@ # SLOErrorTimeframe The timeframe of the threshold associated with this error or \"all\" if all thresholds are affected. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistoryMetrics.md b/docs/v1/SLOHistoryMetrics.md index fca8954e07..040b26f8e2 100644 --- a/docs/v1/SLOHistoryMetrics.md +++ b/docs/v1/SLOHistoryMetrics.md @@ -1,6 +1,7 @@ # SLOHistoryMetrics A `metric` based SLO history response. This is not included in responses for `monitor` based SLOs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistoryMetricsSeries.md b/docs/v1/SLOHistoryMetricsSeries.md index bf46c7270d..4906d8b992 100644 --- a/docs/v1/SLOHistoryMetricsSeries.md +++ b/docs/v1/SLOHistoryMetricsSeries.md @@ -1,6 +1,7 @@ # SLOHistoryMetricsSeries A representation of `metric` based SLO time series for the provided queries. This is the same response type from `batch_query` endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistoryMetricsSeriesMetadata.md b/docs/v1/SLOHistoryMetricsSeriesMetadata.md index 3f5cfd44b3..6a22b05792 100644 --- a/docs/v1/SLOHistoryMetricsSeriesMetadata.md +++ b/docs/v1/SLOHistoryMetricsSeriesMetadata.md @@ -1,6 +1,7 @@ # SLOHistoryMetricsSeriesMetadata Query metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md b/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md index b3d2ccf4a1..7c30f47432 100644 --- a/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md +++ b/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md @@ -1,6 +1,7 @@ # SLOHistoryMetricsSeriesMetadataUnit An Object of metric units. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistoryResponse.md b/docs/v1/SLOHistoryResponse.md index cdf2ad194e..58d9ed4af7 100644 --- a/docs/v1/SLOHistoryResponse.md +++ b/docs/v1/SLOHistoryResponse.md @@ -1,6 +1,7 @@ # SLOHistoryResponse A service level objective history response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistoryResponseData.md b/docs/v1/SLOHistoryResponseData.md index 0e0a6f56ef..c37414ebf7 100644 --- a/docs/v1/SLOHistoryResponseData.md +++ b/docs/v1/SLOHistoryResponseData.md @@ -1,6 +1,7 @@ # SLOHistoryResponseData An array of service level objective objects. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistoryResponseError.md b/docs/v1/SLOHistoryResponseError.md index 8a4555af2d..62597db9ae 100644 --- a/docs/v1/SLOHistoryResponseError.md +++ b/docs/v1/SLOHistoryResponseError.md @@ -1,6 +1,7 @@ # SLOHistoryResponseError A service level objective response containing the requested history. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOHistorySLIData.md b/docs/v1/SLOHistorySLIData.md index 61e33038d8..90dc71595c 100644 --- a/docs/v1/SLOHistorySLIData.md +++ b/docs/v1/SLOHistorySLIData.md @@ -1,6 +1,7 @@ # SLOHistorySLIData An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOListResponse.md b/docs/v1/SLOListResponse.md index 1c3755e81d..9eaeeb6cac 100644 --- a/docs/v1/SLOListResponse.md +++ b/docs/v1/SLOListResponse.md @@ -1,6 +1,7 @@ # SLOListResponse A response with one or more service level objective. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOResponse.md b/docs/v1/SLOResponse.md index 80dceda662..d32fc8c5ae 100644 --- a/docs/v1/SLOResponse.md +++ b/docs/v1/SLOResponse.md @@ -1,6 +1,7 @@ # SLOResponse A service level objective response containing a single service level objective. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOThreshold.md b/docs/v1/SLOThreshold.md index 625e1d96c8..4c47c85373 100644 --- a/docs/v1/SLOThreshold.md +++ b/docs/v1/SLOThreshold.md @@ -1,6 +1,7 @@ # SLOThreshold SLO thresholds (target and optionally warning) for a single time window. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOTimeframe.md b/docs/v1/SLOTimeframe.md index a9257efb6e..fb3225c2bf 100644 --- a/docs/v1/SLOTimeframe.md +++ b/docs/v1/SLOTimeframe.md @@ -1,6 +1,7 @@ # SLOTimeframe The SLO time window options. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOType.md b/docs/v1/SLOType.md index b50372a00a..46b8d8e8a0 100644 --- a/docs/v1/SLOType.md +++ b/docs/v1/SLOType.md @@ -1,6 +1,7 @@ # SLOType The type of the service level objective. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOTypeNumeric.md b/docs/v1/SLOTypeNumeric.md index 33b91a64ec..6ce75424aa 100644 --- a/docs/v1/SLOTypeNumeric.md +++ b/docs/v1/SLOTypeNumeric.md @@ -1,6 +1,7 @@ # SLOTypeNumeric A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. Ignored in create/update requests. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOWidgetDefinition.md b/docs/v1/SLOWidgetDefinition.md index 8fc9503e87..8bb2e22518 100644 --- a/docs/v1/SLOWidgetDefinition.md +++ b/docs/v1/SLOWidgetDefinition.md @@ -1,6 +1,7 @@ # SLOWidgetDefinition Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SLOWidgetDefinitionType.md b/docs/v1/SLOWidgetDefinitionType.md index 349553d954..a87837ab5f 100644 --- a/docs/v1/SLOWidgetDefinitionType.md +++ b/docs/v1/SLOWidgetDefinitionType.md @@ -1,6 +1,7 @@ # SLOWidgetDefinitionType Type of the SLO widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ScatterPlotRequest.md b/docs/v1/ScatterPlotRequest.md index 6a65d5b476..25a1ec5f12 100644 --- a/docs/v1/ScatterPlotRequest.md +++ b/docs/v1/ScatterPlotRequest.md @@ -1,6 +1,7 @@ # ScatterPlotRequest Updated scatter plot. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ScatterPlotWidgetDefinition.md b/docs/v1/ScatterPlotWidgetDefinition.md index 4a155e30cb..f4d3eb2bf7 100644 --- a/docs/v1/ScatterPlotWidgetDefinition.md +++ b/docs/v1/ScatterPlotWidgetDefinition.md @@ -1,6 +1,7 @@ # ScatterPlotWidgetDefinition The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ScatterPlotWidgetDefinitionRequests.md b/docs/v1/ScatterPlotWidgetDefinitionRequests.md index fd348acf8a..3ae535c4ba 100644 --- a/docs/v1/ScatterPlotWidgetDefinitionRequests.md +++ b/docs/v1/ScatterPlotWidgetDefinitionRequests.md @@ -1,6 +1,7 @@ # ScatterPlotWidgetDefinitionRequests Widget definition. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ScatterPlotWidgetDefinitionType.md b/docs/v1/ScatterPlotWidgetDefinitionType.md index 9c3ba5c0e2..e3b305cb53 100644 --- a/docs/v1/ScatterPlotWidgetDefinitionType.md +++ b/docs/v1/ScatterPlotWidgetDefinitionType.md @@ -1,6 +1,7 @@ # ScatterPlotWidgetDefinitionType Type of the scatter plot widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ServiceLevelObjective.md b/docs/v1/ServiceLevelObjective.md index c52a4f7e23..77cf2c3d8c 100644 --- a/docs/v1/ServiceLevelObjective.md +++ b/docs/v1/ServiceLevelObjective.md @@ -1,6 +1,7 @@ # ServiceLevelObjective A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ServiceLevelObjectiveCorrectionsApi.md b/docs/v1/ServiceLevelObjectiveCorrectionsApi.md index 76124e910b..4045d562b5 100644 --- a/docs/v1/ServiceLevelObjectiveCorrectionsApi.md +++ b/docs/v1/ServiceLevelObjectiveCorrectionsApi.md @@ -70,6 +70,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectiveCorrectionsApi->create_slo_correction: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -89,6 +90,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -144,6 +146,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectiveCorrectionsApi->delete_slo_correction: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -163,6 +166,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -219,6 +223,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectiveCorrectionsApi->get_slo_correction: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -238,6 +243,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -293,6 +299,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectiveCorrectionsApi->list_slo_correction: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -309,6 +316,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -376,6 +384,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectiveCorrectionsApi->update_slo_correction: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -396,6 +405,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/ServiceLevelObjectiveQuery.md b/docs/v1/ServiceLevelObjectiveQuery.md index 89e3693a05..2f14bba1a3 100644 --- a/docs/v1/ServiceLevelObjectiveQuery.md +++ b/docs/v1/ServiceLevelObjectiveQuery.md @@ -1,6 +1,7 @@ # ServiceLevelObjectiveQuery A metric SLI query. **Required if type is `metric`**. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ServiceLevelObjectiveRequest.md b/docs/v1/ServiceLevelObjectiveRequest.md index c79175dfbd..39121dea80 100644 --- a/docs/v1/ServiceLevelObjectiveRequest.md +++ b/docs/v1/ServiceLevelObjectiveRequest.md @@ -1,6 +1,7 @@ # ServiceLevelObjectiveRequest A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ServiceLevelObjectivesApi.md b/docs/v1/ServiceLevelObjectivesApi.md index 7823f5fc39..07f663ffe7 100644 --- a/docs/v1/ServiceLevelObjectivesApi.md +++ b/docs/v1/ServiceLevelObjectivesApi.md @@ -60,6 +60,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->check_can_delete_slo: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -79,6 +80,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -157,6 +159,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->create_slo: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -176,6 +179,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -241,6 +245,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->delete_slo: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -261,6 +266,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -321,6 +327,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->delete_slo_timeframe_in_bulk: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -340,6 +347,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -395,6 +403,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->get_slo: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -414,6 +423,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -472,6 +482,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->get_slo_history: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -493,6 +504,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -553,6 +565,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->list_slos: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -575,6 +588,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -657,6 +671,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ServiceLevelObjectivesApi->update_slo: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -677,6 +692,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/ServiceMapWidgetDefinition.md b/docs/v1/ServiceMapWidgetDefinition.md index 36707c1100..acbd8e6802 100644 --- a/docs/v1/ServiceMapWidgetDefinition.md +++ b/docs/v1/ServiceMapWidgetDefinition.md @@ -1,6 +1,7 @@ # ServiceMapWidgetDefinition This widget displays a map of a service to all of the services that call it, and all of the services that it calls. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ServiceMapWidgetDefinitionType.md b/docs/v1/ServiceMapWidgetDefinitionType.md index 2fcb1b7ebf..04bc621267 100644 --- a/docs/v1/ServiceMapWidgetDefinitionType.md +++ b/docs/v1/ServiceMapWidgetDefinitionType.md @@ -1,6 +1,7 @@ # ServiceMapWidgetDefinitionType Type of the service map widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ServiceSummaryWidgetDefinition.md b/docs/v1/ServiceSummaryWidgetDefinition.md index 1bf2581e20..3670a210b9 100644 --- a/docs/v1/ServiceSummaryWidgetDefinition.md +++ b/docs/v1/ServiceSummaryWidgetDefinition.md @@ -1,6 +1,7 @@ # ServiceSummaryWidgetDefinition The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ServiceSummaryWidgetDefinitionType.md b/docs/v1/ServiceSummaryWidgetDefinitionType.md index 7ad879d7cc..be32f02010 100644 --- a/docs/v1/ServiceSummaryWidgetDefinitionType.md +++ b/docs/v1/ServiceSummaryWidgetDefinitionType.md @@ -1,6 +1,7 @@ # ServiceSummaryWidgetDefinitionType Type of the service summary widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SlackIntegrationApi.md b/docs/v1/SlackIntegrationApi.md index 320c8e6fa8..2e856e4ba1 100644 --- a/docs/v1/SlackIntegrationApi.md +++ b/docs/v1/SlackIntegrationApi.md @@ -66,6 +66,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SlackIntegrationApi->create_slack_integration_channel: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -86,6 +87,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -143,6 +145,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SlackIntegrationApi->get_slack_integration_channel: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -163,6 +166,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -219,6 +223,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SlackIntegrationApi->get_slack_integration_channels: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -238,6 +243,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -294,6 +300,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SlackIntegrationApi->remove_slack_integration_channel: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -314,6 +321,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -380,6 +388,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SlackIntegrationApi->update_slack_integration_channel: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -401,6 +410,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/SlackIntegrationChannel.md b/docs/v1/SlackIntegrationChannel.md index 6be7fceb12..43a535623f 100644 --- a/docs/v1/SlackIntegrationChannel.md +++ b/docs/v1/SlackIntegrationChannel.md @@ -1,6 +1,7 @@ # SlackIntegrationChannel The Slack channel configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SlackIntegrationChannelDisplay.md b/docs/v1/SlackIntegrationChannelDisplay.md index bdef41e2d7..2089c86bfb 100644 --- a/docs/v1/SlackIntegrationChannelDisplay.md +++ b/docs/v1/SlackIntegrationChannelDisplay.md @@ -1,6 +1,7 @@ # SlackIntegrationChannelDisplay Configuration options for what is shown in an alert event message. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SlackIntegrationChannels.md b/docs/v1/SlackIntegrationChannels.md index 01a09598c0..1cfdbb4baf 100644 --- a/docs/v1/SlackIntegrationChannels.md +++ b/docs/v1/SlackIntegrationChannels.md @@ -1,6 +1,7 @@ # SlackIntegrationChannels A list of configured Slack channels. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SnapshotsApi.md b/docs/v1/SnapshotsApi.md index a6c61ff44d..57d1ddb167 100644 --- a/docs/v1/SnapshotsApi.md +++ b/docs/v1/SnapshotsApi.md @@ -67,6 +67,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SnapshotsApi->get_graph_snapshot: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -91,6 +92,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/SyntheticsAPIStep.md b/docs/v1/SyntheticsAPIStep.md index 171f2e3b3d..dbb4749807 100644 --- a/docs/v1/SyntheticsAPIStep.md +++ b/docs/v1/SyntheticsAPIStep.md @@ -1,6 +1,7 @@ # SyntheticsAPIStep The steps used in a Synthetics multistep API test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPIStepSubtype.md b/docs/v1/SyntheticsAPIStepSubtype.md index 2dcfa51253..6863591942 100644 --- a/docs/v1/SyntheticsAPIStepSubtype.md +++ b/docs/v1/SyntheticsAPIStepSubtype.md @@ -1,6 +1,7 @@ # SyntheticsAPIStepSubtype The subtype of the Synthetic multistep API test step, currently only supporting `http`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITest.md b/docs/v1/SyntheticsAPITest.md index b3888d71d3..3f08265b36 100644 --- a/docs/v1/SyntheticsAPITest.md +++ b/docs/v1/SyntheticsAPITest.md @@ -1,6 +1,7 @@ # SyntheticsAPITest Object containing details about a Synthetic API test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITestConfig.md b/docs/v1/SyntheticsAPITestConfig.md index 1984b6c275..c85176a837 100644 --- a/docs/v1/SyntheticsAPITestConfig.md +++ b/docs/v1/SyntheticsAPITestConfig.md @@ -1,6 +1,7 @@ # SyntheticsAPITestConfig Configuration object for a Synthetic API test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITestResultData.md b/docs/v1/SyntheticsAPITestResultData.md index 5af1906f9e..a7875050ee 100644 --- a/docs/v1/SyntheticsAPITestResultData.md +++ b/docs/v1/SyntheticsAPITestResultData.md @@ -1,6 +1,7 @@ # SyntheticsAPITestResultData Object containing results for your Synthetic API test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITestResultFull.md b/docs/v1/SyntheticsAPITestResultFull.md index 0608052902..624f1244b4 100644 --- a/docs/v1/SyntheticsAPITestResultFull.md +++ b/docs/v1/SyntheticsAPITestResultFull.md @@ -1,6 +1,7 @@ # SyntheticsAPITestResultFull Object returned describing a API test result. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITestResultFullCheck.md b/docs/v1/SyntheticsAPITestResultFullCheck.md index ae0db88662..d19154da18 100644 --- a/docs/v1/SyntheticsAPITestResultFullCheck.md +++ b/docs/v1/SyntheticsAPITestResultFullCheck.md @@ -1,6 +1,7 @@ # SyntheticsAPITestResultFullCheck Object describing the API test configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITestResultShort.md b/docs/v1/SyntheticsAPITestResultShort.md index b85b319f17..8d7d5da005 100644 --- a/docs/v1/SyntheticsAPITestResultShort.md +++ b/docs/v1/SyntheticsAPITestResultShort.md @@ -1,6 +1,7 @@ # SyntheticsAPITestResultShort Object with the results of a single Synthetic API test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITestResultShortResult.md b/docs/v1/SyntheticsAPITestResultShortResult.md index b60692fd9a..d8ba901094 100644 --- a/docs/v1/SyntheticsAPITestResultShortResult.md +++ b/docs/v1/SyntheticsAPITestResultShortResult.md @@ -1,6 +1,7 @@ # SyntheticsAPITestResultShortResult Result of the last API test run. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAPITestType.md b/docs/v1/SyntheticsAPITestType.md index 3332e86ce0..58afc87011 100644 --- a/docs/v1/SyntheticsAPITestType.md +++ b/docs/v1/SyntheticsAPITestType.md @@ -1,6 +1,7 @@ # SyntheticsAPITestType Type of the Synthetic test, `api`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsApi.md b/docs/v1/SyntheticsApi.md index 720cc1854a..aa440104a5 100644 --- a/docs/v1/SyntheticsApi.md +++ b/docs/v1/SyntheticsApi.md @@ -95,6 +95,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->create_global_variable: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -114,6 +115,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -183,6 +185,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->create_private_location: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -202,6 +205,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -374,6 +378,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->create_synthetics_api_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -393,6 +398,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -530,6 +536,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->create_synthetics_browser_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -549,6 +556,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -695,6 +703,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->create_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -714,6 +723,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -769,6 +779,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->delete_global_variable: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -788,6 +799,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -843,6 +855,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->delete_private_location: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -862,6 +875,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -918,6 +932,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->delete_tests: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -937,6 +952,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1012,6 +1028,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->edit_global_variable: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1032,6 +1049,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1101,6 +1119,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_api_test_latest_results: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1123,6 +1142,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1179,6 +1199,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_api_test_result: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1199,6 +1220,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1254,6 +1276,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_browser_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1273,6 +1296,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1342,6 +1366,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_browser_test_latest_results: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1364,6 +1389,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1420,6 +1446,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_browser_test_result: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1440,6 +1467,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1495,6 +1523,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_global_variable: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1514,6 +1543,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1569,6 +1599,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_private_location: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1588,6 +1619,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1642,6 +1674,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->get_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1661,6 +1694,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1715,6 +1749,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->list_locations: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -1731,6 +1766,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1783,6 +1819,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->list_tests: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -1799,6 +1836,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1896,6 +1934,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->trigger_ci_tests: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1915,6 +1954,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2087,6 +2127,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->update_api_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2107,6 +2148,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2245,6 +2287,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->update_browser_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2265,6 +2308,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2336,6 +2380,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->update_private_location: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2356,6 +2401,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2501,6 +2547,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->update_test: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2521,6 +2568,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2580,6 +2628,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SyntheticsApi->update_test_pause_status: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2600,6 +2649,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/SyntheticsAssertion.md b/docs/v1/SyntheticsAssertion.md index 12ef4143e1..b9b3217bcf 100644 --- a/docs/v1/SyntheticsAssertion.md +++ b/docs/v1/SyntheticsAssertion.md @@ -1,6 +1,7 @@ # SyntheticsAssertion Object describing the assertions type, their associated operator, which property they apply, and upon which target. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAssertionJSONPathOperator.md b/docs/v1/SyntheticsAssertionJSONPathOperator.md index 1e3c300bbd..12102d5159 100644 --- a/docs/v1/SyntheticsAssertionJSONPathOperator.md +++ b/docs/v1/SyntheticsAssertionJSONPathOperator.md @@ -1,6 +1,7 @@ # SyntheticsAssertionJSONPathOperator Assertion operator to apply. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAssertionJSONPathTarget.md b/docs/v1/SyntheticsAssertionJSONPathTarget.md index 4fe7dbc47f..bb0fc0472a 100644 --- a/docs/v1/SyntheticsAssertionJSONPathTarget.md +++ b/docs/v1/SyntheticsAssertionJSONPathTarget.md @@ -1,6 +1,7 @@ # SyntheticsAssertionJSONPathTarget An assertion for the `validatesJSONPath` operator. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md b/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md index b4ab83060c..1a3bf98da9 100644 --- a/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md +++ b/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md @@ -1,6 +1,7 @@ # SyntheticsAssertionJSONPathTargetTarget Composed target for `validatesJSONPath` operator. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAssertionOperator.md b/docs/v1/SyntheticsAssertionOperator.md index 9a58c2594a..5ccc82e926 100644 --- a/docs/v1/SyntheticsAssertionOperator.md +++ b/docs/v1/SyntheticsAssertionOperator.md @@ -1,6 +1,7 @@ # SyntheticsAssertionOperator Assertion operator to apply. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAssertionTarget.md b/docs/v1/SyntheticsAssertionTarget.md index 2f94bee287..cbe08b5c5b 100644 --- a/docs/v1/SyntheticsAssertionTarget.md +++ b/docs/v1/SyntheticsAssertionTarget.md @@ -1,6 +1,7 @@ # SyntheticsAssertionTarget An assertion which uses a simple target. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsAssertionType.md b/docs/v1/SyntheticsAssertionType.md index 138be13cb1..6d8c1b94e0 100644 --- a/docs/v1/SyntheticsAssertionType.md +++ b/docs/v1/SyntheticsAssertionType.md @@ -1,6 +1,7 @@ # SyntheticsAssertionType Type of the assertion. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBasicAuth.md b/docs/v1/SyntheticsBasicAuth.md index ac9ae21b58..222dd6b20d 100644 --- a/docs/v1/SyntheticsBasicAuth.md +++ b/docs/v1/SyntheticsBasicAuth.md @@ -1,6 +1,7 @@ # SyntheticsBasicAuth Object to handle basic authentication when performing the test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserError.md b/docs/v1/SyntheticsBrowserError.md index 64b656850f..788f77324f 100644 --- a/docs/v1/SyntheticsBrowserError.md +++ b/docs/v1/SyntheticsBrowserError.md @@ -1,6 +1,7 @@ # SyntheticsBrowserError Error response object for a browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserErrorType.md b/docs/v1/SyntheticsBrowserErrorType.md index fc15b156d6..04a63e054e 100644 --- a/docs/v1/SyntheticsBrowserErrorType.md +++ b/docs/v1/SyntheticsBrowserErrorType.md @@ -1,6 +1,7 @@ # SyntheticsBrowserErrorType Error type returned by a browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTest.md b/docs/v1/SyntheticsBrowserTest.md index 8756cb5d58..369c56d6bd 100644 --- a/docs/v1/SyntheticsBrowserTest.md +++ b/docs/v1/SyntheticsBrowserTest.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTest Object containing details about a Synthetic browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTestConfig.md b/docs/v1/SyntheticsBrowserTestConfig.md index 2fa8681fbb..9505707f8f 100644 --- a/docs/v1/SyntheticsBrowserTestConfig.md +++ b/docs/v1/SyntheticsBrowserTestConfig.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTestConfig Configuration object for a Synthetic browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTestResultData.md b/docs/v1/SyntheticsBrowserTestResultData.md index fc699ce373..62e57cc309 100644 --- a/docs/v1/SyntheticsBrowserTestResultData.md +++ b/docs/v1/SyntheticsBrowserTestResultData.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTestResultData Object containing results for your Synthetic browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTestResultFull.md b/docs/v1/SyntheticsBrowserTestResultFull.md index c1397760ab..5b95596a64 100644 --- a/docs/v1/SyntheticsBrowserTestResultFull.md +++ b/docs/v1/SyntheticsBrowserTestResultFull.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTestResultFull Object returned describing a browser test result. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTestResultFullCheck.md b/docs/v1/SyntheticsBrowserTestResultFullCheck.md index 5822e50526..6ad5cd1bc7 100644 --- a/docs/v1/SyntheticsBrowserTestResultFullCheck.md +++ b/docs/v1/SyntheticsBrowserTestResultFullCheck.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTestResultFullCheck Object describing the browser test configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTestResultShort.md b/docs/v1/SyntheticsBrowserTestResultShort.md index d30f6a91cc..335a64e1c0 100644 --- a/docs/v1/SyntheticsBrowserTestResultShort.md +++ b/docs/v1/SyntheticsBrowserTestResultShort.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTestResultShort Object with the results of a single Synthetic browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTestResultShortResult.md b/docs/v1/SyntheticsBrowserTestResultShortResult.md index 0764651195..0125d957e3 100644 --- a/docs/v1/SyntheticsBrowserTestResultShortResult.md +++ b/docs/v1/SyntheticsBrowserTestResultShortResult.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTestResultShortResult Object with the result of the last browser test run. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserTestType.md b/docs/v1/SyntheticsBrowserTestType.md index fb70b8d889..cea3a5c92b 100644 --- a/docs/v1/SyntheticsBrowserTestType.md +++ b/docs/v1/SyntheticsBrowserTestType.md @@ -1,6 +1,7 @@ # SyntheticsBrowserTestType Type of the Synthetic test, `browser`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserVariable.md b/docs/v1/SyntheticsBrowserVariable.md index fad61ee7f5..627204b7a0 100644 --- a/docs/v1/SyntheticsBrowserVariable.md +++ b/docs/v1/SyntheticsBrowserVariable.md @@ -1,6 +1,7 @@ # SyntheticsBrowserVariable Object defining a variable that can be used in your browser test. Learn more in the [Browser test Actions documentation](https://docs.datadoghq.com/synthetics/browser_tests/actions#variable). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsBrowserVariableType.md b/docs/v1/SyntheticsBrowserVariableType.md index b195b91666..d5bc54dc0c 100644 --- a/docs/v1/SyntheticsBrowserVariableType.md +++ b/docs/v1/SyntheticsBrowserVariableType.md @@ -1,6 +1,7 @@ # SyntheticsBrowserVariableType Type of browser test variable. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsCITest.md b/docs/v1/SyntheticsCITest.md index 30eaea710e..d02c15f970 100644 --- a/docs/v1/SyntheticsCITest.md +++ b/docs/v1/SyntheticsCITest.md @@ -1,6 +1,7 @@ # SyntheticsCITest Test configuration for Synthetics CI + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsCITestBody.md b/docs/v1/SyntheticsCITestBody.md index 820fa6af3a..89909331e4 100644 --- a/docs/v1/SyntheticsCITestBody.md +++ b/docs/v1/SyntheticsCITestBody.md @@ -1,6 +1,7 @@ # SyntheticsCITestBody Object describing the synthetics tests to trigger. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsCITestMetadata.md b/docs/v1/SyntheticsCITestMetadata.md index a96f503aae..9c1571b309 100644 --- a/docs/v1/SyntheticsCITestMetadata.md +++ b/docs/v1/SyntheticsCITestMetadata.md @@ -1,6 +1,7 @@ # SyntheticsCITestMetadata Metadata for the Synthetics tests run + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsCITestMetadataCi.md b/docs/v1/SyntheticsCITestMetadataCi.md index 66236cc6f1..1e96bec7f0 100644 --- a/docs/v1/SyntheticsCITestMetadataCi.md +++ b/docs/v1/SyntheticsCITestMetadataCi.md @@ -1,6 +1,7 @@ # SyntheticsCITestMetadataCi Describe CI provider. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsCITestMetadataGit.md b/docs/v1/SyntheticsCITestMetadataGit.md index 09597f5054..590d4181de 100644 --- a/docs/v1/SyntheticsCITestMetadataGit.md +++ b/docs/v1/SyntheticsCITestMetadataGit.md @@ -1,6 +1,7 @@ # SyntheticsCITestMetadataGit Git information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsCheckType.md b/docs/v1/SyntheticsCheckType.md index 06aaf4c28b..ad0072cdc1 100644 --- a/docs/v1/SyntheticsCheckType.md +++ b/docs/v1/SyntheticsCheckType.md @@ -1,6 +1,7 @@ # SyntheticsCheckType Type of assertion to apply in an API test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsConfigVariable.md b/docs/v1/SyntheticsConfigVariable.md index 2f7cff8b8f..71f85658d8 100644 --- a/docs/v1/SyntheticsConfigVariable.md +++ b/docs/v1/SyntheticsConfigVariable.md @@ -1,6 +1,7 @@ # SyntheticsConfigVariable Object defining a variable that can be used in your test configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsConfigVariableType.md b/docs/v1/SyntheticsConfigVariableType.md index cb867b416e..16d2ffa025 100644 --- a/docs/v1/SyntheticsConfigVariableType.md +++ b/docs/v1/SyntheticsConfigVariableType.md @@ -1,6 +1,7 @@ # SyntheticsConfigVariableType Type of the configuration variable. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsCoreWebVitals.md b/docs/v1/SyntheticsCoreWebVitals.md index 534e30610c..14cf24e63f 100644 --- a/docs/v1/SyntheticsCoreWebVitals.md +++ b/docs/v1/SyntheticsCoreWebVitals.md @@ -1,6 +1,7 @@ # SyntheticsCoreWebVitals Core Web Vitals attached to a browser test step. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsDeleteTestsPayload.md b/docs/v1/SyntheticsDeleteTestsPayload.md index 2673a6e475..fab53f28b7 100644 --- a/docs/v1/SyntheticsDeleteTestsPayload.md +++ b/docs/v1/SyntheticsDeleteTestsPayload.md @@ -1,6 +1,7 @@ # SyntheticsDeleteTestsPayload A JSON list of the ID or IDs of the Synthetic tests that you want to delete. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsDeleteTestsResponse.md b/docs/v1/SyntheticsDeleteTestsResponse.md index f5aab867e5..b1131d567a 100644 --- a/docs/v1/SyntheticsDeleteTestsResponse.md +++ b/docs/v1/SyntheticsDeleteTestsResponse.md @@ -1,6 +1,7 @@ # SyntheticsDeleteTestsResponse Response object for deleting Synthetic tests. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsDeletedTest.md b/docs/v1/SyntheticsDeletedTest.md index 5bad4f1ded..8b6aec3def 100644 --- a/docs/v1/SyntheticsDeletedTest.md +++ b/docs/v1/SyntheticsDeletedTest.md @@ -1,6 +1,7 @@ # SyntheticsDeletedTest Object containing a deleted Synthetic test ID with the associated deletion timestamp. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsDevice.md b/docs/v1/SyntheticsDevice.md index 778e8c4e56..cc0790376f 100644 --- a/docs/v1/SyntheticsDevice.md +++ b/docs/v1/SyntheticsDevice.md @@ -1,6 +1,7 @@ # SyntheticsDevice Object describing the device used to perform the Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsDeviceID.md b/docs/v1/SyntheticsDeviceID.md index fea55ce527..601fae53fd 100644 --- a/docs/v1/SyntheticsDeviceID.md +++ b/docs/v1/SyntheticsDeviceID.md @@ -1,6 +1,7 @@ # SyntheticsDeviceID The device ID. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsErrorCode.md b/docs/v1/SyntheticsErrorCode.md index e5e859ebc6..a302eef0d1 100644 --- a/docs/v1/SyntheticsErrorCode.md +++ b/docs/v1/SyntheticsErrorCode.md @@ -1,6 +1,7 @@ # SyntheticsErrorCode Error code that can be returned by a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md b/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md index 9d335b8f80..7a59f15ace 100644 --- a/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md +++ b/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md @@ -1,6 +1,7 @@ # SyntheticsGetAPITestLatestResultsResponse Object with the latest Synthetic API test run. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md b/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md index 4288b0997b..b4807f2571 100644 --- a/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md +++ b/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md @@ -1,6 +1,7 @@ # SyntheticsGetBrowserTestLatestResultsResponse Object with the latest Synthetic browser test run. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsGlobalVariable.md b/docs/v1/SyntheticsGlobalVariable.md index b1169d0645..b611cb75f7 100644 --- a/docs/v1/SyntheticsGlobalVariable.md +++ b/docs/v1/SyntheticsGlobalVariable.md @@ -1,6 +1,7 @@ # SyntheticsGlobalVariable Synthetics global variable. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsGlobalVariableParseTestOptions.md b/docs/v1/SyntheticsGlobalVariableParseTestOptions.md index 0186682b3c..e59e337b9b 100644 --- a/docs/v1/SyntheticsGlobalVariableParseTestOptions.md +++ b/docs/v1/SyntheticsGlobalVariableParseTestOptions.md @@ -1,6 +1,7 @@ # SyntheticsGlobalVariableParseTestOptions Parser options to use for retrieving a Synthetics global variable from a Synthetics Test. Used in conjunction with `parse_test_public_id`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md b/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md index fce00322a2..4f3684ec2e 100644 --- a/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md +++ b/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md @@ -1,6 +1,7 @@ # SyntheticsGlobalVariableParseTestOptionsType Property of the Synthetics Test Response to use for a Synthetics global variable. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsGlobalVariableParserType.md b/docs/v1/SyntheticsGlobalVariableParserType.md index ebf983b096..2386fd81f0 100644 --- a/docs/v1/SyntheticsGlobalVariableParserType.md +++ b/docs/v1/SyntheticsGlobalVariableParserType.md @@ -1,6 +1,7 @@ # SyntheticsGlobalVariableParserType Type of parser for a Synthetics global variable from a synthetics test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsGlobalVariableValue.md b/docs/v1/SyntheticsGlobalVariableValue.md index 65c12fcc43..b7a362a576 100644 --- a/docs/v1/SyntheticsGlobalVariableValue.md +++ b/docs/v1/SyntheticsGlobalVariableValue.md @@ -1,6 +1,7 @@ # SyntheticsGlobalVariableValue Value of the global variable. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsListTestsResponse.md b/docs/v1/SyntheticsListTestsResponse.md index c82590f18f..e2a4125457 100644 --- a/docs/v1/SyntheticsListTestsResponse.md +++ b/docs/v1/SyntheticsListTestsResponse.md @@ -1,6 +1,7 @@ # SyntheticsListTestsResponse Object containing an array of Synthetic tests configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsLocation.md b/docs/v1/SyntheticsLocation.md index c827f8a954..451d299301 100644 --- a/docs/v1/SyntheticsLocation.md +++ b/docs/v1/SyntheticsLocation.md @@ -1,6 +1,7 @@ # SyntheticsLocation Synthetic location that can be used when creating or editing a test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsLocations.md b/docs/v1/SyntheticsLocations.md index 3953ce7d58..14b498a89a 100644 --- a/docs/v1/SyntheticsLocations.md +++ b/docs/v1/SyntheticsLocations.md @@ -1,6 +1,7 @@ # SyntheticsLocations List of Synthetics locations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsParsingOptions.md b/docs/v1/SyntheticsParsingOptions.md index 8653e76768..5151528301 100644 --- a/docs/v1/SyntheticsParsingOptions.md +++ b/docs/v1/SyntheticsParsingOptions.md @@ -1,6 +1,7 @@ # SyntheticsParsingOptions Parsing options for variables to extract. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsPlayingTab.md b/docs/v1/SyntheticsPlayingTab.md index 740c01101d..1fdd5b2b65 100644 --- a/docs/v1/SyntheticsPlayingTab.md +++ b/docs/v1/SyntheticsPlayingTab.md @@ -1,6 +1,7 @@ # SyntheticsPlayingTab Navigate between different tabs for your browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsPrivateLocation.md b/docs/v1/SyntheticsPrivateLocation.md index ea42fcd450..2bddb04a91 100644 --- a/docs/v1/SyntheticsPrivateLocation.md +++ b/docs/v1/SyntheticsPrivateLocation.md @@ -1,6 +1,7 @@ # SyntheticsPrivateLocation Object containing information about the private location to create. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsPrivateLocationCreationResponse.md b/docs/v1/SyntheticsPrivateLocationCreationResponse.md index 720d722ef1..bdae0b575a 100644 --- a/docs/v1/SyntheticsPrivateLocationCreationResponse.md +++ b/docs/v1/SyntheticsPrivateLocationCreationResponse.md @@ -1,6 +1,7 @@ # SyntheticsPrivateLocationCreationResponse Object that contains the new private location, the public key for result encryption, and the configuration skeleton. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md b/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md index 09839d434f..ecb1f993b7 100644 --- a/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md +++ b/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md @@ -1,6 +1,7 @@ # SyntheticsPrivateLocationCreationResponseResultEncryption Public key for the result encryption. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsPrivateLocationSecrets.md b/docs/v1/SyntheticsPrivateLocationSecrets.md index 221e2caf8d..66a63079f5 100644 --- a/docs/v1/SyntheticsPrivateLocationSecrets.md +++ b/docs/v1/SyntheticsPrivateLocationSecrets.md @@ -1,6 +1,7 @@ # SyntheticsPrivateLocationSecrets Secrets for the private location. Only present in the response when creating the private location. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md b/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md index 9a286ca86f..3b7e07f1c8 100644 --- a/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md +++ b/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md @@ -1,6 +1,7 @@ # SyntheticsPrivateLocationSecretsAuthentication Authentication part of the secrets. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md b/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md index 937219f7be..ba352668a2 100644 --- a/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md +++ b/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md @@ -1,6 +1,7 @@ # SyntheticsPrivateLocationSecretsConfigDecryption Private key for the private location. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsSSLCertificate.md b/docs/v1/SyntheticsSSLCertificate.md index 3b284ac054..38d07f3219 100644 --- a/docs/v1/SyntheticsSSLCertificate.md +++ b/docs/v1/SyntheticsSSLCertificate.md @@ -1,6 +1,7 @@ # SyntheticsSSLCertificate Object describing the SSL certificate used for a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsSSLCertificateIssuer.md b/docs/v1/SyntheticsSSLCertificateIssuer.md index 0dc0f15df7..141ce83fc0 100644 --- a/docs/v1/SyntheticsSSLCertificateIssuer.md +++ b/docs/v1/SyntheticsSSLCertificateIssuer.md @@ -1,6 +1,7 @@ # SyntheticsSSLCertificateIssuer Object describing the issuer of a SSL certificate. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsSSLCertificateSubject.md b/docs/v1/SyntheticsSSLCertificateSubject.md index 85e8cf6e2c..5fbbed88bf 100644 --- a/docs/v1/SyntheticsSSLCertificateSubject.md +++ b/docs/v1/SyntheticsSSLCertificateSubject.md @@ -1,6 +1,7 @@ # SyntheticsSSLCertificateSubject Object describing the SSL certificate used for the test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsStep.md b/docs/v1/SyntheticsStep.md index 05c4fc4a2e..dcfb8740db 100644 --- a/docs/v1/SyntheticsStep.md +++ b/docs/v1/SyntheticsStep.md @@ -1,6 +1,7 @@ # SyntheticsStep The steps used in a Synthetics browser test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsStepDetail.md b/docs/v1/SyntheticsStepDetail.md index 2ba3580b1b..72f5f52441 100644 --- a/docs/v1/SyntheticsStepDetail.md +++ b/docs/v1/SyntheticsStepDetail.md @@ -1,6 +1,7 @@ # SyntheticsStepDetail Object describing a step for a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsStepDetailWarning.md b/docs/v1/SyntheticsStepDetailWarning.md index c791f658b5..0f5534624d 100644 --- a/docs/v1/SyntheticsStepDetailWarning.md +++ b/docs/v1/SyntheticsStepDetailWarning.md @@ -1,6 +1,7 @@ # SyntheticsStepDetailWarning Object collecting warnings for a given step. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsStepType.md b/docs/v1/SyntheticsStepType.md index f083d46e59..83feae5a6e 100644 --- a/docs/v1/SyntheticsStepType.md +++ b/docs/v1/SyntheticsStepType.md @@ -1,6 +1,7 @@ # SyntheticsStepType Step type used in your Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestConfig.md b/docs/v1/SyntheticsTestConfig.md index 4aa7e25703..03d3a4767d 100644 --- a/docs/v1/SyntheticsTestConfig.md +++ b/docs/v1/SyntheticsTestConfig.md @@ -1,6 +1,7 @@ # SyntheticsTestConfig Configuration object for a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestDetails.md b/docs/v1/SyntheticsTestDetails.md index 77806dd116..b77382c93d 100644 --- a/docs/v1/SyntheticsTestDetails.md +++ b/docs/v1/SyntheticsTestDetails.md @@ -1,6 +1,7 @@ # SyntheticsTestDetails Object containing details about your Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestDetailsSubType.md b/docs/v1/SyntheticsTestDetailsSubType.md index 9b2eaddf9f..0adca7025e 100644 --- a/docs/v1/SyntheticsTestDetailsSubType.md +++ b/docs/v1/SyntheticsTestDetailsSubType.md @@ -1,6 +1,7 @@ # SyntheticsTestDetailsSubType The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns` or `multi`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestDetailsType.md b/docs/v1/SyntheticsTestDetailsType.md index 6e18f79d96..051b6f9be4 100644 --- a/docs/v1/SyntheticsTestDetailsType.md +++ b/docs/v1/SyntheticsTestDetailsType.md @@ -1,6 +1,7 @@ # SyntheticsTestDetailsType Type of the Synthetic test, either `api` or `browser`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestHeaders.md b/docs/v1/SyntheticsTestHeaders.md index ef8871eac5..093e51f3ed 100644 --- a/docs/v1/SyntheticsTestHeaders.md +++ b/docs/v1/SyntheticsTestHeaders.md @@ -1,6 +1,7 @@ # SyntheticsTestHeaders Headers to include when performing the test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestMonitorStatus.md b/docs/v1/SyntheticsTestMonitorStatus.md index 7893c9dfa7..1de96cdbe8 100644 --- a/docs/v1/SyntheticsTestMonitorStatus.md +++ b/docs/v1/SyntheticsTestMonitorStatus.md @@ -1,6 +1,7 @@ # SyntheticsTestMonitorStatus The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestOptions.md b/docs/v1/SyntheticsTestOptions.md index cde16b7b87..5963490ed8 100644 --- a/docs/v1/SyntheticsTestOptions.md +++ b/docs/v1/SyntheticsTestOptions.md @@ -1,6 +1,7 @@ # SyntheticsTestOptions Object describing the extra options for a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestOptionsMonitorOptions.md b/docs/v1/SyntheticsTestOptionsMonitorOptions.md index ba385fd37d..c5a9792588 100644 --- a/docs/v1/SyntheticsTestOptionsMonitorOptions.md +++ b/docs/v1/SyntheticsTestOptionsMonitorOptions.md @@ -1,6 +1,7 @@ # SyntheticsTestOptionsMonitorOptions Object containing the options for a Synthetic test as a monitor (for example, renotification). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestOptionsRetry.md b/docs/v1/SyntheticsTestOptionsRetry.md index 7f28e7683e..33d0dd4165 100644 --- a/docs/v1/SyntheticsTestOptionsRetry.md +++ b/docs/v1/SyntheticsTestOptionsRetry.md @@ -1,6 +1,7 @@ # SyntheticsTestOptionsRetry Object describing the retry strategy to apply to a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestPauseStatus.md b/docs/v1/SyntheticsTestPauseStatus.md index 4546c6640f..74df3ac4ad 100644 --- a/docs/v1/SyntheticsTestPauseStatus.md +++ b/docs/v1/SyntheticsTestPauseStatus.md @@ -1,6 +1,7 @@ # SyntheticsTestPauseStatus Define whether you want to start (`live`) or pause (`paused`) a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestProcessStatus.md b/docs/v1/SyntheticsTestProcessStatus.md index 60324e5e52..047e4ec8ae 100644 --- a/docs/v1/SyntheticsTestProcessStatus.md +++ b/docs/v1/SyntheticsTestProcessStatus.md @@ -1,6 +1,7 @@ # SyntheticsTestProcessStatus Status of a Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestRequest.md b/docs/v1/SyntheticsTestRequest.md index ef1ab47b29..e407208ae0 100644 --- a/docs/v1/SyntheticsTestRequest.md +++ b/docs/v1/SyntheticsTestRequest.md @@ -1,6 +1,7 @@ # SyntheticsTestRequest Object describing the Synthetic test request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestRequestCertificate.md b/docs/v1/SyntheticsTestRequestCertificate.md index 8feccd4b1f..85b11ccca7 100644 --- a/docs/v1/SyntheticsTestRequestCertificate.md +++ b/docs/v1/SyntheticsTestRequestCertificate.md @@ -1,6 +1,7 @@ # SyntheticsTestRequestCertificate Client certificate to use when performing the test request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTestRequestCertificateItem.md b/docs/v1/SyntheticsTestRequestCertificateItem.md index 90f2891589..6f32248bbf 100644 --- a/docs/v1/SyntheticsTestRequestCertificateItem.md +++ b/docs/v1/SyntheticsTestRequestCertificateItem.md @@ -1,6 +1,7 @@ # SyntheticsTestRequestCertificateItem Define a request certificate. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTickInterval.md b/docs/v1/SyntheticsTickInterval.md index 50bb4a3108..9ce6da9a18 100644 --- a/docs/v1/SyntheticsTickInterval.md +++ b/docs/v1/SyntheticsTickInterval.md @@ -1,6 +1,7 @@ # SyntheticsTickInterval The frequency at which to run the Synthetic test (in seconds). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTiming.md b/docs/v1/SyntheticsTiming.md index 4dbccd3b43..6b1bcce92f 100644 --- a/docs/v1/SyntheticsTiming.md +++ b/docs/v1/SyntheticsTiming.md @@ -1,6 +1,7 @@ # SyntheticsTiming Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in [Synthetics documentation](https://docs.datadoghq.com/synthetics/#metrics). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTriggerCITestLocation.md b/docs/v1/SyntheticsTriggerCITestLocation.md index f5e290cd4f..653a5f6470 100644 --- a/docs/v1/SyntheticsTriggerCITestLocation.md +++ b/docs/v1/SyntheticsTriggerCITestLocation.md @@ -1,6 +1,7 @@ # SyntheticsTriggerCITestLocation Synthetics location. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTriggerCITestRunResult.md b/docs/v1/SyntheticsTriggerCITestRunResult.md index 70c25c730c..2231af64ec 100644 --- a/docs/v1/SyntheticsTriggerCITestRunResult.md +++ b/docs/v1/SyntheticsTriggerCITestRunResult.md @@ -1,6 +1,7 @@ # SyntheticsTriggerCITestRunResult Information about a single test run. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsTriggerCITestsResponse.md b/docs/v1/SyntheticsTriggerCITestsResponse.md index a2a1afd2ce..7037240ede 100644 --- a/docs/v1/SyntheticsTriggerCITestsResponse.md +++ b/docs/v1/SyntheticsTriggerCITestsResponse.md @@ -1,6 +1,7 @@ # SyntheticsTriggerCITestsResponse Object containing information about the tests triggered. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md b/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md index b656ae0e11..bc8bb4632a 100644 --- a/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md +++ b/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md @@ -1,6 +1,7 @@ # SyntheticsUpdateTestPauseStatusPayload Object to start or pause an existing Synthetic test. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsVariableParser.md b/docs/v1/SyntheticsVariableParser.md index d450dacf37..564ecc21ee 100644 --- a/docs/v1/SyntheticsVariableParser.md +++ b/docs/v1/SyntheticsVariableParser.md @@ -1,6 +1,7 @@ # SyntheticsVariableParser Details of the parser to use for the global variable. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/SyntheticsWarningType.md b/docs/v1/SyntheticsWarningType.md index 51ba630d6d..2055a69fca 100644 --- a/docs/v1/SyntheticsWarningType.md +++ b/docs/v1/SyntheticsWarningType.md @@ -1,6 +1,7 @@ # SyntheticsWarningType User locator used. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TableWidgetCellDisplayMode.md b/docs/v1/TableWidgetCellDisplayMode.md index 1cfcf9a1da..580632366f 100644 --- a/docs/v1/TableWidgetCellDisplayMode.md +++ b/docs/v1/TableWidgetCellDisplayMode.md @@ -1,6 +1,7 @@ # TableWidgetCellDisplayMode Define a display mode for the table cell. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TableWidgetDefinition.md b/docs/v1/TableWidgetDefinition.md index b535bae077..377568a134 100644 --- a/docs/v1/TableWidgetDefinition.md +++ b/docs/v1/TableWidgetDefinition.md @@ -1,6 +1,7 @@ # TableWidgetDefinition The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TableWidgetDefinitionType.md b/docs/v1/TableWidgetDefinitionType.md index 90f1f01a0b..ff7593a212 100644 --- a/docs/v1/TableWidgetDefinitionType.md +++ b/docs/v1/TableWidgetDefinitionType.md @@ -1,6 +1,7 @@ # TableWidgetDefinitionType Type of the table widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TableWidgetHasSearchBar.md b/docs/v1/TableWidgetHasSearchBar.md index c9406342d2..0105ec0c05 100644 --- a/docs/v1/TableWidgetHasSearchBar.md +++ b/docs/v1/TableWidgetHasSearchBar.md @@ -1,6 +1,7 @@ # TableWidgetHasSearchBar Controls the display of the search bar. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TableWidgetRequest.md b/docs/v1/TableWidgetRequest.md index eccd060b03..c7431524c3 100644 --- a/docs/v1/TableWidgetRequest.md +++ b/docs/v1/TableWidgetRequest.md @@ -1,6 +1,7 @@ # TableWidgetRequest Updated table widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TagToHosts.md b/docs/v1/TagToHosts.md index 47c0891495..43a8a19f86 100644 --- a/docs/v1/TagToHosts.md +++ b/docs/v1/TagToHosts.md @@ -1,6 +1,7 @@ # TagToHosts In this object, the key is the tag, the value is a list of host names that are reporting that tag. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TagsApi.md b/docs/v1/TagsApi.md index b58137bc22..19cecef8cc 100644 --- a/docs/v1/TagsApi.md +++ b/docs/v1/TagsApi.md @@ -73,6 +73,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling TagsApi->create_host_tags: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -94,6 +95,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -157,6 +159,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling TagsApi->delete_host_tags: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -177,6 +180,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -242,6 +246,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling TagsApi->get_host_tags: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -262,6 +267,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -318,6 +324,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling TagsApi->list_host_tags: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -337,6 +344,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -408,6 +416,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling TagsApi->update_host_tags: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -429,6 +438,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/TargetFormatType.md b/docs/v1/TargetFormatType.md index 0836e4cd6d..66940d9fda 100644 --- a/docs/v1/TargetFormatType.md +++ b/docs/v1/TargetFormatType.md @@ -1,6 +1,7 @@ # TargetFormatType If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. If the `target_type` is `tag`, this parameter may not be specified. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TimeseriesWidgetDefinition.md b/docs/v1/TimeseriesWidgetDefinition.md index cc08fd2672..f87927a894 100644 --- a/docs/v1/TimeseriesWidgetDefinition.md +++ b/docs/v1/TimeseriesWidgetDefinition.md @@ -1,6 +1,7 @@ # TimeseriesWidgetDefinition The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TimeseriesWidgetDefinitionType.md b/docs/v1/TimeseriesWidgetDefinitionType.md index 9d5e9ec5c3..59e424dd3b 100644 --- a/docs/v1/TimeseriesWidgetDefinitionType.md +++ b/docs/v1/TimeseriesWidgetDefinitionType.md @@ -1,6 +1,7 @@ # TimeseriesWidgetDefinitionType Type of the timeseries widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TimeseriesWidgetExpressionAlias.md b/docs/v1/TimeseriesWidgetExpressionAlias.md index 4a5a0ac426..3280570c51 100644 --- a/docs/v1/TimeseriesWidgetExpressionAlias.md +++ b/docs/v1/TimeseriesWidgetExpressionAlias.md @@ -1,6 +1,7 @@ # TimeseriesWidgetExpressionAlias Define an expression alias. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TimeseriesWidgetLegendColumn.md b/docs/v1/TimeseriesWidgetLegendColumn.md index 2040d84442..2877dde1cb 100644 --- a/docs/v1/TimeseriesWidgetLegendColumn.md +++ b/docs/v1/TimeseriesWidgetLegendColumn.md @@ -1,6 +1,7 @@ # TimeseriesWidgetLegendColumn Legend column. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TimeseriesWidgetLegendLayout.md b/docs/v1/TimeseriesWidgetLegendLayout.md index 14a44a4199..955494a709 100644 --- a/docs/v1/TimeseriesWidgetLegendLayout.md +++ b/docs/v1/TimeseriesWidgetLegendLayout.md @@ -1,6 +1,7 @@ # TimeseriesWidgetLegendLayout Layout of the legend. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/TimeseriesWidgetRequest.md b/docs/v1/TimeseriesWidgetRequest.md index c79417f4fc..b079e12a21 100644 --- a/docs/v1/TimeseriesWidgetRequest.md +++ b/docs/v1/TimeseriesWidgetRequest.md @@ -1,6 +1,7 @@ # TimeseriesWidgetRequest Updated timeseries widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ToplistWidgetDefinition.md b/docs/v1/ToplistWidgetDefinition.md index fa583c7aa3..9c61264973 100644 --- a/docs/v1/ToplistWidgetDefinition.md +++ b/docs/v1/ToplistWidgetDefinition.md @@ -1,6 +1,7 @@ # ToplistWidgetDefinition The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ToplistWidgetDefinitionType.md b/docs/v1/ToplistWidgetDefinitionType.md index 87f078c814..6582ed5fcf 100644 --- a/docs/v1/ToplistWidgetDefinitionType.md +++ b/docs/v1/ToplistWidgetDefinitionType.md @@ -1,6 +1,7 @@ # ToplistWidgetDefinitionType Type of the top list widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/ToplistWidgetRequest.md b/docs/v1/ToplistWidgetRequest.md index 729e0f5f97..2b9cece2a1 100644 --- a/docs/v1/ToplistWidgetRequest.md +++ b/docs/v1/ToplistWidgetRequest.md @@ -1,6 +1,7 @@ # ToplistWidgetRequest Updated top list widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAnalyzedLogsHour.md b/docs/v1/UsageAnalyzedLogsHour.md index e5f21989cf..05af0e13bb 100644 --- a/docs/v1/UsageAnalyzedLogsHour.md +++ b/docs/v1/UsageAnalyzedLogsHour.md @@ -1,6 +1,7 @@ # UsageAnalyzedLogsHour The number of analyzed logs for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAnalyzedLogsResponse.md b/docs/v1/UsageAnalyzedLogsResponse.md index dd47099582..1045561261 100644 --- a/docs/v1/UsageAnalyzedLogsResponse.md +++ b/docs/v1/UsageAnalyzedLogsResponse.md @@ -1,6 +1,7 @@ # UsageAnalyzedLogsResponse A response containing the number of analyzed logs for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionAggregates.md b/docs/v1/UsageAttributionAggregates.md index 02730a72c0..ecaf169de6 100644 --- a/docs/v1/UsageAttributionAggregates.md +++ b/docs/v1/UsageAttributionAggregates.md @@ -1,6 +1,7 @@ # UsageAttributionAggregates An array of available aggregates. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionAggregatesBody.md b/docs/v1/UsageAttributionAggregatesBody.md index fd4e7d2572..d63a430c78 100644 --- a/docs/v1/UsageAttributionAggregatesBody.md +++ b/docs/v1/UsageAttributionAggregatesBody.md @@ -1,6 +1,7 @@ # UsageAttributionAggregatesBody The object containing the aggregates. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionBody.md b/docs/v1/UsageAttributionBody.md index 3236537dec..979621a4c7 100644 --- a/docs/v1/UsageAttributionBody.md +++ b/docs/v1/UsageAttributionBody.md @@ -1,6 +1,7 @@ # UsageAttributionBody Usage Summary by tag for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionMetadata.md b/docs/v1/UsageAttributionMetadata.md index 7de54a1e9f..ef6d2b772e 100644 --- a/docs/v1/UsageAttributionMetadata.md +++ b/docs/v1/UsageAttributionMetadata.md @@ -1,6 +1,7 @@ # UsageAttributionMetadata The object containing document metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionPagination.md b/docs/v1/UsageAttributionPagination.md index 3a28933454..bdcb420a35 100644 --- a/docs/v1/UsageAttributionPagination.md +++ b/docs/v1/UsageAttributionPagination.md @@ -1,6 +1,7 @@ # UsageAttributionPagination The page count for the current pagination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionResponse.md b/docs/v1/UsageAttributionResponse.md index 9d7bb8aa64..1507b8cd5c 100644 --- a/docs/v1/UsageAttributionResponse.md +++ b/docs/v1/UsageAttributionResponse.md @@ -1,6 +1,7 @@ # UsageAttributionResponse Response containing the Usage Summary by tag(s). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionSort.md b/docs/v1/UsageAttributionSort.md index 57795ca831..e5bcf1763a 100644 --- a/docs/v1/UsageAttributionSort.md +++ b/docs/v1/UsageAttributionSort.md @@ -1,6 +1,7 @@ # UsageAttributionSort The field to sort by. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionTagNames.md b/docs/v1/UsageAttributionTagNames.md index 5b815ce44e..9e9e20fe5d 100644 --- a/docs/v1/UsageAttributionTagNames.md +++ b/docs/v1/UsageAttributionTagNames.md @@ -1,6 +1,7 @@ # UsageAttributionTagNames Usage Summary by tag name. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageAttributionValues.md b/docs/v1/UsageAttributionValues.md index bea2503dff..8e13863599 100644 --- a/docs/v1/UsageAttributionValues.md +++ b/docs/v1/UsageAttributionValues.md @@ -1,6 +1,7 @@ # UsageAttributionValues Fields in Usage Summary by tag(s). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageBillableSummaryBody.md b/docs/v1/UsageBillableSummaryBody.md index 4ba2000ac1..9b53a733a8 100644 --- a/docs/v1/UsageBillableSummaryBody.md +++ b/docs/v1/UsageBillableSummaryBody.md @@ -1,6 +1,7 @@ # UsageBillableSummaryBody Response with properties for each aggregated usage type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageBillableSummaryHour.md b/docs/v1/UsageBillableSummaryHour.md index a43626d9f5..1e0164e740 100644 --- a/docs/v1/UsageBillableSummaryHour.md +++ b/docs/v1/UsageBillableSummaryHour.md @@ -1,6 +1,7 @@ # UsageBillableSummaryHour Response with monthly summary of data billed by Datadog. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageBillableSummaryKeys.md b/docs/v1/UsageBillableSummaryKeys.md index a93119eeeb..5a2ffefbb8 100644 --- a/docs/v1/UsageBillableSummaryKeys.md +++ b/docs/v1/UsageBillableSummaryKeys.md @@ -1,6 +1,7 @@ # UsageBillableSummaryKeys Response with aggregated usage types. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageBillableSummaryResponse.md b/docs/v1/UsageBillableSummaryResponse.md index b1f6632208..2309300d81 100644 --- a/docs/v1/UsageBillableSummaryResponse.md +++ b/docs/v1/UsageBillableSummaryResponse.md @@ -1,6 +1,7 @@ # UsageBillableSummaryResponse Response with monthly summary of data billed by Datadog. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageCustomReportsAttributes.md b/docs/v1/UsageCustomReportsAttributes.md index 95d420bab1..0a56e3e9ca 100644 --- a/docs/v1/UsageCustomReportsAttributes.md +++ b/docs/v1/UsageCustomReportsAttributes.md @@ -1,6 +1,7 @@ # UsageCustomReportsAttributes The response containing attributes for custom reports. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageCustomReportsData.md b/docs/v1/UsageCustomReportsData.md index 8f7351fc69..fc53cc4b64 100644 --- a/docs/v1/UsageCustomReportsData.md +++ b/docs/v1/UsageCustomReportsData.md @@ -1,6 +1,7 @@ # UsageCustomReportsData The response containing the date and type for custom reports. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageCustomReportsMeta.md b/docs/v1/UsageCustomReportsMeta.md index 74a46b7fbd..fa970f47cf 100644 --- a/docs/v1/UsageCustomReportsMeta.md +++ b/docs/v1/UsageCustomReportsMeta.md @@ -1,6 +1,7 @@ # UsageCustomReportsMeta The object containing document metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageCustomReportsPage.md b/docs/v1/UsageCustomReportsPage.md index 5ba077a55d..be6a2ed1a6 100644 --- a/docs/v1/UsageCustomReportsPage.md +++ b/docs/v1/UsageCustomReportsPage.md @@ -1,6 +1,7 @@ # UsageCustomReportsPage The object containing page total count. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageCustomReportsResponse.md b/docs/v1/UsageCustomReportsResponse.md index 04f8682434..e931ef640e 100644 --- a/docs/v1/UsageCustomReportsResponse.md +++ b/docs/v1/UsageCustomReportsResponse.md @@ -1,6 +1,7 @@ # UsageCustomReportsResponse Response containing available custom reports. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageFargateHour.md b/docs/v1/UsageFargateHour.md index cfa50c6cba..cb69f38d0e 100644 --- a/docs/v1/UsageFargateHour.md +++ b/docs/v1/UsageFargateHour.md @@ -1,6 +1,7 @@ # UsageFargateHour Number of Fargate tasks run and hourly usage. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageFargateResponse.md b/docs/v1/UsageFargateResponse.md index 2504009cda..48a9337f6d 100644 --- a/docs/v1/UsageFargateResponse.md +++ b/docs/v1/UsageFargateResponse.md @@ -1,6 +1,7 @@ # UsageFargateResponse Response containing the number of Fargate tasks run and hourly usage. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageHostHour.md b/docs/v1/UsageHostHour.md index dc9038cf16..bc6dfd1111 100644 --- a/docs/v1/UsageHostHour.md +++ b/docs/v1/UsageHostHour.md @@ -1,6 +1,7 @@ # UsageHostHour Number of hosts/containers recorded for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageHostsResponse.md b/docs/v1/UsageHostsResponse.md index ccd9aeda77..e1ee9a015a 100644 --- a/docs/v1/UsageHostsResponse.md +++ b/docs/v1/UsageHostsResponse.md @@ -1,6 +1,7 @@ # UsageHostsResponse Host usage response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIncidentManagementHour.md b/docs/v1/UsageIncidentManagementHour.md index fcb734f794..5af55b9089 100644 --- a/docs/v1/UsageIncidentManagementHour.md +++ b/docs/v1/UsageIncidentManagementHour.md @@ -1,6 +1,7 @@ # UsageIncidentManagementHour Incident management usage for a given organization for a given hour. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIncidentManagementResponse.md b/docs/v1/UsageIncidentManagementResponse.md index 8fcc5ac7a0..1a9060b48c 100644 --- a/docs/v1/UsageIncidentManagementResponse.md +++ b/docs/v1/UsageIncidentManagementResponse.md @@ -1,6 +1,7 @@ # UsageIncidentManagementResponse Response containing the incident management usage for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIndexedSpansHour.md b/docs/v1/UsageIndexedSpansHour.md index d68c09a096..2df815aac4 100644 --- a/docs/v1/UsageIndexedSpansHour.md +++ b/docs/v1/UsageIndexedSpansHour.md @@ -1,6 +1,7 @@ # UsageIndexedSpansHour The hours of indexed spans usage. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIndexedSpansResponse.md b/docs/v1/UsageIndexedSpansResponse.md index ab6279c8a1..debf570bec 100644 --- a/docs/v1/UsageIndexedSpansResponse.md +++ b/docs/v1/UsageIndexedSpansResponse.md @@ -1,6 +1,7 @@ # UsageIndexedSpansResponse A response containing indexed spans usage. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIngestedSpansHour.md b/docs/v1/UsageIngestedSpansHour.md index 373a4d3794..bcd795c89e 100644 --- a/docs/v1/UsageIngestedSpansHour.md +++ b/docs/v1/UsageIngestedSpansHour.md @@ -1,6 +1,7 @@ # UsageIngestedSpansHour Ingested spans usage for a given organization for a given hour. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIngestedSpansResponse.md b/docs/v1/UsageIngestedSpansResponse.md index f2e3ce11f1..378dd1f15b 100644 --- a/docs/v1/UsageIngestedSpansResponse.md +++ b/docs/v1/UsageIngestedSpansResponse.md @@ -1,6 +1,7 @@ # UsageIngestedSpansResponse Response containing the ingested spans usage for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIoTHour.md b/docs/v1/UsageIoTHour.md index 94a8a27ba3..6487975fcd 100644 --- a/docs/v1/UsageIoTHour.md +++ b/docs/v1/UsageIoTHour.md @@ -1,6 +1,7 @@ # UsageIoTHour IoT usage for a given organization for a given hour. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageIoTResponse.md b/docs/v1/UsageIoTResponse.md index b571a38fae..39a0f4c4ae 100644 --- a/docs/v1/UsageIoTResponse.md +++ b/docs/v1/UsageIoTResponse.md @@ -1,6 +1,7 @@ # UsageIoTResponse Response containing the IoT usage for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageLambdaHour.md b/docs/v1/UsageLambdaHour.md index 74c569483d..662c0de9c8 100644 --- a/docs/v1/UsageLambdaHour.md +++ b/docs/v1/UsageLambdaHour.md @@ -1,6 +1,7 @@ # UsageLambdaHour Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageLambdaResponse.md b/docs/v1/UsageLambdaResponse.md index c73a204537..47717dfc41 100644 --- a/docs/v1/UsageLambdaResponse.md +++ b/docs/v1/UsageLambdaResponse.md @@ -1,6 +1,7 @@ # UsageLambdaResponse Response containing the number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageLogsByIndexHour.md b/docs/v1/UsageLogsByIndexHour.md index 20cb60e3ae..661148cb30 100644 --- a/docs/v1/UsageLogsByIndexHour.md +++ b/docs/v1/UsageLogsByIndexHour.md @@ -1,6 +1,7 @@ # UsageLogsByIndexHour Number of indexed logs for each hour and index for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageLogsByIndexResponse.md b/docs/v1/UsageLogsByIndexResponse.md index f1133aa19c..5640c0f01d 100644 --- a/docs/v1/UsageLogsByIndexResponse.md +++ b/docs/v1/UsageLogsByIndexResponse.md @@ -1,6 +1,7 @@ # UsageLogsByIndexResponse Response containing the number of indexed logs for each hour and index for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageLogsHour.md b/docs/v1/UsageLogsHour.md index e3ff5526e1..51e6e63dfd 100644 --- a/docs/v1/UsageLogsHour.md +++ b/docs/v1/UsageLogsHour.md @@ -1,6 +1,7 @@ # UsageLogsHour Hour usage for logs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageLogsResponse.md b/docs/v1/UsageLogsResponse.md index f40db8cad6..1fdc8b075e 100644 --- a/docs/v1/UsageLogsResponse.md +++ b/docs/v1/UsageLogsResponse.md @@ -1,6 +1,7 @@ # UsageLogsResponse Response containing the number of logs for each hour. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageMeteringApi.md b/docs/v1/UsageMeteringApi.md index 52072c7a7e..24cc35ede4 100644 --- a/docs/v1/UsageMeteringApi.md +++ b/docs/v1/UsageMeteringApi.md @@ -86,6 +86,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_daily_custom_reports: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -108,6 +109,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -172,6 +174,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_incident_management: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -192,6 +195,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -257,6 +261,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_ingested_spans: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -277,6 +282,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -337,6 +343,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_monthly_custom_reports: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -359,6 +366,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -414,6 +422,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_specified_daily_custom_reports: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -433,6 +442,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -489,6 +499,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_specified_monthly_custom_reports: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -508,6 +519,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -574,6 +586,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_tracing_without_limits: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -594,6 +607,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -659,6 +673,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_analyzed_logs: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -679,6 +694,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -748,6 +764,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_attribution: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -771,6 +788,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -826,6 +844,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_billable_summary: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -845,6 +864,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -910,6 +930,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_fargate: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -930,6 +951,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -995,6 +1017,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_hosts: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1015,6 +1038,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1080,6 +1104,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_indexed_spans: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1100,6 +1125,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1165,6 +1191,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_internet_of_things: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1185,6 +1212,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1250,6 +1278,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_lambda: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1270,6 +1299,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1335,6 +1365,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_logs: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1355,6 +1386,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1423,6 +1455,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_logs_by_index: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1444,6 +1477,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1509,6 +1543,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_network_flows: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1529,6 +1564,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1594,6 +1630,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_network_hosts: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1614,6 +1651,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1679,6 +1717,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_profiling: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1699,6 +1738,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1765,6 +1805,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_rum_sessions: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1786,6 +1827,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1851,6 +1893,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_snmp: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1871,6 +1914,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1937,6 +1981,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_summary: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1958,6 +2003,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2023,6 +2069,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_synthetics: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2043,6 +2090,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2108,6 +2156,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_synthetics_api: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2128,6 +2177,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2193,6 +2243,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_synthetics_browser: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2213,6 +2264,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2278,6 +2330,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_timeseries: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2298,6 +2351,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2366,6 +2420,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_top_avg_metrics: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2387,6 +2442,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -2452,6 +2508,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsageMeteringApi->get_usage_trace: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -2472,6 +2529,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/UsageMetricCategory.md b/docs/v1/UsageMetricCategory.md index 9c911e7a16..b4476aea1f 100644 --- a/docs/v1/UsageMetricCategory.md +++ b/docs/v1/UsageMetricCategory.md @@ -1,6 +1,7 @@ # UsageMetricCategory Contains the metric category. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageNetworkFlowsHour.md b/docs/v1/UsageNetworkFlowsHour.md index 15cc45d9d0..ca0b09f382 100644 --- a/docs/v1/UsageNetworkFlowsHour.md +++ b/docs/v1/UsageNetworkFlowsHour.md @@ -1,6 +1,7 @@ # UsageNetworkFlowsHour Number of netflow events indexed for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageNetworkFlowsResponse.md b/docs/v1/UsageNetworkFlowsResponse.md index 6b88d0c8a2..60af34be9d 100644 --- a/docs/v1/UsageNetworkFlowsResponse.md +++ b/docs/v1/UsageNetworkFlowsResponse.md @@ -1,6 +1,7 @@ # UsageNetworkFlowsResponse Response containing the number of netflow events indexed for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageNetworkHostsHour.md b/docs/v1/UsageNetworkHostsHour.md index a504c7e41a..65b3f02c31 100644 --- a/docs/v1/UsageNetworkHostsHour.md +++ b/docs/v1/UsageNetworkHostsHour.md @@ -1,6 +1,7 @@ # UsageNetworkHostsHour Number of active NPM hosts for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageNetworkHostsResponse.md b/docs/v1/UsageNetworkHostsResponse.md index 8aea0e044c..1b4615f74f 100644 --- a/docs/v1/UsageNetworkHostsResponse.md +++ b/docs/v1/UsageNetworkHostsResponse.md @@ -1,6 +1,7 @@ # UsageNetworkHostsResponse Response containing the number of active NPM hosts for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageProfilingHour.md b/docs/v1/UsageProfilingHour.md index 2d7350fcbe..30fd6f4040 100644 --- a/docs/v1/UsageProfilingHour.md +++ b/docs/v1/UsageProfilingHour.md @@ -1,6 +1,7 @@ # UsageProfilingHour The number of profiled hosts for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageProfilingResponse.md b/docs/v1/UsageProfilingResponse.md index 4d972716d3..23947c0e9d 100644 --- a/docs/v1/UsageProfilingResponse.md +++ b/docs/v1/UsageProfilingResponse.md @@ -1,6 +1,7 @@ # UsageProfilingResponse Response containing the number of profiled hosts for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageReportsType.md b/docs/v1/UsageReportsType.md index ada9b04008..c20bf70605 100644 --- a/docs/v1/UsageReportsType.md +++ b/docs/v1/UsageReportsType.md @@ -1,6 +1,7 @@ # UsageReportsType The type of reports. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageRumSessionsHour.md b/docs/v1/UsageRumSessionsHour.md index d6df8039b5..668a3d9fab 100644 --- a/docs/v1/UsageRumSessionsHour.md +++ b/docs/v1/UsageRumSessionsHour.md @@ -1,6 +1,7 @@ # UsageRumSessionsHour Number of RUM Sessions recorded for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageRumSessionsResponse.md b/docs/v1/UsageRumSessionsResponse.md index 64130786a3..6cbace88fc 100644 --- a/docs/v1/UsageRumSessionsResponse.md +++ b/docs/v1/UsageRumSessionsResponse.md @@ -1,6 +1,7 @@ # UsageRumSessionsResponse Response containing the number of RUM Sessions for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSNMPHour.md b/docs/v1/UsageSNMPHour.md index 7c9f3aae9c..ea653e0b1d 100644 --- a/docs/v1/UsageSNMPHour.md +++ b/docs/v1/UsageSNMPHour.md @@ -1,6 +1,7 @@ # UsageSNMPHour The number of SNMP devices for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSNMPResponse.md b/docs/v1/UsageSNMPResponse.md index 6e65a521f7..9eac0bb8b5 100644 --- a/docs/v1/UsageSNMPResponse.md +++ b/docs/v1/UsageSNMPResponse.md @@ -1,6 +1,7 @@ # UsageSNMPResponse Response containing the number of SNMP devices for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSort.md b/docs/v1/UsageSort.md index 174de460b2..83e8d72c24 100644 --- a/docs/v1/UsageSort.md +++ b/docs/v1/UsageSort.md @@ -1,6 +1,7 @@ # UsageSort The field to sort by. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSortDirection.md b/docs/v1/UsageSortDirection.md index b3a5a675a0..6145ac42c1 100644 --- a/docs/v1/UsageSortDirection.md +++ b/docs/v1/UsageSortDirection.md @@ -1,6 +1,7 @@ # UsageSortDirection The direction to sort by. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSpecifiedCustomReportsAttributes.md b/docs/v1/UsageSpecifiedCustomReportsAttributes.md index 5e665c0b80..e43e34941a 100644 --- a/docs/v1/UsageSpecifiedCustomReportsAttributes.md +++ b/docs/v1/UsageSpecifiedCustomReportsAttributes.md @@ -1,6 +1,7 @@ # UsageSpecifiedCustomReportsAttributes The response containing attributes for specified custom reports. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSpecifiedCustomReportsData.md b/docs/v1/UsageSpecifiedCustomReportsData.md index 5d89d337db..f710e0706e 100644 --- a/docs/v1/UsageSpecifiedCustomReportsData.md +++ b/docs/v1/UsageSpecifiedCustomReportsData.md @@ -1,6 +1,7 @@ # UsageSpecifiedCustomReportsData Response containing date and type for specified custom reports. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSpecifiedCustomReportsMeta.md b/docs/v1/UsageSpecifiedCustomReportsMeta.md index 2498e94035..d0f95e2c60 100644 --- a/docs/v1/UsageSpecifiedCustomReportsMeta.md +++ b/docs/v1/UsageSpecifiedCustomReportsMeta.md @@ -1,6 +1,7 @@ # UsageSpecifiedCustomReportsMeta The object containing document metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSpecifiedCustomReportsPage.md b/docs/v1/UsageSpecifiedCustomReportsPage.md index 7025bbfd87..99a260dc4e 100644 --- a/docs/v1/UsageSpecifiedCustomReportsPage.md +++ b/docs/v1/UsageSpecifiedCustomReportsPage.md @@ -1,6 +1,7 @@ # UsageSpecifiedCustomReportsPage The object containing page total count for specified ID. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSpecifiedCustomReportsResponse.md b/docs/v1/UsageSpecifiedCustomReportsResponse.md index bf60b09f03..06ea770817 100644 --- a/docs/v1/UsageSpecifiedCustomReportsResponse.md +++ b/docs/v1/UsageSpecifiedCustomReportsResponse.md @@ -1,6 +1,7 @@ # UsageSpecifiedCustomReportsResponse Returns available specified custom reports. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSummaryDate.md b/docs/v1/UsageSummaryDate.md index c3a36e61df..8aa746ed1c 100644 --- a/docs/v1/UsageSummaryDate.md +++ b/docs/v1/UsageSummaryDate.md @@ -1,6 +1,7 @@ # UsageSummaryDate Response with hourly report of all data billed by Datadog all organizations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSummaryDateOrg.md b/docs/v1/UsageSummaryDateOrg.md index a9a909d48f..e4f1dc5ff2 100644 --- a/docs/v1/UsageSummaryDateOrg.md +++ b/docs/v1/UsageSummaryDateOrg.md @@ -1,6 +1,7 @@ # UsageSummaryDateOrg Global hourly report of all data billed by Datadog for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSummaryResponse.md b/docs/v1/UsageSummaryResponse.md index 4761dda848..d1c71b014e 100644 --- a/docs/v1/UsageSummaryResponse.md +++ b/docs/v1/UsageSummaryResponse.md @@ -1,6 +1,7 @@ # UsageSummaryResponse Response with hourly report of all data billed by Datadog all organizations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSyntheticsAPIHour.md b/docs/v1/UsageSyntheticsAPIHour.md index 80c999979e..a6bc7e9886 100644 --- a/docs/v1/UsageSyntheticsAPIHour.md +++ b/docs/v1/UsageSyntheticsAPIHour.md @@ -1,6 +1,7 @@ # UsageSyntheticsAPIHour Number of Synthetics API tests run for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSyntheticsAPIResponse.md b/docs/v1/UsageSyntheticsAPIResponse.md index 62ba612fe4..65294c93ae 100644 --- a/docs/v1/UsageSyntheticsAPIResponse.md +++ b/docs/v1/UsageSyntheticsAPIResponse.md @@ -1,6 +1,7 @@ # UsageSyntheticsAPIResponse Response containing the number of Synthetics API tests run for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSyntheticsBrowserHour.md b/docs/v1/UsageSyntheticsBrowserHour.md index 49b63a32e4..f31058efef 100644 --- a/docs/v1/UsageSyntheticsBrowserHour.md +++ b/docs/v1/UsageSyntheticsBrowserHour.md @@ -1,6 +1,7 @@ # UsageSyntheticsBrowserHour Number of Synthetics Browser tests run for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSyntheticsBrowserResponse.md b/docs/v1/UsageSyntheticsBrowserResponse.md index 26365daae2..fde99d6e92 100644 --- a/docs/v1/UsageSyntheticsBrowserResponse.md +++ b/docs/v1/UsageSyntheticsBrowserResponse.md @@ -1,6 +1,7 @@ # UsageSyntheticsBrowserResponse Response containing the number of Synthetics Browser tests run for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSyntheticsHour.md b/docs/v1/UsageSyntheticsHour.md index 2266f16cf9..8b26be18f3 100644 --- a/docs/v1/UsageSyntheticsHour.md +++ b/docs/v1/UsageSyntheticsHour.md @@ -1,6 +1,7 @@ # UsageSyntheticsHour The number of synthetics tests run for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageSyntheticsResponse.md b/docs/v1/UsageSyntheticsResponse.md index 675f205fd4..e04e9ba2d6 100644 --- a/docs/v1/UsageSyntheticsResponse.md +++ b/docs/v1/UsageSyntheticsResponse.md @@ -1,6 +1,7 @@ # UsageSyntheticsResponse Response containing the number of Synthetics API tests run for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTimeseriesHour.md b/docs/v1/UsageTimeseriesHour.md index 1aab7fb3a2..1f5a4d2937 100644 --- a/docs/v1/UsageTimeseriesHour.md +++ b/docs/v1/UsageTimeseriesHour.md @@ -1,6 +1,7 @@ # UsageTimeseriesHour The hourly usage of timeseries. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTimeseriesResponse.md b/docs/v1/UsageTimeseriesResponse.md index 3f10b93013..13699d0b69 100644 --- a/docs/v1/UsageTimeseriesResponse.md +++ b/docs/v1/UsageTimeseriesResponse.md @@ -1,6 +1,7 @@ # UsageTimeseriesResponse Response containing hourly usage of timeseries. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTopAvgMetricsHour.md b/docs/v1/UsageTopAvgMetricsHour.md index 7eb0ce35b3..138626734c 100644 --- a/docs/v1/UsageTopAvgMetricsHour.md +++ b/docs/v1/UsageTopAvgMetricsHour.md @@ -1,6 +1,7 @@ # UsageTopAvgMetricsHour Number of hourly recorded custom metrics for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTopAvgMetricsResponse.md b/docs/v1/UsageTopAvgMetricsResponse.md index 1b30f94967..39f587c757 100644 --- a/docs/v1/UsageTopAvgMetricsResponse.md +++ b/docs/v1/UsageTopAvgMetricsResponse.md @@ -1,6 +1,7 @@ # UsageTopAvgMetricsResponse Response containing the number of hourly recorded custom metrics for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTraceHour.md b/docs/v1/UsageTraceHour.md index ee9bf0c89c..0ecb69c27a 100644 --- a/docs/v1/UsageTraceHour.md +++ b/docs/v1/UsageTraceHour.md @@ -1,6 +1,7 @@ # UsageTraceHour The hours of trace usage. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTraceResponse.md b/docs/v1/UsageTraceResponse.md index 052e3a7aaf..3f8521690a 100644 --- a/docs/v1/UsageTraceResponse.md +++ b/docs/v1/UsageTraceResponse.md @@ -1,6 +1,7 @@ # UsageTraceResponse A response containing trace usage. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTracingWithoutLimitsHour.md b/docs/v1/UsageTracingWithoutLimitsHour.md index f8bbe87a3d..22770fb364 100644 --- a/docs/v1/UsageTracingWithoutLimitsHour.md +++ b/docs/v1/UsageTracingWithoutLimitsHour.md @@ -1,6 +1,7 @@ # UsageTracingWithoutLimitsHour Tracing without limits usage for a given organization for a given hour. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsageTracingWithoutLimitsResponse.md b/docs/v1/UsageTracingWithoutLimitsResponse.md index 8bf1b5204c..d808b9d28d 100644 --- a/docs/v1/UsageTracingWithoutLimitsResponse.md +++ b/docs/v1/UsageTracingWithoutLimitsResponse.md @@ -1,6 +1,7 @@ # UsageTracingWithoutLimitsResponse Response containing the tracing without limits usage for each hour for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/User.md b/docs/v1/User.md index f576125586..f59aabb2d0 100644 --- a/docs/v1/User.md +++ b/docs/v1/User.md @@ -1,6 +1,7 @@ # User Create, edit, and disable users. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UserDisableResponse.md b/docs/v1/UserDisableResponse.md index b25e2b7300..6dd4ab6cec 100644 --- a/docs/v1/UserDisableResponse.md +++ b/docs/v1/UserDisableResponse.md @@ -1,6 +1,7 @@ # UserDisableResponse Array of user disabled for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UserListResponse.md b/docs/v1/UserListResponse.md index 788d8be355..bc6d5feb74 100644 --- a/docs/v1/UserListResponse.md +++ b/docs/v1/UserListResponse.md @@ -1,6 +1,7 @@ # UserListResponse Array of Datadog users for a given organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UserResponse.md b/docs/v1/UserResponse.md index aebc86a69c..9aece1b8c7 100644 --- a/docs/v1/UserResponse.md +++ b/docs/v1/UserResponse.md @@ -1,6 +1,7 @@ # UserResponse A Datadog User. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/UsersApi.md b/docs/v1/UsersApi.md index eb8b633ee5..eae95d47a3 100644 --- a/docs/v1/UsersApi.md +++ b/docs/v1/UsersApi.md @@ -65,6 +65,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->create_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -84,6 +85,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -140,6 +142,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->disable_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -159,6 +162,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -215,6 +219,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->get_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -234,6 +239,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -288,6 +294,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->list_users: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -304,6 +311,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -367,6 +375,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->update_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -387,6 +396,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v1/Widget.md b/docs/v1/Widget.md index 88b0336067..440ccbf1f0 100644 --- a/docs/v1/Widget.md +++ b/docs/v1/Widget.md @@ -1,6 +1,7 @@ # Widget Information about widget. Note: The `layout` property is required for widgets in dashboards with `free` `layout_type` only. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetAggregator.md b/docs/v1/WidgetAggregator.md index 38e623a90e..c15b836259 100644 --- a/docs/v1/WidgetAggregator.md +++ b/docs/v1/WidgetAggregator.md @@ -1,6 +1,7 @@ # WidgetAggregator Aggregator used for the request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetAxis.md b/docs/v1/WidgetAxis.md index 51c47dc81b..653e2b0e40 100644 --- a/docs/v1/WidgetAxis.md +++ b/docs/v1/WidgetAxis.md @@ -1,6 +1,7 @@ # WidgetAxis Axis controls for the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetChangeType.md b/docs/v1/WidgetChangeType.md index 543e07690c..9cd88c3263 100644 --- a/docs/v1/WidgetChangeType.md +++ b/docs/v1/WidgetChangeType.md @@ -1,6 +1,7 @@ # WidgetChangeType Show the absolute or the relative change. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetColorPreference.md b/docs/v1/WidgetColorPreference.md index 194dd0e2b4..919a9f9416 100644 --- a/docs/v1/WidgetColorPreference.md +++ b/docs/v1/WidgetColorPreference.md @@ -1,6 +1,7 @@ # WidgetColorPreference Which color to use on the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetComparator.md b/docs/v1/WidgetComparator.md index 5cc9c57029..47fbebdd7d 100644 --- a/docs/v1/WidgetComparator.md +++ b/docs/v1/WidgetComparator.md @@ -1,6 +1,7 @@ # WidgetComparator Comparator to apply. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetCompareTo.md b/docs/v1/WidgetCompareTo.md index d07e564289..ff8ba0c629 100644 --- a/docs/v1/WidgetCompareTo.md +++ b/docs/v1/WidgetCompareTo.md @@ -1,6 +1,7 @@ # WidgetCompareTo Timeframe used for the change comparison. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetConditionalFormat.md b/docs/v1/WidgetConditionalFormat.md index 2e4ae93e68..1d76f8b942 100644 --- a/docs/v1/WidgetConditionalFormat.md +++ b/docs/v1/WidgetConditionalFormat.md @@ -1,6 +1,7 @@ # WidgetConditionalFormat Define a conditional format for the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetCustomLink.md b/docs/v1/WidgetCustomLink.md index 4d1b1a8b94..b9bc75bbf1 100644 --- a/docs/v1/WidgetCustomLink.md +++ b/docs/v1/WidgetCustomLink.md @@ -1,6 +1,7 @@ # WidgetCustomLink Custom links help you connect a data value to a URL, like a Datadog page or your AWS console. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetDefinition.md b/docs/v1/WidgetDefinition.md index 46cd88b4b2..f7237ebf22 100644 --- a/docs/v1/WidgetDefinition.md +++ b/docs/v1/WidgetDefinition.md @@ -1,6 +1,7 @@ # WidgetDefinition [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetDisplayType.md b/docs/v1/WidgetDisplayType.md index 098c640eef..3cdbdaa4e5 100644 --- a/docs/v1/WidgetDisplayType.md +++ b/docs/v1/WidgetDisplayType.md @@ -1,6 +1,7 @@ # WidgetDisplayType Type of display to use for the request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetEvent.md b/docs/v1/WidgetEvent.md index e513f14036..1c4dba6f6f 100644 --- a/docs/v1/WidgetEvent.md +++ b/docs/v1/WidgetEvent.md @@ -1,6 +1,7 @@ # WidgetEvent Event overlay control options. See the dedicated [Events JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/widget_json/#events-schema) to learn how to build the ``. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetEventSize.md b/docs/v1/WidgetEventSize.md index 02ee96ef1f..6d33d5819a 100644 --- a/docs/v1/WidgetEventSize.md +++ b/docs/v1/WidgetEventSize.md @@ -1,6 +1,7 @@ # WidgetEventSize Size to use to display an event. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetFieldSort.md b/docs/v1/WidgetFieldSort.md index 02799537b0..94cb303244 100644 --- a/docs/v1/WidgetFieldSort.md +++ b/docs/v1/WidgetFieldSort.md @@ -1,6 +1,7 @@ # WidgetFieldSort Which column and order to sort by + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetFormula.md b/docs/v1/WidgetFormula.md index a1961f5b76..68fa17f5e0 100644 --- a/docs/v1/WidgetFormula.md +++ b/docs/v1/WidgetFormula.md @@ -1,6 +1,7 @@ # WidgetFormula Formula to be used in a widget query. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetFormulaLimit.md b/docs/v1/WidgetFormulaLimit.md index 35b7bca627..d101a0549f 100644 --- a/docs/v1/WidgetFormulaLimit.md +++ b/docs/v1/WidgetFormulaLimit.md @@ -1,6 +1,7 @@ # WidgetFormulaLimit Options for limiting results returned. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetGrouping.md b/docs/v1/WidgetGrouping.md index 889acb15d4..6b00a65d19 100644 --- a/docs/v1/WidgetGrouping.md +++ b/docs/v1/WidgetGrouping.md @@ -1,6 +1,7 @@ # WidgetGrouping The kind of grouping to use. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetImageSizing.md b/docs/v1/WidgetImageSizing.md index e0480a215f..bfffa3315c 100644 --- a/docs/v1/WidgetImageSizing.md +++ b/docs/v1/WidgetImageSizing.md @@ -1,6 +1,7 @@ # WidgetImageSizing How to size the image on the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetLayout.md b/docs/v1/WidgetLayout.md index 4782d433ce..7a685ef2d1 100644 --- a/docs/v1/WidgetLayout.md +++ b/docs/v1/WidgetLayout.md @@ -1,6 +1,7 @@ # WidgetLayout The layout for a widget on a free dashboard. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetLayoutType.md b/docs/v1/WidgetLayoutType.md index ec672d53e7..4b659bd6db 100644 --- a/docs/v1/WidgetLayoutType.md +++ b/docs/v1/WidgetLayoutType.md @@ -1,6 +1,7 @@ # WidgetLayoutType Layout type of the group. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetLineType.md b/docs/v1/WidgetLineType.md index 039b100924..949ce00a20 100644 --- a/docs/v1/WidgetLineType.md +++ b/docs/v1/WidgetLineType.md @@ -1,6 +1,7 @@ # WidgetLineType Type of lines displayed. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetLineWidth.md b/docs/v1/WidgetLineWidth.md index 91217fabb3..59874ec7bf 100644 --- a/docs/v1/WidgetLineWidth.md +++ b/docs/v1/WidgetLineWidth.md @@ -1,6 +1,7 @@ # WidgetLineWidth Width of line displayed. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetLiveSpan.md b/docs/v1/WidgetLiveSpan.md index e43dd2b7b8..d47dbed15d 100644 --- a/docs/v1/WidgetLiveSpan.md +++ b/docs/v1/WidgetLiveSpan.md @@ -1,6 +1,7 @@ # WidgetLiveSpan The available timeframes depend on the widget you are using. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetMargin.md b/docs/v1/WidgetMargin.md index 3f446f4867..234374f7c2 100644 --- a/docs/v1/WidgetMargin.md +++ b/docs/v1/WidgetMargin.md @@ -1,6 +1,7 @@ # WidgetMargin Size of the margins around the image. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetMarker.md b/docs/v1/WidgetMarker.md index 152f8577a7..075786f456 100644 --- a/docs/v1/WidgetMarker.md +++ b/docs/v1/WidgetMarker.md @@ -1,6 +1,7 @@ # WidgetMarker Markers allow you to add visual conditional formatting for your graphs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetMessageDisplay.md b/docs/v1/WidgetMessageDisplay.md index 9e74d5dfa4..cd5a1cc8af 100644 --- a/docs/v1/WidgetMessageDisplay.md +++ b/docs/v1/WidgetMessageDisplay.md @@ -1,6 +1,7 @@ # WidgetMessageDisplay Amount of log lines to display + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetMonitorSummaryDisplayFormat.md b/docs/v1/WidgetMonitorSummaryDisplayFormat.md index fd6d8f9135..26f0ffa744 100644 --- a/docs/v1/WidgetMonitorSummaryDisplayFormat.md +++ b/docs/v1/WidgetMonitorSummaryDisplayFormat.md @@ -1,6 +1,7 @@ # WidgetMonitorSummaryDisplayFormat What to display on the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetMonitorSummarySort.md b/docs/v1/WidgetMonitorSummarySort.md index 0c4aaecd05..b5e0096aa6 100644 --- a/docs/v1/WidgetMonitorSummarySort.md +++ b/docs/v1/WidgetMonitorSummarySort.md @@ -1,6 +1,7 @@ # WidgetMonitorSummarySort Widget sorting methods. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetNodeType.md b/docs/v1/WidgetNodeType.md index 5deac04872..c5ec7e6fdc 100644 --- a/docs/v1/WidgetNodeType.md +++ b/docs/v1/WidgetNodeType.md @@ -1,6 +1,7 @@ # WidgetNodeType Which type of node to use in the map. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetOrderBy.md b/docs/v1/WidgetOrderBy.md index fa8ffa57f2..18112e7139 100644 --- a/docs/v1/WidgetOrderBy.md +++ b/docs/v1/WidgetOrderBy.md @@ -1,6 +1,7 @@ # WidgetOrderBy What to order by. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetPalette.md b/docs/v1/WidgetPalette.md index d0cb154137..6e49a3f1d0 100644 --- a/docs/v1/WidgetPalette.md +++ b/docs/v1/WidgetPalette.md @@ -1,6 +1,7 @@ # WidgetPalette Color palette to apply. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetRequestStyle.md b/docs/v1/WidgetRequestStyle.md index 03dbfce987..bd4cf38d69 100644 --- a/docs/v1/WidgetRequestStyle.md +++ b/docs/v1/WidgetRequestStyle.md @@ -1,6 +1,7 @@ # WidgetRequestStyle Define request widget style. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetServiceSummaryDisplayFormat.md b/docs/v1/WidgetServiceSummaryDisplayFormat.md index 74ad1f0300..164f75803a 100644 --- a/docs/v1/WidgetServiceSummaryDisplayFormat.md +++ b/docs/v1/WidgetServiceSummaryDisplayFormat.md @@ -1,6 +1,7 @@ # WidgetServiceSummaryDisplayFormat Number of columns to display. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetSizeFormat.md b/docs/v1/WidgetSizeFormat.md index 2efc8d0e51..876e32ede6 100644 --- a/docs/v1/WidgetSizeFormat.md +++ b/docs/v1/WidgetSizeFormat.md @@ -1,6 +1,7 @@ # WidgetSizeFormat Size of the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetSort.md b/docs/v1/WidgetSort.md index bb8a6a597a..28d6bca389 100644 --- a/docs/v1/WidgetSort.md +++ b/docs/v1/WidgetSort.md @@ -1,6 +1,7 @@ # WidgetSort Widget sorting methods. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetStyle.md b/docs/v1/WidgetStyle.md index c8a403d5ad..ad7f58015f 100644 --- a/docs/v1/WidgetStyle.md +++ b/docs/v1/WidgetStyle.md @@ -1,6 +1,7 @@ # WidgetStyle Widget style definition. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetSummaryType.md b/docs/v1/WidgetSummaryType.md index 433f5307d6..c2e0271339 100644 --- a/docs/v1/WidgetSummaryType.md +++ b/docs/v1/WidgetSummaryType.md @@ -1,6 +1,7 @@ # WidgetSummaryType Which summary type should be used. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetTextAlign.md b/docs/v1/WidgetTextAlign.md index e2e8425bea..ea6477fac3 100644 --- a/docs/v1/WidgetTextAlign.md +++ b/docs/v1/WidgetTextAlign.md @@ -1,6 +1,7 @@ # WidgetTextAlign How to align the text on the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetTickEdge.md b/docs/v1/WidgetTickEdge.md index 254e91068f..bd549ae310 100644 --- a/docs/v1/WidgetTickEdge.md +++ b/docs/v1/WidgetTickEdge.md @@ -1,6 +1,7 @@ # WidgetTickEdge Define how you want to align the text on the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetTime.md b/docs/v1/WidgetTime.md index 74299c5cd1..1672787c57 100644 --- a/docs/v1/WidgetTime.md +++ b/docs/v1/WidgetTime.md @@ -1,6 +1,7 @@ # WidgetTime Time setting for the widget. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetTimeWindows.md b/docs/v1/WidgetTimeWindows.md index 8995c8a078..38a0a8b04d 100644 --- a/docs/v1/WidgetTimeWindows.md +++ b/docs/v1/WidgetTimeWindows.md @@ -1,6 +1,7 @@ # WidgetTimeWindows Define a time window. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetViewMode.md b/docs/v1/WidgetViewMode.md index 596af29328..48a4539737 100644 --- a/docs/v1/WidgetViewMode.md +++ b/docs/v1/WidgetViewMode.md @@ -1,6 +1,7 @@ # WidgetViewMode Define how you want the SLO to be displayed. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v1/WidgetVizType.md b/docs/v1/WidgetVizType.md index a74864ccba..1720882452 100644 --- a/docs/v1/WidgetVizType.md +++ b/docs/v1/WidgetVizType.md @@ -1,6 +1,7 @@ # WidgetVizType Whether to display the Alert Graph as a timeseries or a top list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIErrorResponse.md b/docs/v2/APIErrorResponse.md index f1f9ad9278..884da9c546 100644 --- a/docs/v2/APIErrorResponse.md +++ b/docs/v2/APIErrorResponse.md @@ -1,6 +1,7 @@ # APIErrorResponse API error response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyCreateAttributes.md b/docs/v2/APIKeyCreateAttributes.md index ce014e8b3f..43365e3ffa 100644 --- a/docs/v2/APIKeyCreateAttributes.md +++ b/docs/v2/APIKeyCreateAttributes.md @@ -1,6 +1,7 @@ # APIKeyCreateAttributes Attributes used to create an API Key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyCreateData.md b/docs/v2/APIKeyCreateData.md index f826af539d..d1d9e60fbb 100644 --- a/docs/v2/APIKeyCreateData.md +++ b/docs/v2/APIKeyCreateData.md @@ -1,6 +1,7 @@ # APIKeyCreateData Object used to create an API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyCreateRequest.md b/docs/v2/APIKeyCreateRequest.md index 37bc3954c9..9ce2b43714 100644 --- a/docs/v2/APIKeyCreateRequest.md +++ b/docs/v2/APIKeyCreateRequest.md @@ -1,6 +1,7 @@ # APIKeyCreateRequest Request used to create an API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyRelationships.md b/docs/v2/APIKeyRelationships.md index 6d265582e5..8ee83c4bf1 100644 --- a/docs/v2/APIKeyRelationships.md +++ b/docs/v2/APIKeyRelationships.md @@ -1,6 +1,7 @@ # APIKeyRelationships Resources related to the API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyResponse.md b/docs/v2/APIKeyResponse.md index 67722ea49a..9ec08f2a5a 100644 --- a/docs/v2/APIKeyResponse.md +++ b/docs/v2/APIKeyResponse.md @@ -1,6 +1,7 @@ # APIKeyResponse Response for retrieving an API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyResponseIncludedItem.md b/docs/v2/APIKeyResponseIncludedItem.md index 5d4201c849..72de1c5db9 100644 --- a/docs/v2/APIKeyResponseIncludedItem.md +++ b/docs/v2/APIKeyResponseIncludedItem.md @@ -1,6 +1,7 @@ # APIKeyResponseIncludedItem An object related to an API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyUpdateAttributes.md b/docs/v2/APIKeyUpdateAttributes.md index af4e2623fa..cbf1f566bd 100644 --- a/docs/v2/APIKeyUpdateAttributes.md +++ b/docs/v2/APIKeyUpdateAttributes.md @@ -1,6 +1,7 @@ # APIKeyUpdateAttributes Attributes used to update an API Key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyUpdateData.md b/docs/v2/APIKeyUpdateData.md index be42e61e01..f93c5c8c75 100644 --- a/docs/v2/APIKeyUpdateData.md +++ b/docs/v2/APIKeyUpdateData.md @@ -1,6 +1,7 @@ # APIKeyUpdateData Object used to update an API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeyUpdateRequest.md b/docs/v2/APIKeyUpdateRequest.md index 3792832a0d..3e91f12bcd 100644 --- a/docs/v2/APIKeyUpdateRequest.md +++ b/docs/v2/APIKeyUpdateRequest.md @@ -1,6 +1,7 @@ # APIKeyUpdateRequest Request used to update an API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeysResponse.md b/docs/v2/APIKeysResponse.md index cf80b312b4..81f9f4f42a 100644 --- a/docs/v2/APIKeysResponse.md +++ b/docs/v2/APIKeysResponse.md @@ -1,6 +1,7 @@ # APIKeysResponse Response for a list of API keys. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeysSort.md b/docs/v2/APIKeysSort.md index 9ad198010f..7b0d376a9b 100644 --- a/docs/v2/APIKeysSort.md +++ b/docs/v2/APIKeysSort.md @@ -1,6 +1,7 @@ # APIKeysSort Sorting options + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/APIKeysType.md b/docs/v2/APIKeysType.md index f6275b9a1d..654e21a9ce 100644 --- a/docs/v2/APIKeysType.md +++ b/docs/v2/APIKeysType.md @@ -1,6 +1,7 @@ # APIKeysType API Keys resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyCreateAttributes.md b/docs/v2/ApplicationKeyCreateAttributes.md index b531f9209e..1cae1917a0 100644 --- a/docs/v2/ApplicationKeyCreateAttributes.md +++ b/docs/v2/ApplicationKeyCreateAttributes.md @@ -1,6 +1,7 @@ # ApplicationKeyCreateAttributes Attributes used to create an application Key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyCreateData.md b/docs/v2/ApplicationKeyCreateData.md index c4adad1202..22621ed196 100644 --- a/docs/v2/ApplicationKeyCreateData.md +++ b/docs/v2/ApplicationKeyCreateData.md @@ -1,6 +1,7 @@ # ApplicationKeyCreateData Object used to create an application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyCreateRequest.md b/docs/v2/ApplicationKeyCreateRequest.md index 66826bd71f..56572e59d2 100644 --- a/docs/v2/ApplicationKeyCreateRequest.md +++ b/docs/v2/ApplicationKeyCreateRequest.md @@ -1,6 +1,7 @@ # ApplicationKeyCreateRequest Request used to create an application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyRelationships.md b/docs/v2/ApplicationKeyRelationships.md index a836e1d89a..99d7a03b92 100644 --- a/docs/v2/ApplicationKeyRelationships.md +++ b/docs/v2/ApplicationKeyRelationships.md @@ -1,6 +1,7 @@ # ApplicationKeyRelationships Resources related to the application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyResponse.md b/docs/v2/ApplicationKeyResponse.md index ff62248c23..44874904ba 100644 --- a/docs/v2/ApplicationKeyResponse.md +++ b/docs/v2/ApplicationKeyResponse.md @@ -1,6 +1,7 @@ # ApplicationKeyResponse Response for retrieving an application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyResponseIncludedItem.md b/docs/v2/ApplicationKeyResponseIncludedItem.md index e6c7a854ae..b91d3325a0 100644 --- a/docs/v2/ApplicationKeyResponseIncludedItem.md +++ b/docs/v2/ApplicationKeyResponseIncludedItem.md @@ -1,6 +1,7 @@ # ApplicationKeyResponseIncludedItem An object related to an application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyUpdateAttributes.md b/docs/v2/ApplicationKeyUpdateAttributes.md index 9846965d4b..a7f4bfc90c 100644 --- a/docs/v2/ApplicationKeyUpdateAttributes.md +++ b/docs/v2/ApplicationKeyUpdateAttributes.md @@ -1,6 +1,7 @@ # ApplicationKeyUpdateAttributes Attributes used to update an application Key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyUpdateData.md b/docs/v2/ApplicationKeyUpdateData.md index 1f80522c89..4682e3ba1e 100644 --- a/docs/v2/ApplicationKeyUpdateData.md +++ b/docs/v2/ApplicationKeyUpdateData.md @@ -1,6 +1,7 @@ # ApplicationKeyUpdateData Object used to update an application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeyUpdateRequest.md b/docs/v2/ApplicationKeyUpdateRequest.md index 70887d8aef..992ff32271 100644 --- a/docs/v2/ApplicationKeyUpdateRequest.md +++ b/docs/v2/ApplicationKeyUpdateRequest.md @@ -1,6 +1,7 @@ # ApplicationKeyUpdateRequest Request used to update an application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeysSort.md b/docs/v2/ApplicationKeysSort.md index 230d4756bd..724d41a765 100644 --- a/docs/v2/ApplicationKeysSort.md +++ b/docs/v2/ApplicationKeysSort.md @@ -1,6 +1,7 @@ # ApplicationKeysSort Sorting options + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ApplicationKeysType.md b/docs/v2/ApplicationKeysType.md index dda5d2202c..becc746baa 100644 --- a/docs/v2/ApplicationKeysType.md +++ b/docs/v2/ApplicationKeysType.md @@ -1,6 +1,7 @@ # ApplicationKeysType Application Keys resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/Creator.md b/docs/v2/Creator.md index 210d6874c7..d3cb8596f0 100644 --- a/docs/v2/Creator.md +++ b/docs/v2/Creator.md @@ -1,6 +1,7 @@ # Creator Creator of the object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListAddItemsRequest.md b/docs/v2/DashboardListAddItemsRequest.md index 6adb971111..b00c88323c 100644 --- a/docs/v2/DashboardListAddItemsRequest.md +++ b/docs/v2/DashboardListAddItemsRequest.md @@ -1,6 +1,7 @@ # DashboardListAddItemsRequest Request containing a list of dashboards to add. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListAddItemsResponse.md b/docs/v2/DashboardListAddItemsResponse.md index 1acf8d44ab..0f8990ef54 100644 --- a/docs/v2/DashboardListAddItemsResponse.md +++ b/docs/v2/DashboardListAddItemsResponse.md @@ -1,6 +1,7 @@ # DashboardListAddItemsResponse Response containing a list of added dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListDeleteItemsRequest.md b/docs/v2/DashboardListDeleteItemsRequest.md index bcf5eaf9c9..ec64f49619 100644 --- a/docs/v2/DashboardListDeleteItemsRequest.md +++ b/docs/v2/DashboardListDeleteItemsRequest.md @@ -1,6 +1,7 @@ # DashboardListDeleteItemsRequest Request containing a list of dashboards to delete. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListDeleteItemsResponse.md b/docs/v2/DashboardListDeleteItemsResponse.md index 0196692d6f..7553bc89cc 100644 --- a/docs/v2/DashboardListDeleteItemsResponse.md +++ b/docs/v2/DashboardListDeleteItemsResponse.md @@ -1,6 +1,7 @@ # DashboardListDeleteItemsResponse Response containing a list of deleted dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListItem.md b/docs/v2/DashboardListItem.md index 7b9ad6af38..c370c9d743 100644 --- a/docs/v2/DashboardListItem.md +++ b/docs/v2/DashboardListItem.md @@ -1,6 +1,7 @@ # DashboardListItem A dashboard within a list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListItemRequest.md b/docs/v2/DashboardListItemRequest.md index 0f5105aa01..b6aa9d0284 100644 --- a/docs/v2/DashboardListItemRequest.md +++ b/docs/v2/DashboardListItemRequest.md @@ -1,6 +1,7 @@ # DashboardListItemRequest A dashboard within a list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListItemResponse.md b/docs/v2/DashboardListItemResponse.md index 876de995ac..dcaf3e4700 100644 --- a/docs/v2/DashboardListItemResponse.md +++ b/docs/v2/DashboardListItemResponse.md @@ -1,6 +1,7 @@ # DashboardListItemResponse A dashboard within a list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListItems.md b/docs/v2/DashboardListItems.md index 2347f9a035..31258c83ac 100644 --- a/docs/v2/DashboardListItems.md +++ b/docs/v2/DashboardListItems.md @@ -1,6 +1,7 @@ # DashboardListItems Dashboards within a list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListUpdateItemsRequest.md b/docs/v2/DashboardListUpdateItemsRequest.md index f76b95f83d..a68db523d7 100644 --- a/docs/v2/DashboardListUpdateItemsRequest.md +++ b/docs/v2/DashboardListUpdateItemsRequest.md @@ -1,6 +1,7 @@ # DashboardListUpdateItemsRequest Request containing the list of dashboards to update to. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListUpdateItemsResponse.md b/docs/v2/DashboardListUpdateItemsResponse.md index 855edb3bd6..8cf8105241 100644 --- a/docs/v2/DashboardListUpdateItemsResponse.md +++ b/docs/v2/DashboardListUpdateItemsResponse.md @@ -1,6 +1,7 @@ # DashboardListUpdateItemsResponse Response containing a list of updated dashboards. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/DashboardListsApi.md b/docs/v2/DashboardListsApi.md index a621119f8f..02d43bc51b 100644 --- a/docs/v2/DashboardListsApi.md +++ b/docs/v2/DashboardListsApi.md @@ -64,6 +64,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->create_dashboard_list_items: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -84,6 +85,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -148,6 +150,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->delete_dashboard_list_items: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -168,6 +171,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -224,6 +228,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->get_dashboard_list_items: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -243,6 +248,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -306,6 +312,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling DashboardListsApi->update_dashboard_list_items: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -326,6 +333,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/DashboardType.md b/docs/v2/DashboardType.md index 7bcaa2af3f..241d61bf5d 100644 --- a/docs/v2/DashboardType.md +++ b/docs/v2/DashboardType.md @@ -1,6 +1,7 @@ # DashboardType The type of the dashboard. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/FullAPIKey.md b/docs/v2/FullAPIKey.md index 6f5d1e7314..ea86f3a823 100644 --- a/docs/v2/FullAPIKey.md +++ b/docs/v2/FullAPIKey.md @@ -1,6 +1,7 @@ # FullAPIKey Datadog API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/FullAPIKeyAttributes.md b/docs/v2/FullAPIKeyAttributes.md index e460e53b57..87c66a072f 100644 --- a/docs/v2/FullAPIKeyAttributes.md +++ b/docs/v2/FullAPIKeyAttributes.md @@ -1,6 +1,7 @@ # FullAPIKeyAttributes Attributes of a full API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/FullApplicationKey.md b/docs/v2/FullApplicationKey.md index bf719df70c..36ccd62f35 100644 --- a/docs/v2/FullApplicationKey.md +++ b/docs/v2/FullApplicationKey.md @@ -1,6 +1,7 @@ # FullApplicationKey Datadog application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/FullApplicationKeyAttributes.md b/docs/v2/FullApplicationKeyAttributes.md index 24624eadf0..79384a3e7e 100644 --- a/docs/v2/FullApplicationKeyAttributes.md +++ b/docs/v2/FullApplicationKeyAttributes.md @@ -1,6 +1,7 @@ # FullApplicationKeyAttributes Attributes of a full application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentCreateAttributes.md b/docs/v2/IncidentCreateAttributes.md index d27caa45c0..872bec0d7d 100644 --- a/docs/v2/IncidentCreateAttributes.md +++ b/docs/v2/IncidentCreateAttributes.md @@ -1,6 +1,7 @@ # IncidentCreateAttributes The incident's attributes for a create request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentCreateData.md b/docs/v2/IncidentCreateData.md index d7fe74e185..e3ac8d5844 100644 --- a/docs/v2/IncidentCreateData.md +++ b/docs/v2/IncidentCreateData.md @@ -1,6 +1,7 @@ # IncidentCreateData Incident data for a create request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentCreateRelationships.md b/docs/v2/IncidentCreateRelationships.md index 9f2a72555d..333dd0e6f8 100644 --- a/docs/v2/IncidentCreateRelationships.md +++ b/docs/v2/IncidentCreateRelationships.md @@ -1,6 +1,7 @@ # IncidentCreateRelationships The relationships the incident will have with other resources once created. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentCreateRequest.md b/docs/v2/IncidentCreateRequest.md index dabf9c8a8a..eee8f78117 100644 --- a/docs/v2/IncidentCreateRequest.md +++ b/docs/v2/IncidentCreateRequest.md @@ -1,6 +1,7 @@ # IncidentCreateRequest Create request for an incident. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentFieldAttributes.md b/docs/v2/IncidentFieldAttributes.md index ae09882500..2647af240c 100644 --- a/docs/v2/IncidentFieldAttributes.md +++ b/docs/v2/IncidentFieldAttributes.md @@ -1,6 +1,7 @@ # IncidentFieldAttributes Dynamic fields for which selections can be made, with field names as keys. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentFieldAttributesMultipleValue.md b/docs/v2/IncidentFieldAttributesMultipleValue.md index d068680e3a..19498a6768 100644 --- a/docs/v2/IncidentFieldAttributesMultipleValue.md +++ b/docs/v2/IncidentFieldAttributesMultipleValue.md @@ -1,6 +1,7 @@ # IncidentFieldAttributesMultipleValue A field with potentially multiple values selected. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentFieldAttributesSingleValue.md b/docs/v2/IncidentFieldAttributesSingleValue.md index 388cde7207..bef119b486 100644 --- a/docs/v2/IncidentFieldAttributesSingleValue.md +++ b/docs/v2/IncidentFieldAttributesSingleValue.md @@ -1,6 +1,7 @@ # IncidentFieldAttributesSingleValue A field with a single value selected. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentFieldAttributesSingleValueType.md b/docs/v2/IncidentFieldAttributesSingleValueType.md index 1b5e79af92..af06f50951 100644 --- a/docs/v2/IncidentFieldAttributesSingleValueType.md +++ b/docs/v2/IncidentFieldAttributesSingleValueType.md @@ -1,6 +1,7 @@ # IncidentFieldAttributesSingleValueType Type of the single value field definitions. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentFieldAttributesValueType.md b/docs/v2/IncidentFieldAttributesValueType.md index 3e03f9b92f..40facc43ee 100644 --- a/docs/v2/IncidentFieldAttributesValueType.md +++ b/docs/v2/IncidentFieldAttributesValueType.md @@ -1,6 +1,7 @@ # IncidentFieldAttributesValueType Type of the single value field definitions. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentIntegrationMetadataType.md b/docs/v2/IncidentIntegrationMetadataType.md index 385db4ce70..9abd278a96 100644 --- a/docs/v2/IncidentIntegrationMetadataType.md +++ b/docs/v2/IncidentIntegrationMetadataType.md @@ -1,6 +1,7 @@ # IncidentIntegrationMetadataType Integration metadata resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentPostmortemType.md b/docs/v2/IncidentPostmortemType.md index 9d7011e378..f0e4570a29 100644 --- a/docs/v2/IncidentPostmortemType.md +++ b/docs/v2/IncidentPostmortemType.md @@ -1,6 +1,7 @@ # IncidentPostmortemType Incident postmortem resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentRelatedObject.md b/docs/v2/IncidentRelatedObject.md index ba4542a4bb..b6c94bbffb 100644 --- a/docs/v2/IncidentRelatedObject.md +++ b/docs/v2/IncidentRelatedObject.md @@ -1,6 +1,7 @@ # IncidentRelatedObject Object related to an incident. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentResponse.md b/docs/v2/IncidentResponse.md index c42dc330f8..a315fed1db 100644 --- a/docs/v2/IncidentResponse.md +++ b/docs/v2/IncidentResponse.md @@ -1,6 +1,7 @@ # IncidentResponse Response with an incident. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentResponseAttributes.md b/docs/v2/IncidentResponseAttributes.md index d3e794c293..702d887e51 100644 --- a/docs/v2/IncidentResponseAttributes.md +++ b/docs/v2/IncidentResponseAttributes.md @@ -1,6 +1,7 @@ # IncidentResponseAttributes The incident's attributes from a response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentResponseData.md b/docs/v2/IncidentResponseData.md index d8f7711651..7084284b38 100644 --- a/docs/v2/IncidentResponseData.md +++ b/docs/v2/IncidentResponseData.md @@ -1,6 +1,7 @@ # IncidentResponseData Incident data from a response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentResponseIncludedItem.md b/docs/v2/IncidentResponseIncludedItem.md index 8726683fbb..737b34a424 100644 --- a/docs/v2/IncidentResponseIncludedItem.md +++ b/docs/v2/IncidentResponseIncludedItem.md @@ -1,6 +1,7 @@ # IncidentResponseIncludedItem An object related to an incident that is included in the response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentResponseRelationships.md b/docs/v2/IncidentResponseRelationships.md index 79f2fca317..3b6ebb96b0 100644 --- a/docs/v2/IncidentResponseRelationships.md +++ b/docs/v2/IncidentResponseRelationships.md @@ -1,6 +1,7 @@ # IncidentResponseRelationships The incident's relationships from a response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceCreateAttributes.md b/docs/v2/IncidentServiceCreateAttributes.md index 1d70366956..0ad20a91cb 100644 --- a/docs/v2/IncidentServiceCreateAttributes.md +++ b/docs/v2/IncidentServiceCreateAttributes.md @@ -1,6 +1,7 @@ # IncidentServiceCreateAttributes The incident service's attributes for a create request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceCreateData.md b/docs/v2/IncidentServiceCreateData.md index 0e379aff11..2573d02954 100644 --- a/docs/v2/IncidentServiceCreateData.md +++ b/docs/v2/IncidentServiceCreateData.md @@ -1,6 +1,7 @@ # IncidentServiceCreateData Incident Service payload for create requests. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceCreateRequest.md b/docs/v2/IncidentServiceCreateRequest.md index 6b248756a0..aff3bb7d02 100644 --- a/docs/v2/IncidentServiceCreateRequest.md +++ b/docs/v2/IncidentServiceCreateRequest.md @@ -1,6 +1,7 @@ # IncidentServiceCreateRequest Create request with an incident service payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceIncludedItems.md b/docs/v2/IncidentServiceIncludedItems.md index 908c1e9bd2..e929188564 100644 --- a/docs/v2/IncidentServiceIncludedItems.md +++ b/docs/v2/IncidentServiceIncludedItems.md @@ -1,6 +1,7 @@ # IncidentServiceIncludedItems An object related to an incident service which is present in the included payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceRelationships.md b/docs/v2/IncidentServiceRelationships.md index c25f098831..96368f0f79 100644 --- a/docs/v2/IncidentServiceRelationships.md +++ b/docs/v2/IncidentServiceRelationships.md @@ -1,6 +1,7 @@ # IncidentServiceRelationships The incident service's relationships. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceResponse.md b/docs/v2/IncidentServiceResponse.md index c086c2dfa0..b45f67e827 100644 --- a/docs/v2/IncidentServiceResponse.md +++ b/docs/v2/IncidentServiceResponse.md @@ -1,6 +1,7 @@ # IncidentServiceResponse Response with an incident service payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceResponseAttributes.md b/docs/v2/IncidentServiceResponseAttributes.md index f878abc6ac..63340158c7 100644 --- a/docs/v2/IncidentServiceResponseAttributes.md +++ b/docs/v2/IncidentServiceResponseAttributes.md @@ -1,6 +1,7 @@ # IncidentServiceResponseAttributes The incident service's attributes from a response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceResponseData.md b/docs/v2/IncidentServiceResponseData.md index 2556d45fa7..b87638aa32 100644 --- a/docs/v2/IncidentServiceResponseData.md +++ b/docs/v2/IncidentServiceResponseData.md @@ -1,6 +1,7 @@ # IncidentServiceResponseData Incident Service data from responses. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceType.md b/docs/v2/IncidentServiceType.md index d42b192ab2..48c4e38123 100644 --- a/docs/v2/IncidentServiceType.md +++ b/docs/v2/IncidentServiceType.md @@ -1,6 +1,7 @@ # IncidentServiceType Incident service resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceUpdateAttributes.md b/docs/v2/IncidentServiceUpdateAttributes.md index 78f82e56e2..7217a5a0f4 100644 --- a/docs/v2/IncidentServiceUpdateAttributes.md +++ b/docs/v2/IncidentServiceUpdateAttributes.md @@ -1,6 +1,7 @@ # IncidentServiceUpdateAttributes The incident service's attributes for an update request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceUpdateData.md b/docs/v2/IncidentServiceUpdateData.md index 18cd9b58f5..911e2fd413 100644 --- a/docs/v2/IncidentServiceUpdateData.md +++ b/docs/v2/IncidentServiceUpdateData.md @@ -1,6 +1,7 @@ # IncidentServiceUpdateData Incident Service payload for update requests. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServiceUpdateRequest.md b/docs/v2/IncidentServiceUpdateRequest.md index 8029a47adb..b504b4f09b 100644 --- a/docs/v2/IncidentServiceUpdateRequest.md +++ b/docs/v2/IncidentServiceUpdateRequest.md @@ -1,6 +1,7 @@ # IncidentServiceUpdateRequest Update request with an incident service payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServicesApi.md b/docs/v2/IncidentServicesApi.md index a482943ae6..36339fd245 100644 --- a/docs/v2/IncidentServicesApi.md +++ b/docs/v2/IncidentServicesApi.md @@ -79,6 +79,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentServicesApi->create_incident_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -98,6 +99,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -155,6 +157,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentServicesApi->delete_incident_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -174,6 +177,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -242,6 +246,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentServicesApi->get_incident_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -262,6 +267,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -324,6 +330,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentServicesApi->list_incident_services: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -346,6 +353,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -427,6 +435,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentServicesApi->update_incident_service: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -447,6 +456,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/IncidentServicesResponse.md b/docs/v2/IncidentServicesResponse.md index 8c4f78cbc3..c0950bdfe5 100644 --- a/docs/v2/IncidentServicesResponse.md +++ b/docs/v2/IncidentServicesResponse.md @@ -1,6 +1,7 @@ # IncidentServicesResponse Response with a list of incident service payloads. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServicesResponseMeta.md b/docs/v2/IncidentServicesResponseMeta.md index f170bc0e43..4dc5586d6c 100644 --- a/docs/v2/IncidentServicesResponseMeta.md +++ b/docs/v2/IncidentServicesResponseMeta.md @@ -1,6 +1,7 @@ # IncidentServicesResponseMeta The metadata object containing pagination metadata. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentServicesResponseMetaPagination.md b/docs/v2/IncidentServicesResponseMetaPagination.md index 6998b11d23..a4f32eb706 100644 --- a/docs/v2/IncidentServicesResponseMetaPagination.md +++ b/docs/v2/IncidentServicesResponseMetaPagination.md @@ -1,6 +1,7 @@ # IncidentServicesResponseMetaPagination Pagination properties. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamCreateAttributes.md b/docs/v2/IncidentTeamCreateAttributes.md index c9478f51e2..aa15f7aa3d 100644 --- a/docs/v2/IncidentTeamCreateAttributes.md +++ b/docs/v2/IncidentTeamCreateAttributes.md @@ -1,6 +1,7 @@ # IncidentTeamCreateAttributes The incident team's attributes for a create request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamCreateData.md b/docs/v2/IncidentTeamCreateData.md index e9c4688b39..929dfe03b2 100644 --- a/docs/v2/IncidentTeamCreateData.md +++ b/docs/v2/IncidentTeamCreateData.md @@ -1,6 +1,7 @@ # IncidentTeamCreateData Incident Team data for a create request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamCreateRequest.md b/docs/v2/IncidentTeamCreateRequest.md index 8da133ea98..0bc922e3dd 100644 --- a/docs/v2/IncidentTeamCreateRequest.md +++ b/docs/v2/IncidentTeamCreateRequest.md @@ -1,6 +1,7 @@ # IncidentTeamCreateRequest Create request with an incident team payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamIncludedItems.md b/docs/v2/IncidentTeamIncludedItems.md index 9fd34f64e2..d9feac3cac 100644 --- a/docs/v2/IncidentTeamIncludedItems.md +++ b/docs/v2/IncidentTeamIncludedItems.md @@ -1,6 +1,7 @@ # IncidentTeamIncludedItems An object related to an incident team which is present in the included payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamRelationships.md b/docs/v2/IncidentTeamRelationships.md index 0c568a21ae..f0d06eb027 100644 --- a/docs/v2/IncidentTeamRelationships.md +++ b/docs/v2/IncidentTeamRelationships.md @@ -1,6 +1,7 @@ # IncidentTeamRelationships The incident team's relationships. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamResponse.md b/docs/v2/IncidentTeamResponse.md index 6b59428ef9..09f1710d40 100644 --- a/docs/v2/IncidentTeamResponse.md +++ b/docs/v2/IncidentTeamResponse.md @@ -1,6 +1,7 @@ # IncidentTeamResponse Response with an incident team payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamResponseAttributes.md b/docs/v2/IncidentTeamResponseAttributes.md index f77843f863..9dbd7ba162 100644 --- a/docs/v2/IncidentTeamResponseAttributes.md +++ b/docs/v2/IncidentTeamResponseAttributes.md @@ -1,6 +1,7 @@ # IncidentTeamResponseAttributes The incident team's attributes from a response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamResponseData.md b/docs/v2/IncidentTeamResponseData.md index b41c5ddc5a..e87e1f3751 100644 --- a/docs/v2/IncidentTeamResponseData.md +++ b/docs/v2/IncidentTeamResponseData.md @@ -1,6 +1,7 @@ # IncidentTeamResponseData Incident Team data from a response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamType.md b/docs/v2/IncidentTeamType.md index f41b0b3944..be9a80a715 100644 --- a/docs/v2/IncidentTeamType.md +++ b/docs/v2/IncidentTeamType.md @@ -1,6 +1,7 @@ # IncidentTeamType Incident Team resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamUpdateAttributes.md b/docs/v2/IncidentTeamUpdateAttributes.md index fa76191b73..3ad16a2a8c 100644 --- a/docs/v2/IncidentTeamUpdateAttributes.md +++ b/docs/v2/IncidentTeamUpdateAttributes.md @@ -1,6 +1,7 @@ # IncidentTeamUpdateAttributes The incident team's attributes for an update request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamUpdateData.md b/docs/v2/IncidentTeamUpdateData.md index 18898020fc..5672d6521e 100644 --- a/docs/v2/IncidentTeamUpdateData.md +++ b/docs/v2/IncidentTeamUpdateData.md @@ -1,6 +1,7 @@ # IncidentTeamUpdateData Incident Team data for an update request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamUpdateRequest.md b/docs/v2/IncidentTeamUpdateRequest.md index e914f42346..84ba704f10 100644 --- a/docs/v2/IncidentTeamUpdateRequest.md +++ b/docs/v2/IncidentTeamUpdateRequest.md @@ -1,6 +1,7 @@ # IncidentTeamUpdateRequest Update request with an incident team payload. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTeamsApi.md b/docs/v2/IncidentTeamsApi.md index 4ae9a356d9..31c6b09cf7 100644 --- a/docs/v2/IncidentTeamsApi.md +++ b/docs/v2/IncidentTeamsApi.md @@ -79,6 +79,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentTeamsApi->create_incident_team: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -98,6 +99,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -155,6 +157,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentTeamsApi->delete_incident_team: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -174,6 +177,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -242,6 +246,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentTeamsApi->get_incident_team: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -262,6 +267,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -324,6 +330,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentTeamsApi->list_incident_teams: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -346,6 +353,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -427,6 +435,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentTeamsApi->update_incident_team: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -447,6 +456,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/IncidentTeamsResponse.md b/docs/v2/IncidentTeamsResponse.md index 77b5554db7..9c5601e7cb 100644 --- a/docs/v2/IncidentTeamsResponse.md +++ b/docs/v2/IncidentTeamsResponse.md @@ -1,6 +1,7 @@ # IncidentTeamsResponse Response with a list of incident team payloads. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTimelineCellCreateAttributes.md b/docs/v2/IncidentTimelineCellCreateAttributes.md index 3e48367654..e04cc4f95f 100644 --- a/docs/v2/IncidentTimelineCellCreateAttributes.md +++ b/docs/v2/IncidentTimelineCellCreateAttributes.md @@ -1,6 +1,7 @@ # IncidentTimelineCellCreateAttributes The timeline cell's attributes for a create request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTimelineCellMarkdownContentType.md b/docs/v2/IncidentTimelineCellMarkdownContentType.md index 5b6a139650..774c096476 100644 --- a/docs/v2/IncidentTimelineCellMarkdownContentType.md +++ b/docs/v2/IncidentTimelineCellMarkdownContentType.md @@ -1,6 +1,7 @@ # IncidentTimelineCellMarkdownContentType Type of the Markdown timeline cell. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md b/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md index 0a6706815e..f5b736f2c8 100644 --- a/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md +++ b/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md @@ -1,6 +1,7 @@ # IncidentTimelineCellMarkdownCreateAttributes Timeline cell data for Markdown timeline cells for a create request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md b/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md index 97d3335e98..f3dc7ee146 100644 --- a/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md +++ b/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md @@ -1,6 +1,7 @@ # IncidentTimelineCellMarkdownCreateAttributesContent The Markdown timeline cell contents. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentType.md b/docs/v2/IncidentType.md index 15a46c3c70..8efc21f6b5 100644 --- a/docs/v2/IncidentType.md +++ b/docs/v2/IncidentType.md @@ -1,6 +1,7 @@ # IncidentType Incident resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentUpdateAttributes.md b/docs/v2/IncidentUpdateAttributes.md index 7ed4f5149a..4a2deb7629 100644 --- a/docs/v2/IncidentUpdateAttributes.md +++ b/docs/v2/IncidentUpdateAttributes.md @@ -1,6 +1,7 @@ # IncidentUpdateAttributes The incident's attributes for an update request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentUpdateData.md b/docs/v2/IncidentUpdateData.md index 43e358d311..7294187938 100644 --- a/docs/v2/IncidentUpdateData.md +++ b/docs/v2/IncidentUpdateData.md @@ -1,6 +1,7 @@ # IncidentUpdateData Incident data for an update request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentUpdateRelationships.md b/docs/v2/IncidentUpdateRelationships.md index d5a3d96b61..845eebb76b 100644 --- a/docs/v2/IncidentUpdateRelationships.md +++ b/docs/v2/IncidentUpdateRelationships.md @@ -1,6 +1,7 @@ # IncidentUpdateRelationships The incident's relationships for an update request. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentUpdateRequest.md b/docs/v2/IncidentUpdateRequest.md index eb1c528e60..f8eab93199 100644 --- a/docs/v2/IncidentUpdateRequest.md +++ b/docs/v2/IncidentUpdateRequest.md @@ -1,6 +1,7 @@ # IncidentUpdateRequest Update request for an incident. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/IncidentsApi.md b/docs/v2/IncidentsApi.md index 2c564190a6..0babcece46 100644 --- a/docs/v2/IncidentsApi.md +++ b/docs/v2/IncidentsApi.md @@ -83,6 +83,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentsApi->create_incident: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -102,6 +103,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -159,6 +161,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentsApi->delete_incident: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -178,6 +181,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -248,6 +252,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentsApi->get_incident: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -268,6 +273,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -331,6 +337,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentsApi->list_incidents: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -352,6 +359,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -460,6 +468,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling IncidentsApi->update_incident: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -480,6 +489,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/IncidentsResponse.md b/docs/v2/IncidentsResponse.md index 8b21b70c43..e1a15628a1 100644 --- a/docs/v2/IncidentsResponse.md +++ b/docs/v2/IncidentsResponse.md @@ -1,6 +1,7 @@ # IncidentsResponse Response with a list of incidents. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/KeyManagementApi.md b/docs/v2/KeyManagementApi.md index ede953c2b5..6e728ec22d 100644 --- a/docs/v2/KeyManagementApi.md +++ b/docs/v2/KeyManagementApi.md @@ -72,6 +72,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->create_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -91,6 +92,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -153,6 +155,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->create_current_user_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -172,6 +175,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -226,6 +230,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->delete_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -245,6 +250,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -299,6 +305,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->delete_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -318,6 +325,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -372,6 +380,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->delete_current_user_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -391,6 +400,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -456,6 +466,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->get_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -476,6 +487,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -531,6 +543,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->get_current_user_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -550,6 +563,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -614,6 +628,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->list_api_keys: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -641,6 +656,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -702,6 +718,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->list_application_keys: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -726,6 +743,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -788,6 +806,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->list_current_user_application_keys: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -812,6 +831,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -877,6 +897,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->update_api_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -897,6 +918,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -962,6 +984,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->update_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -982,6 +1005,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -1047,6 +1071,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling KeyManagementApi->update_current_user_application_key: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -1067,6 +1092,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/ListApplicationKeysResponse.md b/docs/v2/ListApplicationKeysResponse.md index f1b2329016..22b5eb2055 100644 --- a/docs/v2/ListApplicationKeysResponse.md +++ b/docs/v2/ListApplicationKeysResponse.md @@ -1,6 +1,7 @@ # ListApplicationKeysResponse Response for a list of application keys. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/Log.md b/docs/v2/Log.md index b7664dc030..ed4c47d38c 100644 --- a/docs/v2/Log.md +++ b/docs/v2/Log.md @@ -1,6 +1,7 @@ # Log Object description of a log after being processed and stored by Datadog. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogAttributes.md b/docs/v2/LogAttributes.md index 34ac52b393..9ecb2300d4 100644 --- a/docs/v2/LogAttributes.md +++ b/docs/v2/LogAttributes.md @@ -1,6 +1,7 @@ # LogAttributes JSON object containing all log attributes and their associated values. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogType.md b/docs/v2/LogType.md index 893f157b7c..f5c4f68213 100644 --- a/docs/v2/LogType.md +++ b/docs/v2/LogType.md @@ -1,6 +1,7 @@ # LogType Type of the event. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateBucket.md b/docs/v2/LogsAggregateBucket.md index ef07cdab0a..ea7b3416d0 100644 --- a/docs/v2/LogsAggregateBucket.md +++ b/docs/v2/LogsAggregateBucket.md @@ -1,6 +1,7 @@ # LogsAggregateBucket A bucket values + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateBucketValue.md b/docs/v2/LogsAggregateBucketValue.md index 616b313fed..1216bf2f84 100644 --- a/docs/v2/LogsAggregateBucketValue.md +++ b/docs/v2/LogsAggregateBucketValue.md @@ -1,6 +1,7 @@ # LogsAggregateBucketValue A bucket value, can be either a timeseries or a single value + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateBucketValueTimeseries.md b/docs/v2/LogsAggregateBucketValueTimeseries.md index 9833f436cd..1095f76895 100644 --- a/docs/v2/LogsAggregateBucketValueTimeseries.md +++ b/docs/v2/LogsAggregateBucketValueTimeseries.md @@ -1,6 +1,7 @@ # LogsAggregateBucketValueTimeseries A timeseries array + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md b/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md index 7ab2894b20..9b99fb9b43 100644 --- a/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md +++ b/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md @@ -1,6 +1,7 @@ # LogsAggregateBucketValueTimeseriesPoint A timeseries point + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateRequest.md b/docs/v2/LogsAggregateRequest.md index 8ba87aa524..3e24ab6063 100644 --- a/docs/v2/LogsAggregateRequest.md +++ b/docs/v2/LogsAggregateRequest.md @@ -1,6 +1,7 @@ # LogsAggregateRequest The object sent with the request to retrieve a list of logs from your organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateRequestPage.md b/docs/v2/LogsAggregateRequestPage.md index 1a464c4645..7aee59a5e5 100644 --- a/docs/v2/LogsAggregateRequestPage.md +++ b/docs/v2/LogsAggregateRequestPage.md @@ -1,6 +1,7 @@ # LogsAggregateRequestPage Paging settings + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateResponse.md b/docs/v2/LogsAggregateResponse.md index 8ae7115003..116d5997c9 100644 --- a/docs/v2/LogsAggregateResponse.md +++ b/docs/v2/LogsAggregateResponse.md @@ -1,6 +1,7 @@ # LogsAggregateResponse The response object for the logs aggregate API endpoint + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateResponseData.md b/docs/v2/LogsAggregateResponseData.md index 0071e95733..549dd3b2bd 100644 --- a/docs/v2/LogsAggregateResponseData.md +++ b/docs/v2/LogsAggregateResponseData.md @@ -1,6 +1,7 @@ # LogsAggregateResponseData The query results + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateResponseStatus.md b/docs/v2/LogsAggregateResponseStatus.md index 8fce246ae1..ba40980463 100644 --- a/docs/v2/LogsAggregateResponseStatus.md +++ b/docs/v2/LogsAggregateResponseStatus.md @@ -1,6 +1,7 @@ # LogsAggregateResponseStatus The status of the response + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateSort.md b/docs/v2/LogsAggregateSort.md index af02fbaefa..cca2b352ea 100644 --- a/docs/v2/LogsAggregateSort.md +++ b/docs/v2/LogsAggregateSort.md @@ -1,6 +1,7 @@ # LogsAggregateSort A sort rule + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregateSortType.md b/docs/v2/LogsAggregateSortType.md index 97fd94dd4d..04efb36fe9 100644 --- a/docs/v2/LogsAggregateSortType.md +++ b/docs/v2/LogsAggregateSortType.md @@ -1,6 +1,7 @@ # LogsAggregateSortType The type of sorting algorithm + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsAggregationFunction.md b/docs/v2/LogsAggregationFunction.md index 2b6dd29ebf..41cca5594f 100644 --- a/docs/v2/LogsAggregationFunction.md +++ b/docs/v2/LogsAggregationFunction.md @@ -1,6 +1,7 @@ # LogsAggregationFunction An aggregation function + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsApi.md b/docs/v2/LogsApi.md index ec6e91fc68..0414d03da5 100644 --- a/docs/v2/LogsApi.md +++ b/docs/v2/LogsApi.md @@ -96,6 +96,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsApi->aggregate_logs: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -115,6 +116,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -187,6 +189,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsApi->list_logs: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -206,6 +209,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -268,6 +272,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsApi->list_logs_get: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -293,6 +298,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/LogsArchive.md b/docs/v2/LogsArchive.md index 83dadee3d6..6f71e86922 100644 --- a/docs/v2/LogsArchive.md +++ b/docs/v2/LogsArchive.md @@ -1,6 +1,7 @@ # LogsArchive The logs archive. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveAttributes.md b/docs/v2/LogsArchiveAttributes.md index e1a385a6ac..408901489c 100644 --- a/docs/v2/LogsArchiveAttributes.md +++ b/docs/v2/LogsArchiveAttributes.md @@ -1,6 +1,7 @@ # LogsArchiveAttributes The attributes associated with the archive. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveCreateRequest.md b/docs/v2/LogsArchiveCreateRequest.md index f60aa5e6ba..84a199cfe0 100644 --- a/docs/v2/LogsArchiveCreateRequest.md +++ b/docs/v2/LogsArchiveCreateRequest.md @@ -1,6 +1,7 @@ # LogsArchiveCreateRequest The logs archive. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveCreateRequestAttributes.md b/docs/v2/LogsArchiveCreateRequestAttributes.md index 4d8df7a85d..26654b2b6e 100644 --- a/docs/v2/LogsArchiveCreateRequestAttributes.md +++ b/docs/v2/LogsArchiveCreateRequestAttributes.md @@ -1,6 +1,7 @@ # LogsArchiveCreateRequestAttributes The attributes associated with the archive. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveCreateRequestDefinition.md b/docs/v2/LogsArchiveCreateRequestDefinition.md index ca21f7c6c7..bea71231f6 100644 --- a/docs/v2/LogsArchiveCreateRequestDefinition.md +++ b/docs/v2/LogsArchiveCreateRequestDefinition.md @@ -1,6 +1,7 @@ # LogsArchiveCreateRequestDefinition The definition of an archive. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveCreateRequestDestination.md b/docs/v2/LogsArchiveCreateRequestDestination.md index b241c557d1..2a70532cf6 100644 --- a/docs/v2/LogsArchiveCreateRequestDestination.md +++ b/docs/v2/LogsArchiveCreateRequestDestination.md @@ -1,6 +1,7 @@ # LogsArchiveCreateRequestDestination An archive's destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDefinition.md b/docs/v2/LogsArchiveDefinition.md index b2ac1f80fc..dd1d5d3e36 100644 --- a/docs/v2/LogsArchiveDefinition.md +++ b/docs/v2/LogsArchiveDefinition.md @@ -1,6 +1,7 @@ # LogsArchiveDefinition The definition of an archive. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDestination.md b/docs/v2/LogsArchiveDestination.md index 7777a630bc..7631b84fce 100644 --- a/docs/v2/LogsArchiveDestination.md +++ b/docs/v2/LogsArchiveDestination.md @@ -1,6 +1,7 @@ # LogsArchiveDestination An archive's destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDestinationAzure.md b/docs/v2/LogsArchiveDestinationAzure.md index fc8a621219..3d1835ca29 100644 --- a/docs/v2/LogsArchiveDestinationAzure.md +++ b/docs/v2/LogsArchiveDestinationAzure.md @@ -1,6 +1,7 @@ # LogsArchiveDestinationAzure The Azure archive destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDestinationAzureType.md b/docs/v2/LogsArchiveDestinationAzureType.md index 103cfc1cf1..9ad8de780f 100644 --- a/docs/v2/LogsArchiveDestinationAzureType.md +++ b/docs/v2/LogsArchiveDestinationAzureType.md @@ -1,6 +1,7 @@ # LogsArchiveDestinationAzureType Type of the Azure archive destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDestinationGCS.md b/docs/v2/LogsArchiveDestinationGCS.md index 9d9c43256d..8445ffc388 100644 --- a/docs/v2/LogsArchiveDestinationGCS.md +++ b/docs/v2/LogsArchiveDestinationGCS.md @@ -1,6 +1,7 @@ # LogsArchiveDestinationGCS The GCS archive destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDestinationGCSType.md b/docs/v2/LogsArchiveDestinationGCSType.md index 3d0fcef9f1..4e407f9b91 100644 --- a/docs/v2/LogsArchiveDestinationGCSType.md +++ b/docs/v2/LogsArchiveDestinationGCSType.md @@ -1,6 +1,7 @@ # LogsArchiveDestinationGCSType Type of the GCS archive destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDestinationS3.md b/docs/v2/LogsArchiveDestinationS3.md index 35f720a6f7..7c196afd4d 100644 --- a/docs/v2/LogsArchiveDestinationS3.md +++ b/docs/v2/LogsArchiveDestinationS3.md @@ -1,6 +1,7 @@ # LogsArchiveDestinationS3 The S3 archive destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveDestinationS3Type.md b/docs/v2/LogsArchiveDestinationS3Type.md index c1c900318e..3921b20e52 100644 --- a/docs/v2/LogsArchiveDestinationS3Type.md +++ b/docs/v2/LogsArchiveDestinationS3Type.md @@ -1,6 +1,7 @@ # LogsArchiveDestinationS3Type Type of the S3 archive destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveIntegrationAzure.md b/docs/v2/LogsArchiveIntegrationAzure.md index 4ae0bf3fbf..fd262b5405 100644 --- a/docs/v2/LogsArchiveIntegrationAzure.md +++ b/docs/v2/LogsArchiveIntegrationAzure.md @@ -1,6 +1,7 @@ # LogsArchiveIntegrationAzure The Azure archive's integration destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveIntegrationGCS.md b/docs/v2/LogsArchiveIntegrationGCS.md index 2a1389eaec..0e197d72d6 100644 --- a/docs/v2/LogsArchiveIntegrationGCS.md +++ b/docs/v2/LogsArchiveIntegrationGCS.md @@ -1,6 +1,7 @@ # LogsArchiveIntegrationGCS The GCS archive's integration destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveIntegrationS3.md b/docs/v2/LogsArchiveIntegrationS3.md index 1ff583ca31..8eb69695d6 100644 --- a/docs/v2/LogsArchiveIntegrationS3.md +++ b/docs/v2/LogsArchiveIntegrationS3.md @@ -1,6 +1,7 @@ # LogsArchiveIntegrationS3 The S3 Archive's integration destination. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveOrder.md b/docs/v2/LogsArchiveOrder.md index 23e3e7080e..7b55b1402f 100644 --- a/docs/v2/LogsArchiveOrder.md +++ b/docs/v2/LogsArchiveOrder.md @@ -1,6 +1,7 @@ # LogsArchiveOrder A ordered list of archive IDs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveOrderAttributes.md b/docs/v2/LogsArchiveOrderAttributes.md index 17b39242e8..ff119a4a92 100644 --- a/docs/v2/LogsArchiveOrderAttributes.md +++ b/docs/v2/LogsArchiveOrderAttributes.md @@ -1,6 +1,7 @@ # LogsArchiveOrderAttributes The attributes associated with the archive order. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveOrderDefinition.md b/docs/v2/LogsArchiveOrderDefinition.md index e7e90b9829..191106e2a8 100644 --- a/docs/v2/LogsArchiveOrderDefinition.md +++ b/docs/v2/LogsArchiveOrderDefinition.md @@ -1,6 +1,7 @@ # LogsArchiveOrderDefinition The definition of an archive order. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveOrderDefinitionType.md b/docs/v2/LogsArchiveOrderDefinitionType.md index 2d17dd1877..e8eb465233 100644 --- a/docs/v2/LogsArchiveOrderDefinitionType.md +++ b/docs/v2/LogsArchiveOrderDefinitionType.md @@ -1,6 +1,7 @@ # LogsArchiveOrderDefinitionType Type of the archive order definition. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchiveState.md b/docs/v2/LogsArchiveState.md index ec1e5eaa36..52f7f350f1 100644 --- a/docs/v2/LogsArchiveState.md +++ b/docs/v2/LogsArchiveState.md @@ -1,6 +1,7 @@ # LogsArchiveState The state of the archive. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchives.md b/docs/v2/LogsArchives.md index c82c02c0bd..9909bd74c5 100644 --- a/docs/v2/LogsArchives.md +++ b/docs/v2/LogsArchives.md @@ -1,6 +1,7 @@ # LogsArchives The available archives. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsArchivesApi.md b/docs/v2/LogsArchivesApi.md index 3e8b8d74a8..9dc73c3db5 100644 --- a/docs/v2/LogsArchivesApi.md +++ b/docs/v2/LogsArchivesApi.md @@ -67,6 +67,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->add_read_role_to_archive: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -87,6 +88,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -154,6 +156,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->create_logs_archive: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -173,6 +176,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -227,6 +231,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->delete_logs_archive: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -246,6 +251,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -302,6 +308,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->get_logs_archive: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -321,6 +328,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -376,6 +384,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->get_logs_archive_order: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -392,6 +401,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -446,6 +456,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->list_archive_read_roles: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -465,6 +476,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -520,6 +532,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->list_logs_archives: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -536,6 +549,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -595,6 +609,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->remove_role_from_archive: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -615,6 +630,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -683,6 +699,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->update_logs_archive: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -703,6 +720,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -766,6 +784,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsArchivesApi->update_logs_archive_order: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -785,6 +804,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/LogsCompute.md b/docs/v2/LogsCompute.md index 7bc1cd04ba..891b958017 100644 --- a/docs/v2/LogsCompute.md +++ b/docs/v2/LogsCompute.md @@ -1,6 +1,7 @@ # LogsCompute A compute rule to compute metrics or timeseries + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsComputeType.md b/docs/v2/LogsComputeType.md index 92464a5213..1ed39702fc 100644 --- a/docs/v2/LogsComputeType.md +++ b/docs/v2/LogsComputeType.md @@ -1,6 +1,7 @@ # LogsComputeType The type of compute + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsGroupBy.md b/docs/v2/LogsGroupBy.md index fb267e9eb1..0b9e84283a 100644 --- a/docs/v2/LogsGroupBy.md +++ b/docs/v2/LogsGroupBy.md @@ -1,6 +1,7 @@ # LogsGroupBy A group by rule + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsGroupByHistogram.md b/docs/v2/LogsGroupByHistogram.md index 5f46c6f609..805c97c912 100644 --- a/docs/v2/LogsGroupByHistogram.md +++ b/docs/v2/LogsGroupByHistogram.md @@ -1,6 +1,7 @@ # LogsGroupByHistogram Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsGroupByMissing.md b/docs/v2/LogsGroupByMissing.md index dd840f4b2e..02f5348c9a 100644 --- a/docs/v2/LogsGroupByMissing.md +++ b/docs/v2/LogsGroupByMissing.md @@ -1,6 +1,7 @@ # LogsGroupByMissing The value to use for logs that don't have the facet used to group by + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsGroupByTotal.md b/docs/v2/LogsGroupByTotal.md index 8b7abe16df..2e799ac261 100644 --- a/docs/v2/LogsGroupByTotal.md +++ b/docs/v2/LogsGroupByTotal.md @@ -1,6 +1,7 @@ # LogsGroupByTotal A resulting object to put the given computes in over all the matching records. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsListRequest.md b/docs/v2/LogsListRequest.md index 30bdb4b2fe..cd5e816bbf 100644 --- a/docs/v2/LogsListRequest.md +++ b/docs/v2/LogsListRequest.md @@ -1,6 +1,7 @@ # LogsListRequest The request for a logs list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsListRequestPage.md b/docs/v2/LogsListRequestPage.md index 6861f49bd0..5319446f7f 100644 --- a/docs/v2/LogsListRequestPage.md +++ b/docs/v2/LogsListRequestPage.md @@ -1,6 +1,7 @@ # LogsListRequestPage Paging attributes for listing logs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsListResponse.md b/docs/v2/LogsListResponse.md index f37f9e18a5..288828237f 100644 --- a/docs/v2/LogsListResponse.md +++ b/docs/v2/LogsListResponse.md @@ -1,6 +1,7 @@ # LogsListResponse Response object with all logs matching the request and pagination information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsListResponseLinks.md b/docs/v2/LogsListResponseLinks.md index 4c176a1a05..41aa141d63 100644 --- a/docs/v2/LogsListResponseLinks.md +++ b/docs/v2/LogsListResponseLinks.md @@ -1,6 +1,7 @@ # LogsListResponseLinks Links attributes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricCompute.md b/docs/v2/LogsMetricCompute.md index a6743de122..db436888db 100644 --- a/docs/v2/LogsMetricCompute.md +++ b/docs/v2/LogsMetricCompute.md @@ -1,6 +1,7 @@ # LogsMetricCompute The compute rule to compute the log-based metric. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricComputeAggregationType.md b/docs/v2/LogsMetricComputeAggregationType.md index 214a667353..dcab3f0b36 100644 --- a/docs/v2/LogsMetricComputeAggregationType.md +++ b/docs/v2/LogsMetricComputeAggregationType.md @@ -1,6 +1,7 @@ # LogsMetricComputeAggregationType The type of aggregation to use. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricCreateAttributes.md b/docs/v2/LogsMetricCreateAttributes.md index 6fbc481df2..c2762f30cc 100644 --- a/docs/v2/LogsMetricCreateAttributes.md +++ b/docs/v2/LogsMetricCreateAttributes.md @@ -1,6 +1,7 @@ # LogsMetricCreateAttributes The object describing the Datadog log-based metric to create. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricCreateData.md b/docs/v2/LogsMetricCreateData.md index 45d5769b08..dc6c94cd6c 100644 --- a/docs/v2/LogsMetricCreateData.md +++ b/docs/v2/LogsMetricCreateData.md @@ -1,6 +1,7 @@ # LogsMetricCreateData The new log-based metric properties. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricCreateRequest.md b/docs/v2/LogsMetricCreateRequest.md index 4f0defa4a7..5c04aa5144 100644 --- a/docs/v2/LogsMetricCreateRequest.md +++ b/docs/v2/LogsMetricCreateRequest.md @@ -1,6 +1,7 @@ # LogsMetricCreateRequest The new log-based metric body. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricFilter.md b/docs/v2/LogsMetricFilter.md index 1d604976f6..f6821230dc 100644 --- a/docs/v2/LogsMetricFilter.md +++ b/docs/v2/LogsMetricFilter.md @@ -1,6 +1,7 @@ # LogsMetricFilter The log-based metric filter. Logs matching this filter will be aggregated in this metric. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricGroupBy.md b/docs/v2/LogsMetricGroupBy.md index c9b40dfdba..c64a42b93a 100644 --- a/docs/v2/LogsMetricGroupBy.md +++ b/docs/v2/LogsMetricGroupBy.md @@ -1,6 +1,7 @@ # LogsMetricGroupBy A group by rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricResponse.md b/docs/v2/LogsMetricResponse.md index 1517da44c6..7141c9f71a 100644 --- a/docs/v2/LogsMetricResponse.md +++ b/docs/v2/LogsMetricResponse.md @@ -1,6 +1,7 @@ # LogsMetricResponse The log-based metric object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricResponseAttributes.md b/docs/v2/LogsMetricResponseAttributes.md index 43bf221961..e80a0608bf 100644 --- a/docs/v2/LogsMetricResponseAttributes.md +++ b/docs/v2/LogsMetricResponseAttributes.md @@ -1,6 +1,7 @@ # LogsMetricResponseAttributes The object describing a Datadog log-based metric. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricResponseCompute.md b/docs/v2/LogsMetricResponseCompute.md index 945c514453..d3aea0d17e 100644 --- a/docs/v2/LogsMetricResponseCompute.md +++ b/docs/v2/LogsMetricResponseCompute.md @@ -1,6 +1,7 @@ # LogsMetricResponseCompute The compute rule to compute the log-based metric. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricResponseComputeAggregationType.md b/docs/v2/LogsMetricResponseComputeAggregationType.md index 945ec1c130..d1ecad5918 100644 --- a/docs/v2/LogsMetricResponseComputeAggregationType.md +++ b/docs/v2/LogsMetricResponseComputeAggregationType.md @@ -1,6 +1,7 @@ # LogsMetricResponseComputeAggregationType The type of aggregation to use. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricResponseData.md b/docs/v2/LogsMetricResponseData.md index 749cbbbd7b..a445940fb9 100644 --- a/docs/v2/LogsMetricResponseData.md +++ b/docs/v2/LogsMetricResponseData.md @@ -1,6 +1,7 @@ # LogsMetricResponseData The log-based metric properties. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricResponseFilter.md b/docs/v2/LogsMetricResponseFilter.md index b719098a36..6abc761b35 100644 --- a/docs/v2/LogsMetricResponseFilter.md +++ b/docs/v2/LogsMetricResponseFilter.md @@ -1,6 +1,7 @@ # LogsMetricResponseFilter The log-based metric filter. Logs matching this filter will be aggregated in this metric. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricResponseGroupBy.md b/docs/v2/LogsMetricResponseGroupBy.md index 2b19d596e7..cd427049fa 100644 --- a/docs/v2/LogsMetricResponseGroupBy.md +++ b/docs/v2/LogsMetricResponseGroupBy.md @@ -1,6 +1,7 @@ # LogsMetricResponseGroupBy A group by rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricType.md b/docs/v2/LogsMetricType.md index 1c3578a02a..9a38faa577 100644 --- a/docs/v2/LogsMetricType.md +++ b/docs/v2/LogsMetricType.md @@ -1,6 +1,7 @@ # LogsMetricType The type of the resource. The value should always be logs_metrics. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricUpdateAttributes.md b/docs/v2/LogsMetricUpdateAttributes.md index aacd9e1f72..35acf2a2d5 100644 --- a/docs/v2/LogsMetricUpdateAttributes.md +++ b/docs/v2/LogsMetricUpdateAttributes.md @@ -1,6 +1,7 @@ # LogsMetricUpdateAttributes The log-based metric properties that will be updated. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricUpdateData.md b/docs/v2/LogsMetricUpdateData.md index c884927418..2b1a81ec81 100644 --- a/docs/v2/LogsMetricUpdateData.md +++ b/docs/v2/LogsMetricUpdateData.md @@ -1,6 +1,7 @@ # LogsMetricUpdateData The new log-based metric properties. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricUpdateRequest.md b/docs/v2/LogsMetricUpdateRequest.md index f9cab86f3a..6502c7c26b 100644 --- a/docs/v2/LogsMetricUpdateRequest.md +++ b/docs/v2/LogsMetricUpdateRequest.md @@ -1,6 +1,7 @@ # LogsMetricUpdateRequest The new log-based metric body. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsMetricsApi.md b/docs/v2/LogsMetricsApi.md index 579c8b2be8..ccba015135 100644 --- a/docs/v2/LogsMetricsApi.md +++ b/docs/v2/LogsMetricsApi.md @@ -77,6 +77,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsMetricsApi->create_logs_metric: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -96,6 +97,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -152,6 +154,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsMetricsApi->delete_logs_metric: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -171,6 +174,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -227,6 +231,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsMetricsApi->get_logs_metric: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -246,6 +251,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -301,6 +307,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsMetricsApi->list_logs_metrics: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -317,6 +324,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -388,6 +396,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling LogsMetricsApi->update_logs_metric: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -408,6 +417,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/LogsMetricsResponse.md b/docs/v2/LogsMetricsResponse.md index 54b1566b92..b936bbf8d1 100644 --- a/docs/v2/LogsMetricsResponse.md +++ b/docs/v2/LogsMetricsResponse.md @@ -1,6 +1,7 @@ # LogsMetricsResponse All the available log-based metric objects. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsQueryFilter.md b/docs/v2/LogsQueryFilter.md index 6d15c7e6b1..41da7f1724 100644 --- a/docs/v2/LogsQueryFilter.md +++ b/docs/v2/LogsQueryFilter.md @@ -1,6 +1,7 @@ # LogsQueryFilter The search and filter query settings + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsQueryOptions.md b/docs/v2/LogsQueryOptions.md index d6384bf870..4670fbfb68 100644 --- a/docs/v2/LogsQueryOptions.md +++ b/docs/v2/LogsQueryOptions.md @@ -1,6 +1,7 @@ # LogsQueryOptions Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsResponseMetadata.md b/docs/v2/LogsResponseMetadata.md index b52ebcfb4e..eff49f7fcd 100644 --- a/docs/v2/LogsResponseMetadata.md +++ b/docs/v2/LogsResponseMetadata.md @@ -1,6 +1,7 @@ # LogsResponseMetadata The metadata associated with a request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsResponseMetadataPage.md b/docs/v2/LogsResponseMetadataPage.md index 267c3f4f25..6fea739b53 100644 --- a/docs/v2/LogsResponseMetadataPage.md +++ b/docs/v2/LogsResponseMetadataPage.md @@ -1,6 +1,7 @@ # LogsResponseMetadataPage Paging attributes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsSort.md b/docs/v2/LogsSort.md index b2ad991c06..d034ef1f67 100644 --- a/docs/v2/LogsSort.md +++ b/docs/v2/LogsSort.md @@ -1,6 +1,7 @@ # LogsSort Sort parameters when querying logs. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsSortOrder.md b/docs/v2/LogsSortOrder.md index 8af9706396..765e617fa0 100644 --- a/docs/v2/LogsSortOrder.md +++ b/docs/v2/LogsSortOrder.md @@ -1,6 +1,7 @@ # LogsSortOrder The order to use, ascending or descending + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/LogsWarning.md b/docs/v2/LogsWarning.md index 6a338ad792..c026c2c362 100644 --- a/docs/v2/LogsWarning.md +++ b/docs/v2/LogsWarning.md @@ -1,6 +1,7 @@ # LogsWarning A warning message indicating something that went wrong with the query + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/Metric.md b/docs/v2/Metric.md index 81a6e3101c..e5bedd255f 100644 --- a/docs/v2/Metric.md +++ b/docs/v2/Metric.md @@ -1,6 +1,7 @@ # Metric Object for a single metric tag configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricAllTags.md b/docs/v2/MetricAllTags.md index 0eb81e52a6..5f10a1416c 100644 --- a/docs/v2/MetricAllTags.md +++ b/docs/v2/MetricAllTags.md @@ -1,6 +1,7 @@ # MetricAllTags Object for a single metric's indexed tags. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricAllTagsAttributes.md b/docs/v2/MetricAllTagsAttributes.md index 4d90d7e673..43c560a471 100644 --- a/docs/v2/MetricAllTagsAttributes.md +++ b/docs/v2/MetricAllTagsAttributes.md @@ -1,6 +1,7 @@ # MetricAllTagsAttributes Object containing the definition of a metric's tags. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricAllTagsResponse.md b/docs/v2/MetricAllTagsResponse.md index 1b4324edb9..0010e6e8e9 100644 --- a/docs/v2/MetricAllTagsResponse.md +++ b/docs/v2/MetricAllTagsResponse.md @@ -1,6 +1,7 @@ # MetricAllTagsResponse Response object that includes a single metric's indexed tags. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricDistinctVolume.md b/docs/v2/MetricDistinctVolume.md index b4de20cf47..da426faf5b 100644 --- a/docs/v2/MetricDistinctVolume.md +++ b/docs/v2/MetricDistinctVolume.md @@ -1,6 +1,7 @@ # MetricDistinctVolume Object for a single metric's distinct volume. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricDistinctVolumeAttributes.md b/docs/v2/MetricDistinctVolumeAttributes.md index 5bdcf36f35..9b6a15c75d 100644 --- a/docs/v2/MetricDistinctVolumeAttributes.md +++ b/docs/v2/MetricDistinctVolumeAttributes.md @@ -1,6 +1,7 @@ # MetricDistinctVolumeAttributes Object containing the definition of a metric's distinct volume. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricDistinctVolumeType.md b/docs/v2/MetricDistinctVolumeType.md index 26d01c7b37..c293046e68 100644 --- a/docs/v2/MetricDistinctVolumeType.md +++ b/docs/v2/MetricDistinctVolumeType.md @@ -1,6 +1,7 @@ # MetricDistinctVolumeType The metric distinct volume type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricIngestedIndexedVolume.md b/docs/v2/MetricIngestedIndexedVolume.md index a02bf72e66..3b05c5194b 100644 --- a/docs/v2/MetricIngestedIndexedVolume.md +++ b/docs/v2/MetricIngestedIndexedVolume.md @@ -1,6 +1,7 @@ # MetricIngestedIndexedVolume Object for a single metric's ingested and indexed volume. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricIngestedIndexedVolumeAttributes.md b/docs/v2/MetricIngestedIndexedVolumeAttributes.md index c008825e8d..b250575069 100644 --- a/docs/v2/MetricIngestedIndexedVolumeAttributes.md +++ b/docs/v2/MetricIngestedIndexedVolumeAttributes.md @@ -1,6 +1,7 @@ # MetricIngestedIndexedVolumeAttributes Object containing the definition of a metric's ingested and indexed volume. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricIngestedIndexedVolumeType.md b/docs/v2/MetricIngestedIndexedVolumeType.md index 5484ab68b6..275bfebe59 100644 --- a/docs/v2/MetricIngestedIndexedVolumeType.md +++ b/docs/v2/MetricIngestedIndexedVolumeType.md @@ -1,6 +1,7 @@ # MetricIngestedIndexedVolumeType The metric ingested and indexed volume type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfiguration.md b/docs/v2/MetricTagConfiguration.md index 4fa622b4b2..9bb01dc9c9 100644 --- a/docs/v2/MetricTagConfiguration.md +++ b/docs/v2/MetricTagConfiguration.md @@ -1,6 +1,7 @@ # MetricTagConfiguration Object for a single metric tag configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationAttributes.md b/docs/v2/MetricTagConfigurationAttributes.md index 7a9cc28a0f..ac361fafa4 100644 --- a/docs/v2/MetricTagConfigurationAttributes.md +++ b/docs/v2/MetricTagConfigurationAttributes.md @@ -1,6 +1,7 @@ # MetricTagConfigurationAttributes Object containing the definition of a metric tag configuration attributes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationCreateAttributes.md b/docs/v2/MetricTagConfigurationCreateAttributes.md index 6d6360ecee..05b5a4aea8 100644 --- a/docs/v2/MetricTagConfigurationCreateAttributes.md +++ b/docs/v2/MetricTagConfigurationCreateAttributes.md @@ -1,6 +1,7 @@ # MetricTagConfigurationCreateAttributes Object containing the definition of a metric tag configuration to be created. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationCreateData.md b/docs/v2/MetricTagConfigurationCreateData.md index 0a3c9656c3..ea9202df0b 100644 --- a/docs/v2/MetricTagConfigurationCreateData.md +++ b/docs/v2/MetricTagConfigurationCreateData.md @@ -1,6 +1,7 @@ # MetricTagConfigurationCreateData Object for a single metric to be configure tags on. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationCreateRequest.md b/docs/v2/MetricTagConfigurationCreateRequest.md index cd64bddcc5..b9749a8610 100644 --- a/docs/v2/MetricTagConfigurationCreateRequest.md +++ b/docs/v2/MetricTagConfigurationCreateRequest.md @@ -1,6 +1,7 @@ # MetricTagConfigurationCreateRequest Request object that includes the metric that you would like to configure tags for. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationMetricTypes.md b/docs/v2/MetricTagConfigurationMetricTypes.md index b836ef120c..2ec987f7a6 100644 --- a/docs/v2/MetricTagConfigurationMetricTypes.md +++ b/docs/v2/MetricTagConfigurationMetricTypes.md @@ -1,6 +1,7 @@ # MetricTagConfigurationMetricTypes The metric's type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationResponse.md b/docs/v2/MetricTagConfigurationResponse.md index 89bbb27b9f..d544244656 100644 --- a/docs/v2/MetricTagConfigurationResponse.md +++ b/docs/v2/MetricTagConfigurationResponse.md @@ -1,6 +1,7 @@ # MetricTagConfigurationResponse Response object which includes a single metric's tag configuration. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationType.md b/docs/v2/MetricTagConfigurationType.md index 562bbd4dbc..33e0d67e72 100644 --- a/docs/v2/MetricTagConfigurationType.md +++ b/docs/v2/MetricTagConfigurationType.md @@ -1,6 +1,7 @@ # MetricTagConfigurationType The metric tag configuration resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationUpdateAttributes.md b/docs/v2/MetricTagConfigurationUpdateAttributes.md index 23f39da17f..48eec6f873 100644 --- a/docs/v2/MetricTagConfigurationUpdateAttributes.md +++ b/docs/v2/MetricTagConfigurationUpdateAttributes.md @@ -1,6 +1,7 @@ # MetricTagConfigurationUpdateAttributes Object containing the definition of a metric tag configuration to be updated. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationUpdateData.md b/docs/v2/MetricTagConfigurationUpdateData.md index 1625d5636d..fd9f736566 100644 --- a/docs/v2/MetricTagConfigurationUpdateData.md +++ b/docs/v2/MetricTagConfigurationUpdateData.md @@ -1,6 +1,7 @@ # MetricTagConfigurationUpdateData Object for a single tag configuration to be edited. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricTagConfigurationUpdateRequest.md b/docs/v2/MetricTagConfigurationUpdateRequest.md index 9a34da555b..10d1558c28 100644 --- a/docs/v2/MetricTagConfigurationUpdateRequest.md +++ b/docs/v2/MetricTagConfigurationUpdateRequest.md @@ -1,6 +1,7 @@ # MetricTagConfigurationUpdateRequest Request object that includes the metric that you would like to edit the tag configuration on. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricType.md b/docs/v2/MetricType.md index f02d73806a..1ca5d8afa5 100644 --- a/docs/v2/MetricType.md +++ b/docs/v2/MetricType.md @@ -1,6 +1,7 @@ # MetricType The metric resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricVolumes.md b/docs/v2/MetricVolumes.md index 5cdb850c05..e2690f9e47 100644 --- a/docs/v2/MetricVolumes.md +++ b/docs/v2/MetricVolumes.md @@ -1,6 +1,7 @@ # MetricVolumes Possible response objects for a metric's volume. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricVolumesResponse.md b/docs/v2/MetricVolumesResponse.md index dd9a6e226a..2169a885c0 100644 --- a/docs/v2/MetricVolumesResponse.md +++ b/docs/v2/MetricVolumesResponse.md @@ -1,6 +1,7 @@ # MetricVolumesResponse Response object which includes a single metric's volume. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricsAndMetricTagConfigurations.md b/docs/v2/MetricsAndMetricTagConfigurations.md index 95219695bc..fa79f858e3 100644 --- a/docs/v2/MetricsAndMetricTagConfigurations.md +++ b/docs/v2/MetricsAndMetricTagConfigurations.md @@ -1,6 +1,7 @@ # MetricsAndMetricTagConfigurations Object for a metrics and metric tag configurations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricsAndMetricTagConfigurationsResponse.md b/docs/v2/MetricsAndMetricTagConfigurationsResponse.md index 5569afa7bf..f47a2d04b1 100644 --- a/docs/v2/MetricsAndMetricTagConfigurationsResponse.md +++ b/docs/v2/MetricsAndMetricTagConfigurationsResponse.md @@ -1,6 +1,7 @@ # MetricsAndMetricTagConfigurationsResponse Response object that includes metrics and metric tag configurations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/MetricsApi.md b/docs/v2/MetricsApi.md index d74e5b861e..91279cf6ef 100644 --- a/docs/v2/MetricsApi.md +++ b/docs/v2/MetricsApi.md @@ -71,6 +71,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->create_tag_configuration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -91,6 +92,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -148,6 +150,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->delete_tag_configuration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -167,6 +170,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -224,6 +228,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->list_tag_configuration_by_name: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -243,6 +248,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -304,6 +310,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->list_tag_configurations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -326,6 +333,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -383,6 +391,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->list_tags_by_metric_name: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -402,6 +411,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -460,6 +470,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->list_volumes_by_metric_name: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -479,6 +490,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -547,6 +559,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling MetricsApi->update_tag_configuration: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -567,6 +580,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/Organization.md b/docs/v2/Organization.md index 79fb0d6edc..b75b7ba4e6 100644 --- a/docs/v2/Organization.md +++ b/docs/v2/Organization.md @@ -1,6 +1,7 @@ # Organization Organization object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/OrganizationAttributes.md b/docs/v2/OrganizationAttributes.md index 72f701c9ef..9ae9b035a4 100644 --- a/docs/v2/OrganizationAttributes.md +++ b/docs/v2/OrganizationAttributes.md @@ -1,6 +1,7 @@ # OrganizationAttributes Attributes of the organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/OrganizationsType.md b/docs/v2/OrganizationsType.md index 8442a5ec97..acae5e5cff 100644 --- a/docs/v2/OrganizationsType.md +++ b/docs/v2/OrganizationsType.md @@ -1,6 +1,7 @@ # OrganizationsType Organizations resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/Pagination.md b/docs/v2/Pagination.md index 335319a127..ed882c10a2 100644 --- a/docs/v2/Pagination.md +++ b/docs/v2/Pagination.md @@ -1,6 +1,7 @@ # Pagination Pagination object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/PartialAPIKey.md b/docs/v2/PartialAPIKey.md index ba950947e3..6d2a30cdd7 100644 --- a/docs/v2/PartialAPIKey.md +++ b/docs/v2/PartialAPIKey.md @@ -1,6 +1,7 @@ # PartialAPIKey Partial Datadog API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/PartialAPIKeyAttributes.md b/docs/v2/PartialAPIKeyAttributes.md index f570a2937c..7987e98e98 100644 --- a/docs/v2/PartialAPIKeyAttributes.md +++ b/docs/v2/PartialAPIKeyAttributes.md @@ -1,6 +1,7 @@ # PartialAPIKeyAttributes Attributes of a partial API key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/PartialApplicationKey.md b/docs/v2/PartialApplicationKey.md index 224045d0ba..52593f6385 100644 --- a/docs/v2/PartialApplicationKey.md +++ b/docs/v2/PartialApplicationKey.md @@ -1,6 +1,7 @@ # PartialApplicationKey Partial Datadog application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/PartialApplicationKeyAttributes.md b/docs/v2/PartialApplicationKeyAttributes.md index 35f895927a..b7a4b8f1e2 100644 --- a/docs/v2/PartialApplicationKeyAttributes.md +++ b/docs/v2/PartialApplicationKeyAttributes.md @@ -1,6 +1,7 @@ # PartialApplicationKeyAttributes Attributes of a partial application key. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/Permission.md b/docs/v2/Permission.md index 4255a86b98..a069366599 100644 --- a/docs/v2/Permission.md +++ b/docs/v2/Permission.md @@ -1,6 +1,7 @@ # Permission Permission object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/PermissionAttributes.md b/docs/v2/PermissionAttributes.md index 6096f90c51..e0e5b2933e 100644 --- a/docs/v2/PermissionAttributes.md +++ b/docs/v2/PermissionAttributes.md @@ -1,6 +1,7 @@ # PermissionAttributes Attributes of a permission. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/PermissionsResponse.md b/docs/v2/PermissionsResponse.md index 0ad91324fe..bc030d1688 100644 --- a/docs/v2/PermissionsResponse.md +++ b/docs/v2/PermissionsResponse.md @@ -1,6 +1,7 @@ # PermissionsResponse Payload with API-returned permissions. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/PermissionsType.md b/docs/v2/PermissionsType.md index 2ff10af467..82c1553bc1 100644 --- a/docs/v2/PermissionsType.md +++ b/docs/v2/PermissionsType.md @@ -1,6 +1,7 @@ # PermissionsType Permissions resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ProcessSummariesMeta.md b/docs/v2/ProcessSummariesMeta.md index 7024ee44bb..aea7e98d27 100644 --- a/docs/v2/ProcessSummariesMeta.md +++ b/docs/v2/ProcessSummariesMeta.md @@ -1,6 +1,7 @@ # ProcessSummariesMeta Response metadata object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ProcessSummariesMetaPage.md b/docs/v2/ProcessSummariesMetaPage.md index 6118871e6e..8ce5ba6e3a 100644 --- a/docs/v2/ProcessSummariesMetaPage.md +++ b/docs/v2/ProcessSummariesMetaPage.md @@ -1,6 +1,7 @@ # ProcessSummariesMetaPage Paging attributes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ProcessSummariesResponse.md b/docs/v2/ProcessSummariesResponse.md index 08aa25db56..6840018430 100644 --- a/docs/v2/ProcessSummariesResponse.md +++ b/docs/v2/ProcessSummariesResponse.md @@ -1,6 +1,7 @@ # ProcessSummariesResponse List of process summaries. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ProcessSummary.md b/docs/v2/ProcessSummary.md index b6a07191e0..27137c6698 100644 --- a/docs/v2/ProcessSummary.md +++ b/docs/v2/ProcessSummary.md @@ -1,6 +1,7 @@ # ProcessSummary Process summary object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ProcessSummaryAttributes.md b/docs/v2/ProcessSummaryAttributes.md index 2d7082ea74..bd4bc48b17 100644 --- a/docs/v2/ProcessSummaryAttributes.md +++ b/docs/v2/ProcessSummaryAttributes.md @@ -1,6 +1,7 @@ # ProcessSummaryAttributes Attributes for a process summary. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ProcessSummaryType.md b/docs/v2/ProcessSummaryType.md index f690a1130f..099c3d5999 100644 --- a/docs/v2/ProcessSummaryType.md +++ b/docs/v2/ProcessSummaryType.md @@ -1,6 +1,7 @@ # ProcessSummaryType Type of process summary. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ProcessesApi.md b/docs/v2/ProcessesApi.md index 6b8c24ac77..8023bebd2b 100644 --- a/docs/v2/ProcessesApi.md +++ b/docs/v2/ProcessesApi.md @@ -59,6 +59,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling ProcessesApi->list_processes: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -83,6 +84,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/QuerySortOrder.md b/docs/v2/QuerySortOrder.md index 3aa30f45d5..286472ed01 100644 --- a/docs/v2/QuerySortOrder.md +++ b/docs/v2/QuerySortOrder.md @@ -1,6 +1,7 @@ # QuerySortOrder Direction of sort. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToIncidentIntegrationMetadataData.md b/docs/v2/RelationshipToIncidentIntegrationMetadataData.md index 46351cfe00..e7900e49c6 100644 --- a/docs/v2/RelationshipToIncidentIntegrationMetadataData.md +++ b/docs/v2/RelationshipToIncidentIntegrationMetadataData.md @@ -1,6 +1,7 @@ # RelationshipToIncidentIntegrationMetadataData A relationship reference for an integration metadata object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToIncidentIntegrationMetadatas.md b/docs/v2/RelationshipToIncidentIntegrationMetadatas.md index 030de40d1d..9153244f84 100644 --- a/docs/v2/RelationshipToIncidentIntegrationMetadatas.md +++ b/docs/v2/RelationshipToIncidentIntegrationMetadatas.md @@ -1,6 +1,7 @@ # RelationshipToIncidentIntegrationMetadatas A relationship reference for multiple integration metadata objects. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToIncidentPostmortem.md b/docs/v2/RelationshipToIncidentPostmortem.md index 07e3e45eac..19a2374565 100644 --- a/docs/v2/RelationshipToIncidentPostmortem.md +++ b/docs/v2/RelationshipToIncidentPostmortem.md @@ -1,6 +1,7 @@ # RelationshipToIncidentPostmortem A relationship reference for postmortems. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToIncidentPostmortemData.md b/docs/v2/RelationshipToIncidentPostmortemData.md index 52ec133576..8cb5a5fed7 100644 --- a/docs/v2/RelationshipToIncidentPostmortemData.md +++ b/docs/v2/RelationshipToIncidentPostmortemData.md @@ -1,6 +1,7 @@ # RelationshipToIncidentPostmortemData The postmortem relationship data. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToOrganization.md b/docs/v2/RelationshipToOrganization.md index d94a0ec17a..42b773a510 100644 --- a/docs/v2/RelationshipToOrganization.md +++ b/docs/v2/RelationshipToOrganization.md @@ -1,6 +1,7 @@ # RelationshipToOrganization Relationship to an organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToOrganizationData.md b/docs/v2/RelationshipToOrganizationData.md index 98e6abeae8..d8735ffae2 100644 --- a/docs/v2/RelationshipToOrganizationData.md +++ b/docs/v2/RelationshipToOrganizationData.md @@ -1,6 +1,7 @@ # RelationshipToOrganizationData Relationship to organization object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToOrganizations.md b/docs/v2/RelationshipToOrganizations.md index 55b2321069..8177ab8b33 100644 --- a/docs/v2/RelationshipToOrganizations.md +++ b/docs/v2/RelationshipToOrganizations.md @@ -1,6 +1,7 @@ # RelationshipToOrganizations Relationship to organizations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToPermission.md b/docs/v2/RelationshipToPermission.md index 1d3c0fbfe9..40bf161891 100644 --- a/docs/v2/RelationshipToPermission.md +++ b/docs/v2/RelationshipToPermission.md @@ -1,6 +1,7 @@ # RelationshipToPermission Relationship to a permissions object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToPermissionData.md b/docs/v2/RelationshipToPermissionData.md index 2cd6279124..8b7149986f 100644 --- a/docs/v2/RelationshipToPermissionData.md +++ b/docs/v2/RelationshipToPermissionData.md @@ -1,6 +1,7 @@ # RelationshipToPermissionData Relationship to permission object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToPermissions.md b/docs/v2/RelationshipToPermissions.md index 993da4a9e7..f8ff4f5df1 100644 --- a/docs/v2/RelationshipToPermissions.md +++ b/docs/v2/RelationshipToPermissions.md @@ -1,6 +1,7 @@ # RelationshipToPermissions Relationship to multiple permissions objects. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToRole.md b/docs/v2/RelationshipToRole.md index efe76e180d..adcaf202a3 100644 --- a/docs/v2/RelationshipToRole.md +++ b/docs/v2/RelationshipToRole.md @@ -1,6 +1,7 @@ # RelationshipToRole Relationship to role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToRoleData.md b/docs/v2/RelationshipToRoleData.md index 88dc4a6516..af1afee2a0 100644 --- a/docs/v2/RelationshipToRoleData.md +++ b/docs/v2/RelationshipToRoleData.md @@ -1,6 +1,7 @@ # RelationshipToRoleData Relationship to role object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToRoles.md b/docs/v2/RelationshipToRoles.md index 45a9332ff2..b7a76868fd 100644 --- a/docs/v2/RelationshipToRoles.md +++ b/docs/v2/RelationshipToRoles.md @@ -1,6 +1,7 @@ # RelationshipToRoles Relationship to roles. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToUser.md b/docs/v2/RelationshipToUser.md index b5d1db35ac..918f1b29e0 100644 --- a/docs/v2/RelationshipToUser.md +++ b/docs/v2/RelationshipToUser.md @@ -1,6 +1,7 @@ # RelationshipToUser Relationship to user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToUserData.md b/docs/v2/RelationshipToUserData.md index b975a0505b..befd857d59 100644 --- a/docs/v2/RelationshipToUserData.md +++ b/docs/v2/RelationshipToUserData.md @@ -1,6 +1,7 @@ # RelationshipToUserData Relationship to user object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RelationshipToUsers.md b/docs/v2/RelationshipToUsers.md index 8316689447..5e678a1272 100644 --- a/docs/v2/RelationshipToUsers.md +++ b/docs/v2/RelationshipToUsers.md @@ -1,6 +1,7 @@ # RelationshipToUsers Relationship to users. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/ResponseMetaAttributes.md b/docs/v2/ResponseMetaAttributes.md index 2a4666a247..6ee5f4e819 100644 --- a/docs/v2/ResponseMetaAttributes.md +++ b/docs/v2/ResponseMetaAttributes.md @@ -1,6 +1,7 @@ # ResponseMetaAttributes Object describing meta attributes of response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/Role.md b/docs/v2/Role.md index 15d9c7956e..b59f6c0325 100644 --- a/docs/v2/Role.md +++ b/docs/v2/Role.md @@ -1,6 +1,7 @@ # Role Role object returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleAttributes.md b/docs/v2/RoleAttributes.md index 1d4e69446e..9f8bb9e687 100644 --- a/docs/v2/RoleAttributes.md +++ b/docs/v2/RoleAttributes.md @@ -1,6 +1,7 @@ # RoleAttributes Attributes of the role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleCreateAttributes.md b/docs/v2/RoleCreateAttributes.md index 54b7543328..d3c1ddf5f5 100644 --- a/docs/v2/RoleCreateAttributes.md +++ b/docs/v2/RoleCreateAttributes.md @@ -1,6 +1,7 @@ # RoleCreateAttributes Attributes of the created role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleCreateData.md b/docs/v2/RoleCreateData.md index 67b941882d..aa827b51ed 100644 --- a/docs/v2/RoleCreateData.md +++ b/docs/v2/RoleCreateData.md @@ -1,6 +1,7 @@ # RoleCreateData Data related to the creation of a role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleCreateRequest.md b/docs/v2/RoleCreateRequest.md index f2981a1a84..f630a43171 100644 --- a/docs/v2/RoleCreateRequest.md +++ b/docs/v2/RoleCreateRequest.md @@ -1,6 +1,7 @@ # RoleCreateRequest Create a role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleCreateResponse.md b/docs/v2/RoleCreateResponse.md index 6fa9846334..be5fd9f90b 100644 --- a/docs/v2/RoleCreateResponse.md +++ b/docs/v2/RoleCreateResponse.md @@ -1,6 +1,7 @@ # RoleCreateResponse Response containing information about a created role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleCreateResponseData.md b/docs/v2/RoleCreateResponseData.md index 4b8f41fbdc..b72a706231 100644 --- a/docs/v2/RoleCreateResponseData.md +++ b/docs/v2/RoleCreateResponseData.md @@ -1,6 +1,7 @@ # RoleCreateResponseData Role object returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleRelationships.md b/docs/v2/RoleRelationships.md index 5a777c8793..de10851445 100644 --- a/docs/v2/RoleRelationships.md +++ b/docs/v2/RoleRelationships.md @@ -1,6 +1,7 @@ # RoleRelationships Relationships of the role object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleResponse.md b/docs/v2/RoleResponse.md index 291d9c9aec..3af83078eb 100644 --- a/docs/v2/RoleResponse.md +++ b/docs/v2/RoleResponse.md @@ -1,6 +1,7 @@ # RoleResponse Response containing information about a single role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleResponseRelationships.md b/docs/v2/RoleResponseRelationships.md index c78d86fe90..b4867a5cba 100644 --- a/docs/v2/RoleResponseRelationships.md +++ b/docs/v2/RoleResponseRelationships.md @@ -1,6 +1,7 @@ # RoleResponseRelationships Relationships of the role object returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleUpdateAttributes.md b/docs/v2/RoleUpdateAttributes.md index 7395c160fe..05bace4bbe 100644 --- a/docs/v2/RoleUpdateAttributes.md +++ b/docs/v2/RoleUpdateAttributes.md @@ -1,6 +1,7 @@ # RoleUpdateAttributes Attributes of the role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleUpdateData.md b/docs/v2/RoleUpdateData.md index b9be1b611b..848c9f9772 100644 --- a/docs/v2/RoleUpdateData.md +++ b/docs/v2/RoleUpdateData.md @@ -1,6 +1,7 @@ # RoleUpdateData Data related to the update of a role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleUpdateRequest.md b/docs/v2/RoleUpdateRequest.md index 7634d35eb5..9856d42508 100644 --- a/docs/v2/RoleUpdateRequest.md +++ b/docs/v2/RoleUpdateRequest.md @@ -1,6 +1,7 @@ # RoleUpdateRequest Update a role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleUpdateResponse.md b/docs/v2/RoleUpdateResponse.md index d9101ca49e..63a2797a1f 100644 --- a/docs/v2/RoleUpdateResponse.md +++ b/docs/v2/RoleUpdateResponse.md @@ -1,6 +1,7 @@ # RoleUpdateResponse Response containing information about an updated role. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RoleUpdateResponseData.md b/docs/v2/RoleUpdateResponseData.md index 1a93afc45a..52e0912c94 100644 --- a/docs/v2/RoleUpdateResponseData.md +++ b/docs/v2/RoleUpdateResponseData.md @@ -1,6 +1,7 @@ # RoleUpdateResponseData Role object returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RolesApi.md b/docs/v2/RolesApi.md index c7e0683c9d..e109073dd3 100644 --- a/docs/v2/RolesApi.md +++ b/docs/v2/RolesApi.md @@ -70,6 +70,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->add_permission_to_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -90,6 +91,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -152,6 +154,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->add_user_to_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -172,6 +175,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -250,6 +254,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->create_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -269,6 +274,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -323,6 +329,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->delete_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -342,6 +349,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -397,6 +405,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->get_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -416,6 +425,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -470,6 +480,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->list_permissions: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -486,6 +497,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -541,6 +553,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->list_role_permissions: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -560,6 +573,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -628,6 +642,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->list_role_users: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -651,6 +666,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -710,6 +726,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -732,6 +749,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -792,6 +810,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->remove_permission_from_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -812,6 +831,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -874,6 +894,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->remove_user_from_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -894,6 +915,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -961,6 +983,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling RolesApi->update_role: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -981,6 +1004,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/RolesResponse.md b/docs/v2/RolesResponse.md index 2c31ca15b4..085a94b305 100644 --- a/docs/v2/RolesResponse.md +++ b/docs/v2/RolesResponse.md @@ -1,6 +1,7 @@ # RolesResponse Response containing information about multiple roles. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RolesSort.md b/docs/v2/RolesSort.md index 9c716da406..0cbc0cc780 100644 --- a/docs/v2/RolesSort.md +++ b/docs/v2/RolesSort.md @@ -1,6 +1,7 @@ # RolesSort Sorting options for roles. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/RolesType.md b/docs/v2/RolesType.md index cc7e30ed1d..b7daccfbb9 100644 --- a/docs/v2/RolesType.md +++ b/docs/v2/RolesType.md @@ -1,6 +1,7 @@ # RolesType Roles type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringApi.md b/docs/v2/SecurityMonitoringApi.md index 94a49b0f2b..72fef54ba0 100644 --- a/docs/v2/SecurityMonitoringApi.md +++ b/docs/v2/SecurityMonitoringApi.md @@ -82,6 +82,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SecurityMonitoringApi->create_security_monitoring_rule: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -101,6 +102,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -155,6 +157,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SecurityMonitoringApi->delete_security_monitoring_rule: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -174,6 +177,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -229,6 +233,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SecurityMonitoringApi->get_security_monitoring_rule: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -248,6 +253,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -304,6 +310,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SecurityMonitoringApi->list_security_monitoring_rules: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -324,6 +331,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -385,6 +393,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SecurityMonitoringApi->list_security_monitoring_signals: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -409,6 +418,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -477,6 +487,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SecurityMonitoringApi->search_security_monitoring_signals: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -496,6 +507,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -599,6 +611,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling SecurityMonitoringApi->update_security_monitoring_rule: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -619,6 +632,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/SecurityMonitoringFilter.md b/docs/v2/SecurityMonitoringFilter.md index 75c4ca4289..e21a609c14 100644 --- a/docs/v2/SecurityMonitoringFilter.md +++ b/docs/v2/SecurityMonitoringFilter.md @@ -1,6 +1,7 @@ # SecurityMonitoringFilter The rule's suppression filter. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringFilterAction.md b/docs/v2/SecurityMonitoringFilterAction.md index 9b56440e44..d6f49f3874 100644 --- a/docs/v2/SecurityMonitoringFilterAction.md +++ b/docs/v2/SecurityMonitoringFilterAction.md @@ -1,6 +1,7 @@ # SecurityMonitoringFilterAction The type of filtering action. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringListRulesResponse.md b/docs/v2/SecurityMonitoringListRulesResponse.md index 5d356776ec..aa15d6e8bf 100644 --- a/docs/v2/SecurityMonitoringListRulesResponse.md +++ b/docs/v2/SecurityMonitoringListRulesResponse.md @@ -1,6 +1,7 @@ # SecurityMonitoringListRulesResponse List of rules. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleCase.md b/docs/v2/SecurityMonitoringRuleCase.md index 1b443c33ff..71097e606d 100644 --- a/docs/v2/SecurityMonitoringRuleCase.md +++ b/docs/v2/SecurityMonitoringRuleCase.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleCase Case when signal is generated. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleCaseCreate.md b/docs/v2/SecurityMonitoringRuleCaseCreate.md index 4ef2282775..3b5ada2688 100644 --- a/docs/v2/SecurityMonitoringRuleCaseCreate.md +++ b/docs/v2/SecurityMonitoringRuleCaseCreate.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleCaseCreate Case when signal is generated. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleCreatePayload.md b/docs/v2/SecurityMonitoringRuleCreatePayload.md index 47f1cb7b87..352ae6904c 100644 --- a/docs/v2/SecurityMonitoringRuleCreatePayload.md +++ b/docs/v2/SecurityMonitoringRuleCreatePayload.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleCreatePayload Create a new rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleDetectionMethod.md b/docs/v2/SecurityMonitoringRuleDetectionMethod.md index 06232bbf01..68a0b551b2 100644 --- a/docs/v2/SecurityMonitoringRuleDetectionMethod.md +++ b/docs/v2/SecurityMonitoringRuleDetectionMethod.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleDetectionMethod The detection method. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleEvaluationWindow.md b/docs/v2/SecurityMonitoringRuleEvaluationWindow.md index bac1cc1927..506c0fea17 100644 --- a/docs/v2/SecurityMonitoringRuleEvaluationWindow.md +++ b/docs/v2/SecurityMonitoringRuleEvaluationWindow.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleEvaluationWindow A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleKeepAlive.md b/docs/v2/SecurityMonitoringRuleKeepAlive.md index 7a4fa695bb..775f527ccc 100644 --- a/docs/v2/SecurityMonitoringRuleKeepAlive.md +++ b/docs/v2/SecurityMonitoringRuleKeepAlive.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleKeepAlive Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md b/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md index 9c1f905341..91a2150925 100644 --- a/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md +++ b/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleMaxSignalDuration A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleNewValueOptions.md b/docs/v2/SecurityMonitoringRuleNewValueOptions.md index 35f3d4b6fa..50fe0836da 100644 --- a/docs/v2/SecurityMonitoringRuleNewValueOptions.md +++ b/docs/v2/SecurityMonitoringRuleNewValueOptions.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleNewValueOptions Options on new value rules. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md b/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md index da4128db7d..177f0c0095 100644 --- a/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md +++ b/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleNewValueOptionsForgetAfter The duration in days after which a learned value is forgotten. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md b/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md index 8aaa0f44b8..a04cead6c8 100644 --- a/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md +++ b/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleNewValueOptionsLearningDuration The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleOptions.md b/docs/v2/SecurityMonitoringRuleOptions.md index f3ed433c0b..19882aec7d 100644 --- a/docs/v2/SecurityMonitoringRuleOptions.md +++ b/docs/v2/SecurityMonitoringRuleOptions.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleOptions Options on rules. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleQuery.md b/docs/v2/SecurityMonitoringRuleQuery.md index 3c9cd65b71..49b6e8810d 100644 --- a/docs/v2/SecurityMonitoringRuleQuery.md +++ b/docs/v2/SecurityMonitoringRuleQuery.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleQuery Query for matching rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleQueryAggregation.md b/docs/v2/SecurityMonitoringRuleQueryAggregation.md index 91b1d29e02..5a9f3562cb 100644 --- a/docs/v2/SecurityMonitoringRuleQueryAggregation.md +++ b/docs/v2/SecurityMonitoringRuleQueryAggregation.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleQueryAggregation The aggregation type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleQueryCreate.md b/docs/v2/SecurityMonitoringRuleQueryCreate.md index a2d0520864..1e3c808b7f 100644 --- a/docs/v2/SecurityMonitoringRuleQueryCreate.md +++ b/docs/v2/SecurityMonitoringRuleQueryCreate.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleQueryCreate Query for matching rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleResponse.md b/docs/v2/SecurityMonitoringRuleResponse.md index cfd4a3e121..4efa111c5c 100644 --- a/docs/v2/SecurityMonitoringRuleResponse.md +++ b/docs/v2/SecurityMonitoringRuleResponse.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleResponse Detection rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleSeverity.md b/docs/v2/SecurityMonitoringRuleSeverity.md index bf5552c357..3cbc701b78 100644 --- a/docs/v2/SecurityMonitoringRuleSeverity.md +++ b/docs/v2/SecurityMonitoringRuleSeverity.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleSeverity Severity of the Security Signal. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringRuleUpdatePayload.md b/docs/v2/SecurityMonitoringRuleUpdatePayload.md index ac7037b8fe..7ae3d640c4 100644 --- a/docs/v2/SecurityMonitoringRuleUpdatePayload.md +++ b/docs/v2/SecurityMonitoringRuleUpdatePayload.md @@ -1,6 +1,7 @@ # SecurityMonitoringRuleUpdatePayload Update an existing rule. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignal.md b/docs/v2/SecurityMonitoringSignal.md index 066f8bacd1..498cc3e136 100644 --- a/docs/v2/SecurityMonitoringSignal.md +++ b/docs/v2/SecurityMonitoringSignal.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignal Object description of a security signal. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalAttributes.md b/docs/v2/SecurityMonitoringSignalAttributes.md index 7badf70981..71d83cb359 100644 --- a/docs/v2/SecurityMonitoringSignalAttributes.md +++ b/docs/v2/SecurityMonitoringSignalAttributes.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalAttributes The object containing all signal attributes and their associated values. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalListRequest.md b/docs/v2/SecurityMonitoringSignalListRequest.md index 2dde80e068..919c2e5e39 100644 --- a/docs/v2/SecurityMonitoringSignalListRequest.md +++ b/docs/v2/SecurityMonitoringSignalListRequest.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalListRequest The request for a security signal list. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalListRequestFilter.md b/docs/v2/SecurityMonitoringSignalListRequestFilter.md index 6ea6f7c7f3..bcf1973b7b 100644 --- a/docs/v2/SecurityMonitoringSignalListRequestFilter.md +++ b/docs/v2/SecurityMonitoringSignalListRequestFilter.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalListRequestFilter Search filters for listing security signals. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalListRequestPage.md b/docs/v2/SecurityMonitoringSignalListRequestPage.md index cbb2c2af8f..712e8635a8 100644 --- a/docs/v2/SecurityMonitoringSignalListRequestPage.md +++ b/docs/v2/SecurityMonitoringSignalListRequestPage.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalListRequestPage The paging attributes for listing security signals. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalType.md b/docs/v2/SecurityMonitoringSignalType.md index 00c647cf31..db4de333ab 100644 --- a/docs/v2/SecurityMonitoringSignalType.md +++ b/docs/v2/SecurityMonitoringSignalType.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalType The type of event. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalsListResponse.md b/docs/v2/SecurityMonitoringSignalsListResponse.md index 964b4416e8..3a8210d756 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponse.md +++ b/docs/v2/SecurityMonitoringSignalsListResponse.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalsListResponse The response object with all security signals matching the request and pagination information. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalsListResponseLinks.md b/docs/v2/SecurityMonitoringSignalsListResponseLinks.md index be6d1cd7e2..71d3a7122b 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponseLinks.md +++ b/docs/v2/SecurityMonitoringSignalsListResponseLinks.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalsListResponseLinks Links attributes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalsListResponseMeta.md b/docs/v2/SecurityMonitoringSignalsListResponseMeta.md index d7c5f2546a..b52b957e84 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponseMeta.md +++ b/docs/v2/SecurityMonitoringSignalsListResponseMeta.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalsListResponseMeta Meta attributes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md b/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md index ea4490489f..8239da63ec 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md +++ b/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalsListResponseMetaPage Paging attributes. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/SecurityMonitoringSignalsSort.md b/docs/v2/SecurityMonitoringSignalsSort.md index 37686017a3..aa90d39b08 100644 --- a/docs/v2/SecurityMonitoringSignalsSort.md +++ b/docs/v2/SecurityMonitoringSignalsSort.md @@ -1,6 +1,7 @@ # SecurityMonitoringSignalsSort The sort parameters used for querying security signals. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/User.md b/docs/v2/User.md index 640ab28af8..47ca52e8b0 100644 --- a/docs/v2/User.md +++ b/docs/v2/User.md @@ -1,6 +1,7 @@ # User User object returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserAttributes.md b/docs/v2/UserAttributes.md index 060c8915cd..386633257e 100644 --- a/docs/v2/UserAttributes.md +++ b/docs/v2/UserAttributes.md @@ -1,6 +1,7 @@ # UserAttributes Attributes of user object returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserCreateAttributes.md b/docs/v2/UserCreateAttributes.md index 8da88321da..173800c3f7 100644 --- a/docs/v2/UserCreateAttributes.md +++ b/docs/v2/UserCreateAttributes.md @@ -1,6 +1,7 @@ # UserCreateAttributes Attributes of the created user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserCreateData.md b/docs/v2/UserCreateData.md index 9e191557ec..f696ace762 100644 --- a/docs/v2/UserCreateData.md +++ b/docs/v2/UserCreateData.md @@ -1,6 +1,7 @@ # UserCreateData Object to create a user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserCreateRequest.md b/docs/v2/UserCreateRequest.md index 474df7baf1..a21eafe076 100644 --- a/docs/v2/UserCreateRequest.md +++ b/docs/v2/UserCreateRequest.md @@ -1,6 +1,7 @@ # UserCreateRequest Create a user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationData.md b/docs/v2/UserInvitationData.md index 27d8ee60fe..8ee9dfe75a 100644 --- a/docs/v2/UserInvitationData.md +++ b/docs/v2/UserInvitationData.md @@ -1,6 +1,7 @@ # UserInvitationData Object to create a user invitation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationDataAttributes.md b/docs/v2/UserInvitationDataAttributes.md index 957b92729c..b5bcb1b6c9 100644 --- a/docs/v2/UserInvitationDataAttributes.md +++ b/docs/v2/UserInvitationDataAttributes.md @@ -1,6 +1,7 @@ # UserInvitationDataAttributes Attributes of a user invitation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationRelationships.md b/docs/v2/UserInvitationRelationships.md index 44bcb79c31..0215375692 100644 --- a/docs/v2/UserInvitationRelationships.md +++ b/docs/v2/UserInvitationRelationships.md @@ -1,6 +1,7 @@ # UserInvitationRelationships Relationships data for user invitation. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationResponse.md b/docs/v2/UserInvitationResponse.md index 2455adab05..3f18ce0dc5 100644 --- a/docs/v2/UserInvitationResponse.md +++ b/docs/v2/UserInvitationResponse.md @@ -1,6 +1,7 @@ # UserInvitationResponse User invitation as returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationResponseData.md b/docs/v2/UserInvitationResponseData.md index ed6f76691f..93453a4a01 100644 --- a/docs/v2/UserInvitationResponseData.md +++ b/docs/v2/UserInvitationResponseData.md @@ -1,6 +1,7 @@ # UserInvitationResponseData Object of a user invitation returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationsRequest.md b/docs/v2/UserInvitationsRequest.md index b664845bd4..27901da859 100644 --- a/docs/v2/UserInvitationsRequest.md +++ b/docs/v2/UserInvitationsRequest.md @@ -1,6 +1,7 @@ # UserInvitationsRequest Object to invite users to join the organization. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationsResponse.md b/docs/v2/UserInvitationsResponse.md index f087a9e5ce..90d5d47d2f 100644 --- a/docs/v2/UserInvitationsResponse.md +++ b/docs/v2/UserInvitationsResponse.md @@ -1,6 +1,7 @@ # UserInvitationsResponse User invitations as returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserInvitationsType.md b/docs/v2/UserInvitationsType.md index 3a78c17b07..764b04f63f 100644 --- a/docs/v2/UserInvitationsType.md +++ b/docs/v2/UserInvitationsType.md @@ -1,6 +1,7 @@ # UserInvitationsType User invitations type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserRelationships.md b/docs/v2/UserRelationships.md index 664d047eb1..963b93ff95 100644 --- a/docs/v2/UserRelationships.md +++ b/docs/v2/UserRelationships.md @@ -1,6 +1,7 @@ # UserRelationships Relationships of the user object. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserResponse.md b/docs/v2/UserResponse.md index ff5c74b060..19ea6c75e0 100644 --- a/docs/v2/UserResponse.md +++ b/docs/v2/UserResponse.md @@ -1,6 +1,7 @@ # UserResponse Response containing information about a single user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserResponseIncludedItem.md b/docs/v2/UserResponseIncludedItem.md index ee9f96f7b8..c41b3a4dc8 100644 --- a/docs/v2/UserResponseIncludedItem.md +++ b/docs/v2/UserResponseIncludedItem.md @@ -1,6 +1,7 @@ # UserResponseIncludedItem An object related to a user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserResponseRelationships.md b/docs/v2/UserResponseRelationships.md index 0f4858dc82..e35047f2b6 100644 --- a/docs/v2/UserResponseRelationships.md +++ b/docs/v2/UserResponseRelationships.md @@ -1,6 +1,7 @@ # UserResponseRelationships Relationships of the user object returned by the API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserUpdateAttributes.md b/docs/v2/UserUpdateAttributes.md index cff63d132f..6d40abb061 100644 --- a/docs/v2/UserUpdateAttributes.md +++ b/docs/v2/UserUpdateAttributes.md @@ -1,6 +1,7 @@ # UserUpdateAttributes Attributes of the edited user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserUpdateData.md b/docs/v2/UserUpdateData.md index e92cd06545..a1d5b8f393 100644 --- a/docs/v2/UserUpdateData.md +++ b/docs/v2/UserUpdateData.md @@ -1,6 +1,7 @@ # UserUpdateData Object to update a user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UserUpdateRequest.md b/docs/v2/UserUpdateRequest.md index c1836f22f1..d108c8cb0e 100644 --- a/docs/v2/UserUpdateRequest.md +++ b/docs/v2/UserUpdateRequest.md @@ -1,6 +1,7 @@ # UserUpdateRequest Update a user. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UsersApi.md b/docs/v2/UsersApi.md index 504d204f5b..a82362c3cc 100644 --- a/docs/v2/UsersApi.md +++ b/docs/v2/UsersApi.md @@ -80,6 +80,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->create_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -99,6 +100,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -153,6 +155,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->disable_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -172,6 +175,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -227,6 +231,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->get_invitation: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -246,6 +251,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -301,6 +307,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->get_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -320,6 +327,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -375,6 +383,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->list_user_organizations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -394,6 +403,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -449,6 +459,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->list_user_permissions: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -468,6 +479,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -529,6 +541,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->list_users: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -553,6 +566,7 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -610,6 +624,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->send_invitations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -629,6 +644,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -695,6 +711,7 @@ with ApiClient(configuration) as api_client: print("Exception when calling UsersApi->update_user: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -715,6 +732,7 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/v2/UsersResponse.md b/docs/v2/UsersResponse.md index f32a829525..28dbd53fd9 100644 --- a/docs/v2/UsersResponse.md +++ b/docs/v2/UsersResponse.md @@ -1,6 +1,7 @@ # UsersResponse Response containing information about multiple users. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/v2/UsersType.md b/docs/v2/UsersType.md index c220525966..c0e40e1cf9 100644 --- a/docs/v2/UsersType.md +++ b/docs/v2/UsersType.md @@ -1,6 +1,7 @@ # UsersType Users resource type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | -------------