Skip to content

Commit

Permalink
fix comments that had incorrect return type info
Browse files Browse the repository at this point in the history
  • Loading branch information
@tedchamb
tedchamb committed May 20, 2019
1 parent 19b21ac commit 4f311a8
Show file tree
Hide file tree
Showing 37 changed files with 402 additions and 402 deletions.
26 changes: 13 additions & 13 deletions azure-devops/azure/devops/released/cloud_load_test/cloud_load_test_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def __init__(self, base_url=None, creds=None):
def create_agent_group(self, group):
"""CreateAgentGroup.
:param :class:`<AgentGroup> <azure.devops.v5_0.cloud_load_test.models.AgentGroup>` group: Agent group to be created
:rtype: :class:`<AgentGroup> <azure.devops.v5_0.cloud-load-test.models.AgentGroup>`
:rtype: :class:`<AgentGroup> <azure.devops.v5_0.cloud_load_test.models.AgentGroup>`
"""
content = self._serialize.body(group, 'AgentGroup')
response = self._send(http_method='POST',
Expand Down Expand Up @@ -106,7 +106,7 @@ def get_static_agents(self, agent_group_id, agent_name=None):
def get_application(self, application_id):
"""GetApplication.
:param str application_id: Filter by APM application identifier.
:rtype: :class:`<Application> <azure.devops.v5_0.cloud-load-test.models.Application>`
:rtype: :class:`<Application> <azure.devops.v5_0.cloud_load_test.models.Application>`
"""
route_values = {}
if application_id is not None:
Expand Down Expand Up @@ -174,7 +174,7 @@ def get_counter_samples(self, counter_sample_query_details, test_run_id):
"""GetCounterSamples.
:param :class:`<VssJsonCollectionWrapper> <azure.devops.v5_0.cloud_load_test.models.VssJsonCollectionWrapper>` counter_sample_query_details:
:param str test_run_id: The test run identifier
:rtype: :class:`<CounterSamplesResult> <azure.devops.v5_0.cloud-load-test.models.CounterSamplesResult>`
:rtype: :class:`<CounterSamplesResult> <azure.devops.v5_0.cloud_load_test.models.CounterSamplesResult>`
"""
route_values = {}
if test_run_id is not None:
Expand All @@ -193,7 +193,7 @@ def get_load_test_run_errors(self, test_run_id, type=None, sub_type=None, detail
:param str type: Filter for the particular type of errors.
:param str sub_type: Filter for a particular subtype of errors. You should not provide error subtype without error type.
:param bool detailed: To include the details of test errors such as messagetext, request, stacktrace, testcasename, scenarioname, and lasterrordate.
:rtype: :class:`<LoadTestErrors> <azure.devops.v5_0.cloud-load-test.models.LoadTestErrors>`
:rtype: :class:`<LoadTestErrors> <azure.devops.v5_0.cloud_load_test.models.LoadTestErrors>`
"""
route_values = {}
if test_run_id is not None:
Expand Down Expand Up @@ -229,7 +229,7 @@ def get_test_run_messages(self, test_run_id):
def get_plugin(self, type):
"""GetPlugin.
:param str type: Currently ApplicationInsights is the only available plugin type.
:rtype: :class:`<ApplicationType> <azure.devops.v5_0.cloud-load-test.models.ApplicationType>`
:rtype: :class:`<ApplicationType> <azure.devops.v5_0.cloud_load_test.models.ApplicationType>`
"""
route_values = {}
if type is not None:
Expand All @@ -252,7 +252,7 @@ def get_plugins(self):
def get_load_test_result(self, test_run_id):
"""GetLoadTestResult.
:param str test_run_id: The test run identifier
:rtype: :class:`<TestResults> <azure.devops.v5_0.cloud-load-test.models.TestResults>`
:rtype: :class:`<TestResults> <azure.devops.v5_0.cloud_load_test.models.TestResults>`
"""
route_values = {}
if test_run_id is not None:
Expand All @@ -266,7 +266,7 @@ def get_load_test_result(self, test_run_id):
def create_test_definition(self, test_definition):
"""CreateTestDefinition.
:param :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>` test_definition: Test definition to be created
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud-load-test.models.TestDefinition>`
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>`
"""
content = self._serialize.body(test_definition, 'TestDefinition')
response = self._send(http_method='POST',
Expand All @@ -278,7 +278,7 @@ def create_test_definition(self, test_definition):
def get_test_definition(self, test_definition_id):
"""GetTestDefinition.
:param str test_definition_id: The test definition identifier
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud-load-test.models.TestDefinition>`
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>`
"""
route_values = {}
if test_definition_id is not None:
Expand Down Expand Up @@ -312,7 +312,7 @@ def get_test_definitions(self, from_date=None, to_date=None, top=None):
def update_test_definition(self, test_definition):
"""UpdateTestDefinition.
:param :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>` test_definition:
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud-load-test.models.TestDefinition>`
:rtype: :class:`<TestDefinition> <azure.devops.v5_0.cloud_load_test.models.TestDefinition>`
"""
content = self._serialize.body(test_definition, 'TestDefinition')
response = self._send(http_method='PUT',
Expand All @@ -324,7 +324,7 @@ def update_test_definition(self, test_definition):
def create_test_drop(self, web_test_drop):
"""CreateTestDrop.
:param :class:`<TestDrop> <azure.devops.v5_0.cloud_load_test.models.TestDrop>` web_test_drop: Test drop to be created
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud-load-test.models.TestDrop>`
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud_load_test.models.TestDrop>`
"""
content = self._serialize.body(web_test_drop, 'TestDrop')
response = self._send(http_method='POST',
Expand All @@ -336,7 +336,7 @@ def create_test_drop(self, web_test_drop):
def get_test_drop(self, test_drop_id):
"""GetTestDrop.
:param str test_drop_id: The test drop identifier
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud-load-test.models.TestDrop>`
:rtype: :class:`<TestDrop> <azure.devops.v5_0.cloud_load_test.models.TestDrop>`
"""
route_values = {}
if test_drop_id is not None:
Expand All @@ -350,7 +350,7 @@ def get_test_drop(self, test_drop_id):
def create_test_run(self, web_test_run):
"""CreateTestRun.
:param :class:`<TestRun> <azure.devops.v5_0.cloud_load_test.models.TestRun>` web_test_run:
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud-load-test.models.TestRun>`
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud_load_test.models.TestRun>`
"""
content = self._serialize.body(web_test_run, 'TestRun')
response = self._send(http_method='POST',
Expand All @@ -362,7 +362,7 @@ def create_test_run(self, web_test_run):
def get_test_run(self, test_run_id):
"""GetTestRun.
:param str test_run_id: Unique ID of the test run
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud-load-test.models.TestRun>`
:rtype: :class:`<TestRun> <azure.devops.v5_0.cloud_load_test.models.TestRun>`
"""
route_values = {}
if test_run_id is not None:
Expand Down
26 changes: 13 additions & 13 deletions azure-devops/azure/devops/released/service_hooks/service_hooks_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def get_consumer_action(self, consumer_id, consumer_action_id, publisher_id=None
:param str consumer_id: ID for a consumer.
:param str consumer_action_id: ID for a consumerActionId.
:param str publisher_id:
:rtype: :class:`<ConsumerAction> <azure.devops.v5_0.service-hooks.models.ConsumerAction>`
:rtype: :class:`<ConsumerAction> <azure.devops.v5_0.service_hooks.models.ConsumerAction>`
"""
route_values = {}
if consumer_id is not None:
Expand Down Expand Up @@ -73,7 +73,7 @@ def get_consumer(self, consumer_id, publisher_id=None):
Get a specific consumer service. Optionally filter out consumer actions that do not support any event types for the specified publisher.
:param str consumer_id: ID for a consumer.
:param str publisher_id:
:rtype: :class:`<Consumer> <azure.devops.v5_0.service-hooks.models.Consumer>`
:rtype: :class:`<Consumer> <azure.devops.v5_0.service_hooks.models.Consumer>`
"""
route_values = {}
if consumer_id is not None:
Expand Down Expand Up @@ -108,7 +108,7 @@ def get_event_type(self, publisher_id, event_type_id):
Get a specific event type.
:param str publisher_id: ID for a publisher.
:param str event_type_id:
:rtype: :class:`<EventTypeDescriptor> <azure.devops.v5_0.service-hooks.models.EventTypeDescriptor>`
:rtype: :class:`<EventTypeDescriptor> <azure.devops.v5_0.service_hooks.models.EventTypeDescriptor>`
"""
route_values = {}
if publisher_id is not None:
Expand Down Expand Up @@ -141,7 +141,7 @@ def get_notification(self, subscription_id, notification_id):
Get a specific notification for a subscription.
:param str subscription_id: ID for a subscription.
:param int notification_id:
:rtype: :class:`<Notification> <azure.devops.v5_0.service-hooks.models.Notification>`
:rtype: :class:`<Notification> <azure.devops.v5_0.service_hooks.models.Notification>`
"""
route_values = {}
if subscription_id is not None:
Expand Down Expand Up @@ -184,7 +184,7 @@ def query_notifications(self, query):
"""QueryNotifications.
Query for notifications. A notification includes details about the event, the request to and the response from the consumer service.
:param :class:`<NotificationsQuery> <azure.devops.v5_0.service_hooks.models.NotificationsQuery>` query:
:rtype: :class:`<NotificationsQuery> <azure.devops.v5_0.service-hooks.models.NotificationsQuery>`
:rtype: :class:`<NotificationsQuery> <azure.devops.v5_0.service_hooks.models.NotificationsQuery>`
"""
content = self._serialize.body(query, 'NotificationsQuery')
response = self._send(http_method='POST',
Expand All @@ -197,7 +197,7 @@ def query_input_values(self, input_values_query, publisher_id):
"""QueryInputValues.
:param :class:`<InputValuesQuery> <azure.devops.v5_0.service_hooks.models.InputValuesQuery>` input_values_query:
:param str publisher_id:
:rtype: :class:`<InputValuesQuery> <azure.devops.v5_0.service-hooks.models.InputValuesQuery>`
:rtype: :class:`<InputValuesQuery> <azure.devops.v5_0.service_hooks.models.InputValuesQuery>`
"""
route_values = {}
if publisher_id is not None:
Expand All @@ -214,7 +214,7 @@ def get_publisher(self, publisher_id):
"""GetPublisher.
Get a specific service hooks publisher.
:param str publisher_id: ID for a publisher.
:rtype: :class:`<Publisher> <azure.devops.v5_0.service-hooks.models.Publisher>`
:rtype: :class:`<Publisher> <azure.devops.v5_0.service_hooks.models.Publisher>`
"""
route_values = {}
if publisher_id is not None:
Expand All @@ -239,7 +239,7 @@ def query_publishers(self, query):
"""QueryPublishers.
Query for service hook publishers.
:param :class:`<PublishersQuery> <azure.devops.v5_0.service_hooks.models.PublishersQuery>` query:
:rtype: :class:`<PublishersQuery> <azure.devops.v5_0.service-hooks.models.PublishersQuery>`
:rtype: :class:`<PublishersQuery> <azure.devops.v5_0.service_hooks.models.PublishersQuery>`
"""
content = self._serialize.body(query, 'PublishersQuery')
response = self._send(http_method='POST',
Expand All @@ -252,7 +252,7 @@ def create_subscription(self, subscription):
"""CreateSubscription.
Create a subscription.
:param :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>` subscription: Subscription to be created.
:rtype: :class:`<Subscription> <azure.devops.v5_0.service-hooks.models.Subscription>`
:rtype: :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>`
"""
content = self._serialize.body(subscription, 'Subscription')
response = self._send(http_method='POST',
Expand All @@ -278,7 +278,7 @@ def get_subscription(self, subscription_id):
"""GetSubscription.
Get a specific service hooks subscription.
:param str subscription_id: ID for a subscription.
:rtype: :class:`<Subscription> <azure.devops.v5_0.service-hooks.models.Subscription>`
:rtype: :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>`
"""
route_values = {}
if subscription_id is not None:
Expand Down Expand Up @@ -318,7 +318,7 @@ def replace_subscription(self, subscription, subscription_id=None):
Update a subscription. <param name="subscriptionId">ID for a subscription that you wish to update.</param>
:param :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>` subscription:
:param str subscription_id:
:rtype: :class:`<Subscription> <azure.devops.v5_0.service-hooks.models.Subscription>`
:rtype: :class:`<Subscription> <azure.devops.v5_0.service_hooks.models.Subscription>`
"""
route_values = {}
if subscription_id is not None:
Expand All @@ -335,7 +335,7 @@ def create_subscriptions_query(self, query):
"""CreateSubscriptionsQuery.
Query for service hook subscriptions.
:param :class:`<SubscriptionsQuery> <azure.devops.v5_0.service_hooks.models.SubscriptionsQuery>` query:
:rtype: :class:`<SubscriptionsQuery> <azure.devops.v5_0.service-hooks.models.SubscriptionsQuery>`
:rtype: :class:`<SubscriptionsQuery> <azure.devops.v5_0.service_hooks.models.SubscriptionsQuery>`
"""
content = self._serialize.body(query, 'SubscriptionsQuery')
response = self._send(http_method='POST',
Expand All @@ -349,7 +349,7 @@ def create_test_notification(self, test_notification, use_real_data=None):
Sends a test notification. This is useful for verifying the configuration of an updated or new service hooks subscription.
:param :class:`<Notification> <azure.devops.v5_0.service_hooks.models.Notification>` test_notification:
:param bool use_real_data: Only allow testing with real data in existing subscriptions.
:rtype: :class:`<Notification> <azure.devops.v5_0.service-hooks.models.Notification>`
:rtype: :class:`<Notification> <azure.devops.v5_0.service_hooks.models.Notification>`
"""
query_parameters = {}
if use_real_data is not None:
Expand Down
Loading

0 comments on commit 4f311a8

Please sign in to comment.