Skip to content

Commit

Permalink
doc(sdk/client): fix kfp-server-api py client's docstring format (#4047)
Browse files Browse the repository at this point in the history
* Pull templates from upstream 4.3.1

* update templates according to OpenAPITools/openapi-generator/pull/6391

* regenerate python client
  • Loading branch information
Bobgy authored Jun 23, 2020
1 parent 782dec0 commit f456ee9
Show file tree
Hide file tree
Showing 35 changed files with 1,287 additions and 371 deletions.

Large diffs are not rendered by default.

162 changes: 116 additions & 46 deletions backend/api/python_http_client/kfp_server_api/api/job_service_api.py

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -55,23 +55,29 @@ def upload_pipeline(self, uploadfile, **kwargs): # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline(uploadfile, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param file uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:param str name:
:param str description:
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param description:
:type description: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
: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.
:return: ApiPipeline
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: ApiPipeline
"""
kwargs['_return_http_data_only'] = True
return self.upload_pipeline_with_http_info(uploadfile, **kwargs) # noqa: E501
Expand All @@ -81,25 +87,33 @@ def upload_pipeline_with_http_info(self, uploadfile, **kwargs): # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline_with_http_info(uploadfile, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param file uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:param str name:
:param str description:
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param description:
:type description: str
:param async_req: Whether to execute the 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 _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.
:return: tuple(ApiPipeline, status_code(int), headers(HTTPHeaderDict))
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(ApiPipeline, status_code(int), headers(HTTPHeaderDict))
"""

local_var_params = locals()
Expand Down Expand Up @@ -181,23 +195,29 @@ def upload_pipeline_version(self, uploadfile, **kwargs): # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline_version(uploadfile, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param file uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:param str name:
:param str pipelineid:
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param pipelineid:
:type pipelineid: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
: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.
:return: ApiPipelineVersion
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: ApiPipelineVersion
"""
kwargs['_return_http_data_only'] = True
return self.upload_pipeline_version_with_http_info(uploadfile, **kwargs) # noqa: E501
Expand All @@ -207,25 +227,33 @@ def upload_pipeline_version_with_http_info(self, uploadfile, **kwargs): # noqa:
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline_version_with_http_info(uploadfile, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param file uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:param str name:
:param str pipelineid:
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param pipelineid:
:type pipelineid: str
:param async_req: Whether to execute the 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 _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.
:return: tuple(ApiPipelineVersion, status_code(int), headers(HTTPHeaderDict))
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(ApiPipelineVersion, status_code(int), headers(HTTPHeaderDict))
"""

local_var_params = locals()
Expand Down
Loading

0 comments on commit f456ee9

Please sign in to comment.