From 6f0755465e598c1f6c78c94a0c8aabd70a4a2b18 Mon Sep 17 00:00:00 2001 From: Ted Chambers Date: Mon, 1 Jul 2019 12:51:25 -0400 Subject: [PATCH] fix model comments. --- .../azure/devops/v5_1/accounts/models.py | 9 +- .../azure/devops/v5_1/build/models.py | 228 ++++++----- azure-devops/azure/devops/v5_1/cix/models.py | 57 ++- .../azure/devops/v5_1/client_trace/models.py | 3 +- .../devops/v5_1/cloud_load_test/models.py | 144 +++---- .../azure/devops/v5_1/contributions/models.py | 75 ++-- azure-devops/azure/devops/v5_1/core/models.py | 81 ++-- .../v5_1/customer_intelligence/models.py | 3 +- .../azure/devops/v5_1/dashboard/models.py | 51 +-- .../v5_1/extension_management/models.py | 120 +++--- .../v5_1/feature_availability/models.py | 6 +- .../devops/v5_1/feature_management/models.py | 24 +- azure-devops/azure/devops/v5_1/feed/models.py | 93 +++-- .../azure/devops/v5_1/feed_token/models.py | 3 +- .../devops/v5_1/file_container/models.py | 6 +- .../azure/devops/v5_1/gallery/models.py | 192 +++++---- azure-devops/azure/devops/v5_1/git/models.py | 324 ++++++++-------- .../azure/devops/v5_1/graph/models.py | 75 ++-- .../azure/devops/v5_1/identity/models.py | 57 ++- .../azure/devops/v5_1/location/models.py | 24 +- .../azure/devops/v5_1/maven/models.py | 87 ++--- .../member_entitlement_management/models.py | 111 +++--- .../azure/devops/v5_1/notification/models.py | 186 ++++----- azure-devops/azure/devops/v5_1/npm/models.py | 33 +- .../azure/devops/v5_1/nuget/models.py | 33 +- .../azure/devops/v5_1/operations/models.py | 12 +- .../azure/devops/v5_1/pipelines/models.py | 57 ++- .../azure/devops/v5_1/policy/models.py | 27 +- .../azure/devops/v5_1/profile/models.py | 33 +- .../devops/v5_1/profile_regions/models.py | 9 +- .../devops/v5_1/project_analysis/models.py | 21 +- .../azure/devops/v5_1/provenance/models.py | 6 +- .../azure/devops/v5_1/py_pi_api/models.py | 30 +- .../azure/devops/v5_1/release/models.py | 288 +++++--------- .../azure/devops/v5_1/security/models.py | 24 +- .../devops/v5_1/service_endpoint/models.py | 123 +++--- .../azure/devops/v5_1/service_hooks/models.py | 105 +++-- .../azure/devops/v5_1/symbol/models.py | 21 +- azure-devops/azure/devops/v5_1/task/models.py | 84 ++-- .../azure/devops/v5_1/task_agent/models.py | 363 ++++++++---------- azure-devops/azure/devops/v5_1/test/models.py | 345 +++++++++-------- .../azure/devops/v5_1/test_plan/models.py | 162 +++++--- .../azure/devops/v5_1/test_results/models.py | 261 +++++++------ azure-devops/azure/devops/v5_1/tfvc/models.py | 117 +++--- .../azure/devops/v5_1/universal/models.py | 27 +- .../devops/v5_1/upack_packaging/models.py | 15 +- azure-devops/azure/devops/v5_1/wiki/models.py | 48 ++- azure-devops/azure/devops/v5_1/work/models.py | 213 +++++----- .../devops/v5_1/work_item_tracking/models.py | 240 +++++++----- .../v5_1/work_item_tracking_process/models.py | 129 ++++--- .../models.py | 18 +- 51 files changed, 2468 insertions(+), 2335 deletions(-) diff --git a/azure-devops/azure/devops/v5_1/accounts/models.py b/azure-devops/azure/devops/v5_1/accounts/models.py index 385e5db2..07715637 100644 --- a/azure-devops/azure/devops/v5_1/accounts/models.py +++ b/azure-devops/azure/devops/v5_1/accounts/models.py @@ -10,8 +10,7 @@ class Account(Model): - """Account. - + """ :param account_id: Identifier for an Account :type account_id: str :param account_name: Name for an account @@ -86,8 +85,7 @@ def __init__(self, account_id=None, account_name=None, account_owner=None, accou class AccountCreateInfoInternal(Model): - """AccountCreateInfoInternal. - + """ :param account_name: :type account_name: str :param creator: @@ -122,8 +120,7 @@ def __init__(self, account_name=None, creator=None, organization=None, preferenc class AccountPreferencesInternal(Model): - """AccountPreferencesInternal. - + """ :param culture: :type culture: object :param language: diff --git a/azure-devops/azure/devops/v5_1/build/models.py b/azure-devops/azure/devops/v5_1/build/models.py index 4bf17707..1f50de08 100644 --- a/azure-devops/azure/devops/v5_1/build/models.py +++ b/azure-devops/azure/devops/v5_1/build/models.py @@ -10,7 +10,8 @@ class AgentPoolQueue(Model): - """AgentPoolQueue. + """ + Represents a queue for running builds. :param _links: :type _links: :class:`ReferenceLinks ` @@ -42,7 +43,8 @@ def __init__(self, _links=None, id=None, name=None, pool=None, url=None): class AgentSpecification(Model): - """AgentSpecification. + """ + Specification of the agent defined by the pool provider. :param identifier: Agent specification unique identifier. :type identifier: str @@ -58,8 +60,7 @@ def __init__(self, identifier=None): class AggregatedResultsAnalysis(Model): - """AggregatedResultsAnalysis. - + """ :param duration: :type duration: object :param not_reported_results_by_outcome: @@ -102,8 +103,7 @@ def __init__(self, duration=None, not_reported_results_by_outcome=None, previous class AggregatedResultsByOutcome(Model): - """AggregatedResultsByOutcome. - + """ :param count: :type count: int :param duration: @@ -138,8 +138,7 @@ def __init__(self, count=None, duration=None, group_by_field=None, group_by_valu class AggregatedResultsDifference(Model): - """AggregatedResultsDifference. - + """ :param increase_in_duration: :type increase_in_duration: object :param increase_in_failures: @@ -170,8 +169,7 @@ def __init__(self, increase_in_duration=None, increase_in_failures=None, increas class AggregatedRunsByOutcome(Model): - """AggregatedRunsByOutcome. - + """ :param outcome: :type outcome: object :param runs_count: @@ -190,8 +188,7 @@ def __init__(self, outcome=None, runs_count=None): class AggregatedRunsByState(Model): - """AggregatedRunsByState. - + """ :param results_by_outcome: :type results_by_outcome: dict :param runs_count: @@ -214,8 +211,7 @@ def __init__(self, results_by_outcome=None, runs_count=None, state=None): class ArtifactResource(Model): - """ArtifactResource. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param data: Type-specific data about the artifact. @@ -250,8 +246,7 @@ def __init__(self, _links=None, data=None, download_url=None, properties=None, t class AssociatedWorkItem(Model): - """AssociatedWorkItem. - + """ :param assigned_to: :type assigned_to: str :param id: Id of associated the work item. @@ -290,7 +285,8 @@ def __init__(self, assigned_to=None, id=None, state=None, title=None, url=None, class Attachment(Model): - """Attachment. + """ + Represents an attachment to a build. :param _links: :type _links: :class:`ReferenceLinks ` @@ -310,8 +306,7 @@ def __init__(self, _links=None, name=None): class AuthorizationHeader(Model): - """AuthorizationHeader. - + """ :param name: :type name: str :param value: @@ -330,7 +325,8 @@ def __init__(self, name=None, value=None): class Build(Model): - """Build. + """ + Data representation of a build. :param _links: :type _links: :class:`ReferenceLinks ` @@ -518,7 +514,8 @@ def __init__(self, _links=None, agent_specification=None, build_number=None, bui class BuildArtifact(Model): - """BuildArtifact. + """ + Represents an artifact produced by a build. :param id: The artifact ID. :type id: int @@ -546,7 +543,8 @@ def __init__(self, id=None, name=None, resource=None, source=None): class BuildBadge(Model): - """BuildBadge. + """ + Represents a build badge. :param build_id: The ID of the build represented by this badge. :type build_id: int @@ -566,7 +564,8 @@ def __init__(self, build_id=None, image_url=None): class BuildDefinitionRevision(Model): - """BuildDefinitionRevision. + """ + Represents a revision of a build definition. :param changed_by: The identity of the person or process that changed the definition. :type changed_by: :class:`IdentityRef ` @@ -606,7 +605,8 @@ def __init__(self, changed_by=None, changed_date=None, change_type=None, comment class BuildDefinitionStep(Model): - """BuildDefinitionStep. + """ + Represents a step in a build phase. :param always_run: Indicates whether this step should run even if a previous step fails. :type always_run: bool @@ -658,7 +658,8 @@ def __init__(self, always_run=None, condition=None, continue_on_error=None, disp class BuildDefinitionTemplate(Model): - """BuildDefinitionTemplate. + """ + Represents a template from which new build definitions can be created. :param can_delete: Indicates whether the template can be deleted. :type can_delete: bool @@ -706,7 +707,8 @@ def __init__(self, can_delete=None, category=None, default_hosted_queue=None, de class BuildDefinitionTemplate3_2(Model): - """BuildDefinitionTemplate3_2. + """ + For back-compat with extensions that use the old Steps format instead of Process and Phases :param can_delete: :type can_delete: bool @@ -754,7 +756,8 @@ def __init__(self, can_delete=None, category=None, default_hosted_queue=None, de class BuildDefinitionVariable(Model): - """BuildDefinitionVariable. + """ + Represents a variable used by a build definition. :param allow_override: Indicates whether the value can be set at queue time. :type allow_override: bool @@ -778,7 +781,8 @@ def __init__(self, allow_override=None, is_secret=None, value=None): class BuildLogReference(Model): - """BuildLogReference. + """ + Represents a reference to a build log. :param id: The ID of the log. :type id: int @@ -802,7 +806,8 @@ def __init__(self, id=None, type=None, url=None): class BuildMetric(Model): - """BuildMetric. + """ + Represents metadata about builds in the system. :param date: The date for the scope. :type date: datetime @@ -830,7 +835,8 @@ def __init__(self, date=None, int_value=None, name=None, scope=None): class BuildOption(Model): - """BuildOption. + """ + Represents the application of an optional behavior to a build definition. :param definition: A reference to the build option. :type definition: :class:`BuildOptionDefinitionReference ` @@ -854,7 +860,8 @@ def __init__(self, definition=None, enabled=None, inputs=None): class BuildOptionDefinitionReference(Model): - """BuildOptionDefinitionReference. + """ + Represents a reference to a build option definition. :param id: The ID of the referenced build option. :type id: str @@ -870,7 +877,8 @@ def __init__(self, id=None): class BuildOptionGroupDefinition(Model): - """BuildOptionGroupDefinition. + """ + Represents a group of inputs for a build option. :param display_name: The name of the group to display in the UI. :type display_name: str @@ -894,7 +902,8 @@ def __init__(self, display_name=None, is_expanded=None, name=None): class BuildOptionInputDefinition(Model): - """BuildOptionInputDefinition. + """ + Represents an input for a build option. :param default_value: The default value. :type default_value: str @@ -942,7 +951,8 @@ def __init__(self, default_value=None, group_name=None, help=None, label=None, n class BuildReportMetadata(Model): - """BuildReportMetadata. + """ + Represents information about a build report. :param build_id: The Id of the build. :type build_id: int @@ -966,7 +976,8 @@ def __init__(self, build_id=None, content=None, type=None): class BuildRepository(Model): - """BuildRepository. + """ + Represents a repository used by a build definition. :param checkout_submodules: Indicates whether to checkout submodules. :type checkout_submodules: bool @@ -1014,7 +1025,8 @@ def __init__(self, checkout_submodules=None, clean=None, default_branch=None, id class BuildRequestValidationResult(Model): - """BuildRequestValidationResult. + """ + Represents the result of validating a build request. :param message: The message associated with the result. :type message: str @@ -1034,7 +1046,8 @@ def __init__(self, message=None, result=None): class BuildResourceUsage(Model): - """BuildResourceUsage. + """ + Represents information about resources used by builds in the system. :param distributed_task_agents: The number of build agents. :type distributed_task_agents: int @@ -1062,7 +1075,8 @@ def __init__(self, distributed_task_agents=None, paid_private_agent_slots=None, class BuildSettings(Model): - """BuildSettings. + """ + Represents system-wide build settings. :param days_to_keep_deleted_builds_before_destroy: The number of days to keep records of deleted builds. :type days_to_keep_deleted_builds_before_destroy: int @@ -1086,7 +1100,8 @@ def __init__(self, days_to_keep_deleted_builds_before_destroy=None, default_rete class Change(Model): - """Change. + """ + Represents a change associated with a build. :param author: The author of the change. :type author: :class:`IdentityRef ` @@ -1134,7 +1149,8 @@ def __init__(self, author=None, display_uri=None, id=None, location=None, messag class DataSourceBindingBase(Model): - """DataSourceBindingBase. + """ + Represents binding of data source for the service endpoint request. :param callback_context_template: Pagination format supported by this data source(ContinuationToken/SkipTop). :type callback_context_template: str @@ -1198,7 +1214,8 @@ def __init__(self, callback_context_template=None, callback_required_template=No class DefinitionReference(Model): - """DefinitionReference. + """ + Represents a reference to a definition. :param created_date: The date this version of the definition was created. :type created_date: datetime @@ -1250,8 +1267,7 @@ def __init__(self, created_date=None, id=None, name=None, path=None, project=Non class DefinitionResourceReference(Model): - """DefinitionResourceReference. - + """ :param authorized: Indicates whether the resource is authorized for use. :type authorized: bool :param id: The id of the resource. @@ -1278,7 +1294,8 @@ def __init__(self, authorized=None, id=None, name=None, type=None): class Deployment(Model): - """Deployment. + """ + Represents the data from the build information nodes for type "DeploymentInformation" for xaml builds :param type: :type type: str @@ -1294,7 +1311,8 @@ def __init__(self, type=None): class Folder(Model): - """Folder. + """ + Represents a folder that contains build definitions. :param created_by: The process or person who created the folder. :type created_by: :class:`IdentityRef ` @@ -1334,8 +1352,7 @@ def __init__(self, created_by=None, created_on=None, description=None, last_chan class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -1362,8 +1379,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -1422,7 +1438,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class Issue(Model): - """Issue. + """ + Represents an issue (error, warning) associated with a build. :param category: The category. :type category: str @@ -1450,7 +1467,8 @@ def __init__(self, category=None, data=None, message=None, type=None): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -1478,8 +1496,7 @@ def __init__(self, from_=None, op=None, path=None, value=None): class ProcessParameters(Model): - """ProcessParameters. - + """ :param data_source_bindings: :type data_source_bindings: list of :class:`DataSourceBindingBase ` :param inputs: @@ -1502,7 +1519,8 @@ def __init__(self, data_source_bindings=None, inputs=None, source_definitions=No class PullRequest(Model): - """PullRequest. + """ + Represents a pull request object. These are retrieved from Source Providers. :param _links: The links to other objects related to this object. :type _links: :class:`ReferenceLinks ` @@ -1558,7 +1576,8 @@ def __init__(self, _links=None, author=None, current_state=None, description=Non class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -1574,7 +1593,8 @@ def __init__(self, links=None): class ReleaseReference(Model): - """ReleaseReference. + """ + Reference to a release. :param attempt: Number of Release Attempt. :type attempt: int @@ -1626,7 +1646,8 @@ def __init__(self, attempt=None, creation_date=None, definition_id=None, environ class RepositoryWebhook(Model): - """RepositoryWebhook. + """ + Represents a repository's webhook returned from a source provider. :param name: The friendly name of the repository. :type name: str @@ -1650,8 +1671,7 @@ def __init__(self, name=None, types=None, url=None): class ResourceRef(Model): - """ResourceRef. - + """ :param id: :type id: str :param url: @@ -1670,7 +1690,8 @@ def __init__(self, id=None, url=None): class RetentionPolicy(Model): - """RetentionPolicy. + """ + Represents a retention policy for a build definition. :param artifacts: :type artifacts: list of str @@ -1710,8 +1731,7 @@ def __init__(self, artifacts=None, artifact_types_to_delete=None, branches=None, class SourceProviderAttributes(Model): - """SourceProviderAttributes. - + """ :param name: The name of the source provider. :type name: str :param supported_capabilities: The capabilities supported by this source provider. @@ -1734,7 +1754,8 @@ def __init__(self, name=None, supported_capabilities=None, supported_triggers=No class SourceRepositories(Model): - """SourceRepositories. + """ + A set of repositories returned from the source provider. :param continuation_token: A token used to continue this paged request; 'null' if the request is complete :type continuation_token: str @@ -1762,7 +1783,8 @@ def __init__(self, continuation_token=None, page_length=None, repositories=None, class SourceRepository(Model): - """SourceRepository. + """ + Represents a repository returned from a source provider. :param default_branch: The name of the default branch. :type default_branch: str @@ -1802,7 +1824,8 @@ def __init__(self, default_branch=None, full_name=None, id=None, name=None, prop class SourceRepositoryItem(Model): - """SourceRepositoryItem. + """ + Represents an item in a repository from a source provider. :param is_container: Whether the item is able to have sub-items (e.g., is a folder). :type is_container: bool @@ -1830,8 +1853,7 @@ def __init__(self, is_container=None, path=None, type=None, url=None): class SupportedTrigger(Model): - """SupportedTrigger. - + """ :param default_polling_interval: The default interval to wait between polls (only relevant when NotificationType is Polling). :type default_polling_interval: int :param notification_type: How the trigger is notified of changes. @@ -1858,7 +1880,8 @@ def __init__(self, default_polling_interval=None, notification_type=None, suppor class TaskAgentPoolReference(Model): - """TaskAgentPoolReference. + """ + Represents a reference to an agent pool. :param id: The pool ID. :type id: int @@ -1882,7 +1905,8 @@ def __init__(self, id=None, is_hosted=None, name=None): class TaskDefinitionReference(Model): - """TaskDefinitionReference. + """ + A reference to a task definition. :param definition_type: The type of task (task or task group). :type definition_type: str @@ -1906,8 +1930,7 @@ def __init__(self, definition_type=None, id=None, version_spec=None): class TaskInputDefinitionBase(Model): - """TaskInputDefinitionBase. - + """ :param aliases: :type aliases: list of str :param default_value: @@ -1966,8 +1989,7 @@ def __init__(self, aliases=None, default_value=None, group_name=None, help_mark_ class TaskInputValidation(Model): - """TaskInputValidation. - + """ :param expression: Conditional expression :type expression: str :param message: Message explaining how user can correct if validation fails @@ -1986,7 +2008,8 @@ def __init__(self, expression=None, message=None): class TaskOrchestrationPlanReference(Model): - """TaskOrchestrationPlanReference. + """ + Represents a reference to an orchestration plan. :param orchestration_type: The type of the plan. :type orchestration_type: int @@ -2006,7 +2029,8 @@ def __init__(self, orchestration_type=None, plan_id=None): class TaskReference(Model): - """TaskReference. + """ + Represents a reference to a task. :param id: The ID of the task definition. :type id: str @@ -2030,8 +2054,7 @@ def __init__(self, id=None, name=None, version=None): class TaskSourceDefinitionBase(Model): - """TaskSourceDefinitionBase. - + """ :param auth_key: :type auth_key: str :param endpoint: @@ -2062,7 +2085,8 @@ def __init__(self, auth_key=None, endpoint=None, key_selector=None, selector=Non class TeamProjectReference(Model): - """TeamProjectReference. + """ + Represents a shallow reference to a TeamProject. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -2114,8 +2138,7 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class TestResultsContext(Model): - """TestResultsContext. - + """ :param build: :type build: :class:`BuildReference ` :param context_type: @@ -2138,8 +2161,7 @@ def __init__(self, build=None, context_type=None, release=None): class TimelineAttempt(Model): - """TimelineAttempt. - + """ :param attempt: Gets or sets the attempt of the record. :type attempt: int :param record_id: Gets or sets the record identifier located within the specified timeline. @@ -2162,7 +2184,8 @@ def __init__(self, attempt=None, record_id=None, timeline_id=None): class TimelineRecord(Model): - """TimelineRecord. + """ + Represents an entry in a build's timeline. :param _links: :type _links: :class:`ReferenceLinks ` @@ -2278,7 +2301,8 @@ def __init__(self, _links=None, attempt=None, change_id=None, current_operation= class TimelineReference(Model): - """TimelineReference. + """ + Represents a reference to a timeline. :param change_id: The change ID. :type change_id: int @@ -2302,7 +2326,8 @@ def __init__(self, change_id=None, id=None, url=None): class VariableGroupReference(Model): - """VariableGroupReference. + """ + Represents a reference to a variable group. :param alias: The Name of the variable group. :type alias: str @@ -2322,8 +2347,7 @@ def __init__(self, alias=None, id=None): class WebApiConnectedServiceRef(Model): - """WebApiConnectedServiceRef. - + """ :param id: :type id: str :param url: @@ -2342,8 +2366,7 @@ def __init__(self, id=None, url=None): class XamlBuildControllerReference(Model): - """XamlBuildControllerReference. - + """ :param id: Id of the resource :type id: int :param name: Name of the linked resource (definition name, controller name, etc.) @@ -2366,8 +2389,7 @@ def __init__(self, id=None, name=None, url=None): class BuildController(XamlBuildControllerReference): - """BuildController. - + """ :param id: Id of the resource :type id: int :param name: Name of the linked resource (definition name, controller name, etc.) @@ -2415,7 +2437,8 @@ def __init__(self, id=None, name=None, url=None, _links=None, created_date=None, class BuildDefinitionReference(DefinitionReference): - """BuildDefinitionReference. + """ + Represents a reference to a build definition. :param created_date: The date this version of the definition was created. :type created_date: datetime @@ -2493,7 +2516,8 @@ def __init__(self, created_date=None, id=None, name=None, path=None, project=Non class BuildDefinitionReference3_2(DefinitionReference): - """BuildDefinitionReference3_2. + """ + For back-compat with extensions that use the old Steps format instead of Process and Phases :param created_date: The date this version of the definition was created. :type created_date: datetime @@ -2563,7 +2587,8 @@ def __init__(self, created_date=None, id=None, name=None, path=None, project=Non class BuildLog(BuildLogReference): - """BuildLog. + """ + Represents a build log. :param id: The ID of the log. :type id: int @@ -2596,7 +2621,8 @@ def __init__(self, id=None, type=None, url=None, created_on=None, last_changed_o class BuildOptionDefinition(BuildOptionDefinitionReference): - """BuildOptionDefinition. + """ + Represents an optional behavior that can be applied to a build definition. :param id: The ID of the referenced build option. :type id: str @@ -2631,7 +2657,8 @@ def __init__(self, id=None, description=None, groups=None, inputs=None, name=Non class Timeline(TimelineReference): - """Timeline. + """ + Represents the timeline of a build. :param change_id: The change ID. :type change_id: int @@ -2664,7 +2691,8 @@ def __init__(self, change_id=None, id=None, url=None, last_changed_by=None, last class VariableGroup(VariableGroupReference): - """VariableGroup. + """ + Represents a variable group. :param alias: The Name of the variable group. :type alias: str @@ -2698,7 +2726,8 @@ def __init__(self, alias=None, id=None, description=None, name=None, type=None, class BuildDefinition(BuildDefinitionReference): - """BuildDefinition. + """ + Represents a build definition. :param created_date: The date this version of the definition was created. :type created_date: datetime @@ -2843,7 +2872,8 @@ def __init__(self, created_date=None, id=None, name=None, path=None, project=Non class BuildDefinition3_2(BuildDefinitionReference3_2): - """BuildDefinition3_2. + """ + For back-compat with extensions that use the old Steps format instead of Process and Phases :param created_date: The date this version of the definition was created. :type created_date: datetime diff --git a/azure-devops/azure/devops/v5_1/cix/models.py b/azure-devops/azure/devops/v5_1/cix/models.py index 24b470f8..de698f2e 100644 --- a/azure-devops/azure/devops/v5_1/cix/models.py +++ b/azure-devops/azure/devops/v5_1/cix/models.py @@ -10,8 +10,7 @@ class ConfigurationFile(Model): - """ConfigurationFile. - + """ :param content: The content of the file. :type content: str :param is_base64_encoded: Indicates if the content is base64 encoded. @@ -34,8 +33,7 @@ def __init__(self, content=None, is_base64_encoded=None, path=None): class CreatedResources(Model): - """CreatedResources. - + """ :param resources: :type resources: dict """ @@ -50,7 +48,8 @@ def __init__(self, resources=None): class CreatePipelineConnectionInputs(Model): - """CreatePipelineConnectionInputs. + """ + This class is used to create a pipeline connection within the team project provided. If the team project does not exist, it will be created. :param project: The team project settings for an existing team project or for a new team project. :type project: :class:`TeamProject ` @@ -82,8 +81,7 @@ def __init__(self, project=None, provider_data=None, provider_id=None, redirect_ class DetectedBuildFramework(Model): - """DetectedBuildFramework. - + """ :param build_targets: List of build targets discovered for the framework to act upon. :type build_targets: list of :class:`DetectedBuildTarget ` :param id: The unique identifier of the build framework. @@ -110,8 +108,7 @@ def __init__(self, build_targets=None, id=None, settings=None, version=None): class DetectedBuildTarget(Model): - """DetectedBuildTarget. - + """ :param path: :type path: str :param settings: @@ -134,7 +131,8 @@ def __init__(self, path=None, settings=None, type=None): class OperationReference(Model): - """OperationReference. + """ + Reference for an async operation. :param id: Unique identifier for the operation. :type id: str @@ -162,8 +160,7 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None): class OperationResultReference(Model): - """OperationResultReference. - + """ :param result_url: URL to the operation result. :type result_url: str """ @@ -178,8 +175,7 @@ def __init__(self, result_url=None): class PipelineConnection(Model): - """PipelineConnection. - + """ :param account_id: The account id that contains the team project for the connection. :type account_id: str :param definition_id: The definition id that was created for the connection. @@ -210,7 +206,8 @@ def __init__(self, account_id=None, definition_id=None, redirect_url=None, servi class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -226,8 +223,7 @@ def __init__(self, links=None): class ResourceCreationParameter(Model): - """ResourceCreationParameter. - + """ :param resource_to_create: :type resource_to_create: :class:`object ` :param type: @@ -246,7 +242,8 @@ def __init__(self, resource_to_create=None, type=None): class TeamProjectReference(Model): - """TeamProjectReference. + """ + Represents a shallow reference to a TeamProject. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -298,8 +295,7 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class Template(Model): - """Template. - + """ :param assets: :type assets: list of :class:`TemplateAsset ` :param content: @@ -346,8 +342,7 @@ def __init__(self, assets=None, content=None, data_source_bindings=None, descrip class TemplateAsset(Model): - """TemplateAsset. - + """ :param content: :type content: str :param description: @@ -378,8 +373,7 @@ def __init__(self, content=None, description=None, destination_path=None, path=N class TemplateDataSourceBinding(Model): - """TemplateDataSourceBinding. - + """ :param data_source_name: :type data_source_name: str :param endpoint_parameter_name: @@ -410,8 +404,7 @@ def __init__(self, data_source_name=None, endpoint_parameter_name=None, paramete class TemplateParameterDefinition(Model): - """TemplateParameterDefinition. - + """ :param default_value: :type default_value: str :param display_name: @@ -446,8 +439,7 @@ def __init__(self, default_value=None, display_name=None, name=None, possible_va class TemplateParameters(Model): - """TemplateParameters. - + """ :param tokens: :type tokens: dict """ @@ -462,8 +454,7 @@ def __init__(self, tokens=None): class WebApiTeamRef(Model): - """WebApiTeamRef. - + """ :param id: Team (Identity) Guid. A Team Foundation ID. :type id: str :param name: Team name @@ -486,7 +477,8 @@ def __init__(self, id=None, name=None, url=None): class Operation(OperationReference): - """Operation. + """ + Contains information about the progress or result of an async operation. :param id: Unique identifier for the operation. :type id: str @@ -526,7 +518,8 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None, _links=None, class TeamProject(TeamProjectReference): - """TeamProject. + """ + Represents a Team Project object. :param abbreviation: Project abbreviation. :type abbreviation: str diff --git a/azure-devops/azure/devops/v5_1/client_trace/models.py b/azure-devops/azure/devops/v5_1/client_trace/models.py index d16e7a9f..32e0dec5 100644 --- a/azure-devops/azure/devops/v5_1/client_trace/models.py +++ b/azure-devops/azure/devops/v5_1/client_trace/models.py @@ -10,8 +10,7 @@ class ClientTraceEvent(Model): - """ClientTraceEvent. - + """ :param area: :type area: str :param component: diff --git a/azure-devops/azure/devops/v5_1/cloud_load_test/models.py b/azure-devops/azure/devops/v5_1/cloud_load_test/models.py index eb1d46bd..8481172a 100644 --- a/azure-devops/azure/devops/v5_1/cloud_load_test/models.py +++ b/azure-devops/azure/devops/v5_1/cloud_load_test/models.py @@ -10,8 +10,7 @@ class AgentGroup(Model): - """AgentGroup. - + """ :param created_by: :type created_by: IdentityRef :param creation_time: @@ -50,8 +49,7 @@ def __init__(self, created_by=None, creation_time=None, group_id=None, group_nam class AgentGroupAccessData(Model): - """AgentGroupAccessData. - + """ :param details: :type details: str :param storage_connection_string: @@ -82,8 +80,7 @@ def __init__(self, details=None, storage_connection_string=None, storage_end_poi class Application(Model): - """Application. - + """ :param application_id: :type application_id: str :param description: @@ -122,8 +119,7 @@ def __init__(self, application_id=None, description=None, name=None, path=None, class ApplicationCounters(Model): - """ApplicationCounters. - + """ :param application_id: :type application_id: str :param description: @@ -158,8 +154,7 @@ def __init__(self, application_id=None, description=None, id=None, is_default=No class ApplicationType(Model): - """ApplicationType. - + """ :param action_uri_link: :type action_uri_link: str :param aut_portal_link: @@ -194,8 +189,7 @@ def __init__(self, action_uri_link=None, aut_portal_link=None, is_enabled=None, class BrowserMix(Model): - """BrowserMix. - + """ :param browser_name: :type browser_name: str :param browser_percentage: @@ -214,8 +208,7 @@ def __init__(self, browser_name=None, browser_percentage=None): class CltCustomerIntelligenceData(Model): - """CltCustomerIntelligenceData. - + """ :param area: :type area: str :param feature: @@ -238,8 +231,7 @@ def __init__(self, area=None, feature=None, properties=None): class CounterGroup(Model): - """CounterGroup. - + """ :param group_name: :type group_name: str :param url: @@ -258,8 +250,7 @@ def __init__(self, group_name=None, url=None): class CounterInstanceSamples(Model): - """CounterInstanceSamples. - + """ :param count: :type count: int :param counter_instance_id: @@ -286,8 +277,7 @@ def __init__(self, count=None, counter_instance_id=None, next_refresh_time=None, class CounterSample(Model): - """CounterSample. - + """ :param base_value: :type base_value: long :param computed_value: @@ -338,8 +328,7 @@ def __init__(self, base_value=None, computed_value=None, counter_frequency=None, class CounterSampleQueryDetails(Model): - """CounterSampleQueryDetails. - + """ :param counter_instance_id: :type counter_instance_id: str :param from_interval: @@ -362,8 +351,7 @@ def __init__(self, counter_instance_id=None, from_interval=None, to_interval=Non class CounterSamplesResult(Model): - """CounterSamplesResult. - + """ :param count: :type count: int :param max_batch_size: @@ -390,8 +378,7 @@ def __init__(self, count=None, max_batch_size=None, total_samples_count=None, va class Diagnostics(Model): - """Diagnostics. - + """ :param diagnostic_store_connection_string: :type diagnostic_store_connection_string: str :param last_modified_time: @@ -414,8 +401,7 @@ def __init__(self, diagnostic_store_connection_string=None, last_modified_time=N class DropAccessData(Model): - """DropAccessData. - + """ :param drop_container_url: :type drop_container_url: str :param sas_key: @@ -434,8 +420,7 @@ def __init__(self, drop_container_url=None, sas_key=None): class ErrorDetails(Model): - """ErrorDetails. - + """ :param last_error_date: :type last_error_date: datetime :param message_text: @@ -474,8 +459,7 @@ def __init__(self, last_error_date=None, message_text=None, occurrences=None, re class LoadGenerationGeoLocation(Model): - """LoadGenerationGeoLocation. - + """ :param location: :type location: str :param percentage: @@ -494,8 +478,7 @@ def __init__(self, location=None, percentage=None): class LoadTest(Model): - """LoadTest. - + """ """ _attribute_map = { @@ -506,8 +489,7 @@ def __init__(self): class LoadTestDefinition(Model): - """LoadTestDefinition. - + """ :param agent_count: :type agent_count: int :param browser_mixs: @@ -566,8 +548,7 @@ def __init__(self, agent_count=None, browser_mixs=None, core_count=None, cores_p class LoadTestErrors(Model): - """LoadTestErrors. - + """ :param count: :type count: int :param occurrences: @@ -594,8 +575,7 @@ def __init__(self, count=None, occurrences=None, types=None, url=None): class LoadTestRunSettings(Model): - """LoadTestRunSettings. - + """ :param agent_count: :type agent_count: int :param core_count: @@ -634,8 +614,7 @@ def __init__(self, agent_count=None, core_count=None, cores_per_agent=None, dura class OverridableRunSettings(Model): - """OverridableRunSettings. - + """ :param load_generator_machines_type: :type load_generator_machines_type: object :param static_agent_run_settings: @@ -654,8 +633,7 @@ def __init__(self, load_generator_machines_type=None, static_agent_run_settings= class PageSummary(Model): - """PageSummary. - + """ :param average_page_time: :type average_page_time: float :param page_url: @@ -694,8 +672,7 @@ def __init__(self, average_page_time=None, page_url=None, percentage_pages_meeti class RequestSummary(Model): - """RequestSummary. - + """ :param average_response_time: :type average_response_time: float :param failed_requests: @@ -742,8 +719,7 @@ def __init__(self, average_response_time=None, failed_requests=None, passed_requ class ScenarioSummary(Model): - """ScenarioSummary. - + """ :param max_user_load: :type max_user_load: int :param min_user_load: @@ -766,8 +742,7 @@ def __init__(self, max_user_load=None, min_user_load=None, scenario_name=None): class StaticAgentRunSetting(Model): - """StaticAgentRunSetting. - + """ :param load_generator_machines_type: :type load_generator_machines_type: object :param static_agent_group_name: @@ -786,8 +761,7 @@ def __init__(self, load_generator_machines_type=None, static_agent_group_name=No class SubType(Model): - """SubType. - + """ :param count: :type count: int :param error_detail_list: @@ -818,8 +792,7 @@ def __init__(self, count=None, error_detail_list=None, occurrences=None, sub_typ class SummaryPercentileData(Model): - """SummaryPercentileData. - + """ :param percentile: :type percentile: int :param percentile_value: @@ -838,8 +811,7 @@ def __init__(self, percentile=None, percentile_value=None): class TenantDetails(Model): - """TenantDetails. - + """ :param access_details: :type access_details: list of :class:`AgentGroupAccessData ` :param id: @@ -874,8 +846,7 @@ def __init__(self, access_details=None, id=None, static_machines=None, user_load class TestDefinitionBasic(Model): - """TestDefinitionBasic. - + """ :param access_data: :type access_data: :class:`DropAccessData ` :param created_by: @@ -918,8 +889,7 @@ def __init__(self, access_data=None, created_by=None, created_date=None, id=None class TestDrop(Model): - """TestDrop. - + """ :param access_data: :type access_data: :class:`DropAccessData ` :param created_date: @@ -954,8 +924,7 @@ def __init__(self, access_data=None, created_date=None, drop_type=None, id=None, class TestDropRef(Model): - """TestDropRef. - + """ :param id: :type id: str :param url: @@ -974,8 +943,7 @@ def __init__(self, id=None, url=None): class TestResults(Model): - """TestResults. - + """ :param cloud_load_test_solution_url: :type cloud_load_test_solution_url: str :param counter_groups: @@ -1002,8 +970,7 @@ def __init__(self, cloud_load_test_solution_url=None, counter_groups=None, diagn class TestResultsSummary(Model): - """TestResultsSummary. - + """ :param overall_page_summary: :type overall_page_summary: :class:`PageSummary ` :param overall_request_summary: @@ -1050,8 +1017,7 @@ def __init__(self, overall_page_summary=None, overall_request_summary=None, over class TestRunAbortMessage(Model): - """TestRunAbortMessage. - + """ :param action: :type action: str :param cause: @@ -1082,8 +1048,7 @@ def __init__(self, action=None, cause=None, details=None, logged_date=None, sour class TestRunBasic(Model): - """TestRunBasic. - + """ :param created_by: :type created_by: IdentityRef :param created_date: @@ -1154,8 +1119,7 @@ def __init__(self, created_by=None, created_date=None, deleted_by=None, deleted_ class TestRunCounterInstance(Model): - """TestRunCounterInstance. - + """ :param category_name: :type category_name: str :param counter_instance_id: @@ -1206,8 +1170,7 @@ def __init__(self, category_name=None, counter_instance_id=None, counter_name=No class TestRunMessage(Model): - """TestRunMessage. - + """ :param agent_id: :type agent_id: str :param error_code: @@ -1254,8 +1217,7 @@ def __init__(self, agent_id=None, error_code=None, logged_date=None, message=Non class TestSettings(Model): - """TestSettings. - + """ :param cleanup_command: :type cleanup_command: str :param host_process_platform: @@ -1278,8 +1240,7 @@ def __init__(self, cleanup_command=None, host_process_platform=None, setup_comma class TestSummary(Model): - """TestSummary. - + """ :param average_test_time: :type average_test_time: float :param failed_tests: @@ -1318,8 +1279,7 @@ def __init__(self, average_test_time=None, failed_tests=None, passed_tests=None, class TransactionSummary(Model): - """TransactionSummary. - + """ :param average_response_time: :type average_response_time: float :param average_transaction_time: @@ -1358,8 +1318,7 @@ def __init__(self, average_response_time=None, average_transaction_time=None, pe class WebApiLoadTestMachineInput(Model): - """WebApiLoadTestMachineInput. - + """ :param machine_group_id: :type machine_group_id: str :param machine_type: @@ -1386,8 +1345,7 @@ def __init__(self, machine_group_id=None, machine_type=None, setup_configuration class WebApiSetupParamaters(Model): - """WebApiSetupParamaters. - + """ :param configurations: :type configurations: dict """ @@ -1402,8 +1360,7 @@ def __init__(self, configurations=None): class WebApiTestMachine(Model): - """WebApiTestMachine. - + """ :param last_heart_beat: :type last_heart_beat: datetime :param machine_name: @@ -1426,8 +1383,7 @@ def __init__(self, last_heart_beat=None, machine_name=None, status=None): class WebApiUserLoadTestMachineInput(WebApiLoadTestMachineInput): - """WebApiUserLoadTestMachineInput. - + """ :param machine_group_id: :type machine_group_id: str :param machine_type: @@ -1466,8 +1422,7 @@ def __init__(self, machine_group_id=None, machine_type=None, setup_configuration class WebInstanceSummaryData(Model): - """WebInstanceSummaryData. - + """ :param average: :type average: float :param max: @@ -1490,8 +1445,7 @@ def __init__(self, average=None, max=None, min=None): class LoadTestRunDetails(LoadTestRunSettings): - """LoadTestRunDetails. - + """ :param agent_count: :type agent_count: int :param core_count: @@ -1527,8 +1481,7 @@ def __init__(self, agent_count=None, core_count=None, cores_per_agent=None, dura class TestDefinition(TestDefinitionBasic): - """TestDefinition. - + """ :param access_data: :type access_data: :class:`DropAccessData ` :param created_by: @@ -1587,8 +1540,7 @@ def __init__(self, access_data=None, created_by=None, created_date=None, id=None class TestRun(TestRunBasic): - """TestRun. - + """ :param created_by: :type created_by: IdentityRef :param created_date: diff --git a/azure-devops/azure/devops/v5_1/contributions/models.py b/azure-devops/azure/devops/v5_1/contributions/models.py index 9af0b215..59a358d5 100644 --- a/azure-devops/azure/devops/v5_1/contributions/models.py +++ b/azure-devops/azure/devops/v5_1/contributions/models.py @@ -10,7 +10,8 @@ class ClientContribution(Model): - """ClientContribution. + """ + Representaion of a ContributionNode that can be used for serialized to clients. :param description: Description of the contribution/type :type description: str @@ -46,7 +47,8 @@ def __init__(self, description=None, id=None, includes=None, properties=None, ta class ClientContributionNode(Model): - """ClientContributionNode. + """ + Representaion of a ContributionNode that can be used for serialized to clients. :param children: List of ids for contributions which are children to the current contribution. :type children: list of str @@ -70,8 +72,7 @@ def __init__(self, children=None, contribution=None, parents=None): class ClientContributionProviderDetails(Model): - """ClientContributionProviderDetails. - + """ :param display_name: Friendly name for the provider. :type display_name: str :param name: Unique identifier for this provider. The provider name can be used to cache the contribution data and refer back to it when looking for changes @@ -98,7 +99,8 @@ def __init__(self, display_name=None, name=None, properties=None, version=None): class ContributionBase(Model): - """ContributionBase. + """ + Base class shared by contributions and contribution types :param description: Description of the contribution/type :type description: str @@ -122,7 +124,8 @@ def __init__(self, description=None, id=None, visible_to=None): class ContributionConstraint(Model): - """ContributionConstraint. + """ + Specifies a constraint that can be used to dynamically include/exclude a given contribution :param group: An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included). :type group: int @@ -158,7 +161,8 @@ def __init__(self, group=None, id=None, inverse=None, name=None, properties=None class ContributionNodeQuery(Model): - """ContributionNodeQuery. + """ + A query that can be issued for contribution nodes :param contribution_ids: The contribution ids of the nodes to find. :type contribution_ids: list of str @@ -186,7 +190,8 @@ def __init__(self, contribution_ids=None, data_provider_context=None, include_pr class ContributionNodeQueryResult(Model): - """ContributionNodeQueryResult. + """ + Result of a contribution node query. Wraps the resulting contribution nodes and provider details. :param nodes: Map of contribution ids to corresponding node. :type nodes: dict @@ -206,7 +211,8 @@ def __init__(self, nodes=None, provider_details=None): class ContributionPropertyDescription(Model): - """ContributionPropertyDescription. + """ + Description about a property of a contribution type :param description: Description of the property :type description: str @@ -234,7 +240,8 @@ def __init__(self, description=None, name=None, required=None, type=None): class ContributionType(ContributionBase): - """ContributionType. + """ + A contribution type, given by a json schema :param description: Description of the contribution/type :type description: str @@ -267,7 +274,8 @@ def __init__(self, description=None, id=None, visible_to=None, indexed=None, nam class DataProviderContext(Model): - """DataProviderContext. + """ + Contextual information that data providers can examine when populating their data :param properties: Generic property bag that contains context-specific properties that data providers can use when populating their data dictionary :type properties: dict @@ -283,8 +291,7 @@ def __init__(self, properties=None): class DataProviderExceptionDetails(Model): - """DataProviderExceptionDetails. - + """ :param exception_type: The type of the exception that was thrown. :type exception_type: str :param message: Message that is associated with the exception. @@ -307,7 +314,8 @@ def __init__(self, exception_type=None, message=None, stack_trace=None): class DataProviderQuery(Model): - """DataProviderQuery. + """ + A query that can be issued for data provider data :param context: Contextual information to pass to the data providers :type context: :class:`DataProviderContext ` @@ -327,7 +335,8 @@ def __init__(self, context=None, contribution_ids=None): class DataProviderResult(Model): - """DataProviderResult. + """ + Result structure from calls to GetDataProviderData :param client_providers: This is the set of data providers that were requested, but either they were defined as client providers, or as remote providers that failed and may be retried by the client. :type client_providers: dict @@ -367,7 +376,8 @@ def __init__(self, client_providers=None, data=None, exceptions=None, resolved_p class ExtensionEventCallback(Model): - """ExtensionEventCallback. + """ + Base class for an event callback for an extension :param uri: The uri of the endpoint that is hit when an event occurs :type uri: str @@ -383,7 +393,8 @@ def __init__(self, uri=None): class ExtensionEventCallbackCollection(Model): - """ExtensionEventCallbackCollection. + """ + Collection of event callbacks - endpoints called when particular extension events occur. :param post_disable: Optional. Defines an endpoint that gets called via a POST reqeust to notify that an extension disable has occurred. :type post_disable: :class:`ExtensionEventCallback ` @@ -423,8 +434,7 @@ def __init__(self, post_disable=None, post_enable=None, post_install=None, post_ class ExtensionFile(Model): - """ExtensionFile. - + """ :param asset_type: :type asset_type: str :param language: @@ -447,7 +457,8 @@ def __init__(self, asset_type=None, language=None, source=None): class ExtensionLicensing(Model): - """ExtensionLicensing. + """ + How an extension should handle including contributions based on licensing :param overrides: A list of contributions which deviate from the default licensing behavior :type overrides: list of :class:`LicensingOverride ` @@ -463,7 +474,8 @@ def __init__(self, overrides=None): class ExtensionManifest(Model): - """ExtensionManifest. + """ + Base class for extension properties which are shared by the extension manifest and the extension model :param base_uri: Uri used as base for other relative uri's defined in extension :type base_uri: str @@ -527,7 +539,8 @@ def __init__(self, base_uri=None, constraints=None, contributions=None, contribu class InstalledExtension(ExtensionManifest): - """InstalledExtension. + """ + Represents a VSTS extension along with its installation state :param base_uri: Uri used as base for other relative uri's defined in extension :type base_uri: str @@ -618,7 +631,8 @@ def __init__(self, base_uri=None, constraints=None, contributions=None, contribu class InstalledExtensionState(Model): - """InstalledExtensionState. + """ + The state of an installed extension :param flags: States of an installed extension :type flags: object @@ -642,7 +656,8 @@ def __init__(self, flags=None, installation_issues=None, last_updated=None): class InstalledExtensionStateIssue(Model): - """InstalledExtensionStateIssue. + """ + Represents an installation issue :param message: The error message :type message: str @@ -666,7 +681,8 @@ def __init__(self, message=None, source=None, type=None): class LicensingOverride(Model): - """LicensingOverride. + """ + Maps a contribution to a licensing behavior :param behavior: How the inclusion of this contribution should change based on licensing :type behavior: object @@ -686,7 +702,8 @@ def __init__(self, behavior=None, id=None): class ResolvedDataProvider(Model): - """ResolvedDataProvider. + """ + Entry for a specific data provider's resulting data :param duration: The total time the data provider took to resolve its data (in milliseconds) :type duration: int @@ -710,7 +727,8 @@ def __init__(self, duration=None, error=None, id=None): class ClientDataProviderQuery(DataProviderQuery): - """ClientDataProviderQuery. + """ + A client data provider are the details needed to make the data provider request from the client. :param context: Contextual information to pass to the data providers :type context: :class:`DataProviderContext ` @@ -732,7 +750,8 @@ def __init__(self, context=None, contribution_ids=None, query_service_instance_t class Contribution(ContributionBase): - """Contribution. + """ + An individual contribution made by an extension :param description: Description of the contribution/type :type description: str diff --git a/azure-devops/azure/devops/v5_1/core/models.py b/azure-devops/azure/devops/v5_1/core/models.py index d06ee430..89a7f5d5 100644 --- a/azure-devops/azure/devops/v5_1/core/models.py +++ b/azure-devops/azure/devops/v5_1/core/models.py @@ -10,8 +10,7 @@ class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -38,7 +37,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityBase(Model): - """IdentityBase. + """ + Base Identity class to allow "trimmed" identity class in the GetConnectionData API Makes sure that on-the-wire representations of the derived classes are compatible with each other (e.g. Server responds with PublicIdentity object while client deserializes it as Identity object) Derived classes should not have additional [DataMember] properties :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str @@ -114,8 +114,7 @@ def __init__(self, custom_display_name=None, descriptor=None, id=None, is_active class IdentityData(Model): - """IdentityData. - + """ :param identity_ids: :type identity_ids: list of str """ @@ -130,8 +129,7 @@ def __init__(self, identity_ids=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -190,7 +188,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -218,7 +217,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class OperationReference(Model): - """OperationReference. + """ + Reference for an async operation. :param id: Unique identifier for the operation. :type id: str @@ -246,8 +246,7 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None): class ProcessReference(Model): - """ProcessReference. - + """ :param name: :type name: str :param url: @@ -266,7 +265,8 @@ def __init__(self, name=None, url=None): class ProjectAvatar(Model): - """ProjectAvatar. + """ + Contains the image data for project avatar. :param image: The avatar image represented as a byte array. :type image: str @@ -282,7 +282,8 @@ def __init__(self, image=None): class ProjectInfo(Model): - """ProjectInfo. + """ + Contains information describing a project. :param abbreviation: The abbreviated name of the project. :type abbreviation: str @@ -338,8 +339,7 @@ def __init__(self, abbreviation=None, description=None, id=None, last_update_tim class ProjectProperties(Model): - """ProjectProperties. - + """ :param project_id: The team project Id :type project_id: str :param properties: The collection of team project properties @@ -358,7 +358,8 @@ def __init__(self, project_id=None, properties=None): class ProjectProperty(Model): - """ProjectProperty. + """ + A named value associated with a project. :param name: The name of the property. :type name: str @@ -378,8 +379,7 @@ def __init__(self, name=None, value=None): class Proxy(Model): - """Proxy. - + """ :param authorization: :type authorization: :class:`ProxyAuthorization ` :param description: This is a description string @@ -418,8 +418,7 @@ def __init__(self, authorization=None, description=None, friendly_name=None, glo class ProxyAuthorization(Model): - """ProxyAuthorization. - + """ :param authorization_url: Gets or sets the endpoint used to obtain access tokens from the configured token service. :type authorization_url: str :param client_id: Gets or sets the client identifier for this proxy. @@ -446,7 +445,8 @@ def __init__(self, authorization_url=None, client_id=None, identity=None, public class PublicKey(Model): - """PublicKey. + """ + Represents the public key portion of an RSA asymmetric key. :param exponent: Gets or sets the exponent for the public key. :type exponent: str @@ -466,7 +466,8 @@ def __init__(self, exponent=None, modulus=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -482,8 +483,7 @@ def __init__(self, links=None): class TeamMember(Model): - """TeamMember. - + """ :param identity: :type identity: :class:`IdentityRef ` :param is_team_admin: @@ -502,7 +502,8 @@ def __init__(self, identity=None, is_team_admin=None): class TeamProjectCollectionReference(Model): - """TeamProjectCollectionReference. + """ + Reference object for a TeamProjectCollection. :param id: Collection Id. :type id: str @@ -526,7 +527,8 @@ def __init__(self, id=None, name=None, url=None): class TeamProjectReference(Model): - """TeamProjectReference. + """ + Represents a shallow reference to a TeamProject. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -578,8 +580,7 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class WebApiConnectedServiceRef(Model): - """WebApiConnectedServiceRef. - + """ :param id: :type id: str :param url: @@ -598,8 +599,7 @@ def __init__(self, id=None, url=None): class WebApiTeamRef(Model): - """WebApiTeamRef. - + """ :param id: Team (Identity) Guid. A Team Foundation ID. :type id: str :param name: Team name @@ -622,8 +622,7 @@ def __init__(self, id=None, name=None, url=None): class Identity(IdentityBase): - """Identity. - + """ :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str :param descriptor: @@ -682,8 +681,7 @@ def __init__(self, custom_display_name=None, descriptor=None, id=None, is_active class Process(ProcessReference): - """Process. - + """ :param name: :type name: str :param url: @@ -720,7 +718,8 @@ def __init__(self, name=None, url=None, _links=None, description=None, id=None, class TeamProject(TeamProjectReference): - """TeamProject. + """ + Represents a Team Project object. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -774,7 +773,8 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class TeamProjectCollection(TeamProjectCollectionReference): - """TeamProjectCollection. + """ + Data contract for a TeamProjectCollection. :param id: Collection Id. :type id: str @@ -811,8 +811,7 @@ def __init__(self, id=None, name=None, url=None, _links=None, description=None, class WebApiConnectedService(WebApiConnectedServiceRef): - """WebApiConnectedService. - + """ :param url: :type url: str :param authenticated_by: The user who did the OAuth authentication to created this service @@ -854,8 +853,7 @@ def __init__(self, url=None, authenticated_by=None, description=None, friendly_n class WebApiConnectedServiceDetails(WebApiConnectedServiceRef): - """WebApiConnectedServiceDetails. - + """ :param id: :type id: str :param url: @@ -884,8 +882,7 @@ def __init__(self, id=None, url=None, connected_service_meta_data=None, credenti class WebApiTeam(WebApiTeamRef): - """WebApiTeam. - + """ :param id: Team (Identity) Guid. A Team Foundation ID. :type id: str :param name: Team name diff --git a/azure-devops/azure/devops/v5_1/customer_intelligence/models.py b/azure-devops/azure/devops/v5_1/customer_intelligence/models.py index 0f9dc7d2..c61ab811 100644 --- a/azure-devops/azure/devops/v5_1/customer_intelligence/models.py +++ b/azure-devops/azure/devops/v5_1/customer_intelligence/models.py @@ -10,8 +10,7 @@ class CustomerIntelligenceEvent(Model): - """CustomerIntelligenceEvent. - + """ :param area: :type area: str :param feature: diff --git a/azure-devops/azure/devops/v5_1/dashboard/models.py b/azure-devops/azure/devops/v5_1/dashboard/models.py index f430211a..48fbc290 100644 --- a/azure-devops/azure/devops/v5_1/dashboard/models.py +++ b/azure-devops/azure/devops/v5_1/dashboard/models.py @@ -10,7 +10,8 @@ class Dashboard(Model): - """Dashboard. + """ + Model of a Dashboard. :param _links: :type _links: :class:`ReferenceLinks ` @@ -62,7 +63,8 @@ def __init__(self, _links=None, description=None, eTag=None, id=None, name=None, class DashboardGroup(Model): - """DashboardGroup. + """ + Describes a list of dashboards associated to an owner. Currently, teams own dashboard groups. :param _links: :type _links: :class:`ReferenceLinks ` @@ -94,7 +96,8 @@ def __init__(self, _links=None, dashboard_entries=None, permission=None, team_da class DashboardGroupEntry(Dashboard): - """DashboardGroupEntry. + """ + Dashboard group entry, wraping around Dashboard (needed?) :param _links: :type _links: :class:`ReferenceLinks ` @@ -136,7 +139,8 @@ def __init__(self, _links=None, description=None, eTag=None, id=None, name=None, class DashboardGroupEntryResponse(DashboardGroupEntry): - """DashboardGroupEntryResponse. + """ + Response from RestAPI when saving and editing DashboardGroupEntry :param _links: :type _links: :class:`ReferenceLinks ` @@ -178,8 +182,7 @@ def __init__(self, _links=None, description=None, eTag=None, id=None, name=None, class DashboardResponse(DashboardGroupEntry): - """DashboardResponse. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param description: Description of the dashboard. @@ -220,7 +223,8 @@ def __init__(self, _links=None, description=None, eTag=None, id=None, name=None, class LightboxOptions(Model): - """LightboxOptions. + """ + Lightbox configuration :param height: Height of desired lightbox, in pixels :type height: int @@ -244,7 +248,8 @@ def __init__(self, height=None, resizable=None, width=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -260,7 +265,8 @@ def __init__(self, links=None): class SemanticVersion(Model): - """SemanticVersion. + """ + versioning for an artifact as described at: http://semver.org/, of the form major.minor.patch. :param major: Major version when you make incompatible API changes :type major: int @@ -284,7 +290,8 @@ def __init__(self, major=None, minor=None, patch=None): class TeamContext(Model): - """TeamContext. + """ + The Team Context for an operation. :param project: The team project Id or name. Ignored if ProjectId is set. :type project: str @@ -312,7 +319,8 @@ def __init__(self, project=None, project_id=None, team=None, team_id=None): class Widget(Model): - """Widget. + """ + Widget data :param _links: :type _links: :class:`ReferenceLinks ` @@ -412,7 +420,8 @@ def __init__(self, _links=None, allowed_sizes=None, are_settings_blocked_for_use class WidgetMetadata(Model): - """WidgetMetadata. + """ + Contribution based information describing Dashboard Widgets. :param allowed_sizes: Sizes supported by the Widget. :type allowed_sizes: list of :class:`WidgetSize ` @@ -508,8 +517,7 @@ def __init__(self, allowed_sizes=None, analytics_service_required=None, catalog_ class WidgetMetadataResponse(Model): - """WidgetMetadataResponse. - + """ :param uri: :type uri: str :param widget_metadata: @@ -528,8 +536,7 @@ def __init__(self, uri=None, widget_metadata=None): class WidgetPosition(Model): - """WidgetPosition. - + """ :param column: :type column: int :param row: @@ -548,7 +555,8 @@ def __init__(self, column=None, row=None): class WidgetResponse(Widget): - """WidgetResponse. + """ + Response from RestAPI when saving and editing Widget :param _links: :type _links: :class:`ReferenceLinks ` @@ -626,8 +634,7 @@ def __init__(self, _links=None, allowed_sizes=None, are_settings_blocked_for_use class WidgetSize(Model): - """WidgetSize. - + """ :param column_span: The Width of the widget, expressed in dashboard grid columns. :type column_span: int :param row_span: The height of the widget, expressed in dashboard grid rows. @@ -646,7 +653,8 @@ def __init__(self, column_span=None, row_span=None): class WidgetsVersionedList(Model): - """WidgetsVersionedList. + """ + Wrapper class to support HTTP header generation using CreateResponse, ClientHeaderParameter and ClientResponseType in WidgetV2Controller :param eTag: :type eTag: list of str @@ -666,8 +674,7 @@ def __init__(self, eTag=None, widgets=None): class WidgetTypesResponse(Model): - """WidgetTypesResponse. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param uri: diff --git a/azure-devops/azure/devops/v5_1/extension_management/models.py b/azure-devops/azure/devops/v5_1/extension_management/models.py index d8a63382..a546aea8 100644 --- a/azure-devops/azure/devops/v5_1/extension_management/models.py +++ b/azure-devops/azure/devops/v5_1/extension_management/models.py @@ -10,8 +10,7 @@ class AcquisitionOperation(Model): - """AcquisitionOperation. - + """ :param operation_state: State of the the AcquisitionOperation for the current user :type operation_state: object :param operation_type: AcquisitionOperationType: install, request, buy, etc... @@ -38,8 +37,7 @@ def __init__(self, operation_state=None, operation_type=None, reason=None, reaso class AcquisitionOperationDisallowReason(Model): - """AcquisitionOperationDisallowReason. - + """ :param message: User-friendly message clarifying the reason for disallowance :type message: str :param type: Type of reason for disallowance - AlreadyInstalled, UnresolvedDemand, etc. @@ -58,7 +56,8 @@ def __init__(self, message=None, type=None): class AcquisitionOptions(Model): - """AcquisitionOptions. + """ + Market item acquisition options (install, buy, etc) for an installation target. :param default_operation: Default Operation for the ItemId in this target :type default_operation: :class:`AcquisitionOperation ` @@ -90,7 +89,8 @@ def __init__(self, default_operation=None, item_id=None, operations=None, proper class ContributionBase(Model): - """ContributionBase. + """ + Base class shared by contributions and contribution types :param description: Description of the contribution/type :type description: str @@ -114,7 +114,8 @@ def __init__(self, description=None, id=None, visible_to=None): class ContributionConstraint(Model): - """ContributionConstraint. + """ + Specifies a constraint that can be used to dynamically include/exclude a given contribution :param group: An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included). :type group: int @@ -150,7 +151,8 @@ def __init__(self, group=None, id=None, inverse=None, name=None, properties=None class ContributionPropertyDescription(Model): - """ContributionPropertyDescription. + """ + Description about a property of a contribution type :param description: Description of the property :type description: str @@ -178,7 +180,8 @@ def __init__(self, description=None, name=None, required=None, type=None): class ContributionType(ContributionBase): - """ContributionType. + """ + A contribution type, given by a json schema :param description: Description of the contribution/type :type description: str @@ -211,7 +214,8 @@ def __init__(self, description=None, id=None, visible_to=None, indexed=None, nam class ExtensionAcquisitionRequest(Model): - """ExtensionAcquisitionRequest. + """ + Contract for handling the extension acquisition process :param assignment_type: How the item is being assigned :type assignment_type: object @@ -247,7 +251,8 @@ def __init__(self, assignment_type=None, billing_id=None, item_id=None, operatio class ExtensionAuditLog(Model): - """ExtensionAuditLog. + """ + Audit log for an extension :param entries: Collection of audit log entries :type entries: list of :class:`ExtensionAuditLogEntry ` @@ -271,7 +276,8 @@ def __init__(self, entries=None, extension_name=None, publisher_name=None): class ExtensionAuditLogEntry(Model): - """ExtensionAuditLogEntry. + """ + An audit log entry for an extension :param audit_action: Change that was made to extension :type audit_action: str @@ -299,8 +305,7 @@ def __init__(self, audit_action=None, audit_date=None, comment=None, updated_by= class ExtensionAuthorization(Model): - """ExtensionAuthorization. - + """ :param id: :type id: str :param scopes: @@ -319,8 +324,7 @@ def __init__(self, id=None, scopes=None): class ExtensionBadge(Model): - """ExtensionBadge. - + """ :param description: :type description: str :param img_uri: @@ -343,7 +347,8 @@ def __init__(self, description=None, img_uri=None, link=None): class ExtensionDataCollection(Model): - """ExtensionDataCollection. + """ + Represents a single collection for extension data documents :param collection_name: The name of the collection :type collection_name: str @@ -371,7 +376,8 @@ def __init__(self, collection_name=None, documents=None, scope_type=None, scope_ class ExtensionDataCollectionQuery(Model): - """ExtensionDataCollectionQuery. + """ + Represents a query to receive a set of extension data collections :param collections: A list of collections to query :type collections: list of :class:`ExtensionDataCollection ` @@ -387,7 +393,8 @@ def __init__(self, collections=None): class ExtensionEventCallback(Model): - """ExtensionEventCallback. + """ + Base class for an event callback for an extension :param uri: The uri of the endpoint that is hit when an event occurs :type uri: str @@ -403,7 +410,8 @@ def __init__(self, uri=None): class ExtensionEventCallbackCollection(Model): - """ExtensionEventCallbackCollection. + """ + Collection of event callbacks - endpoints called when particular extension events occur. :param post_disable: Optional. Defines an endpoint that gets called via a POST reqeust to notify that an extension disable has occurred. :type post_disable: :class:`ExtensionEventCallback ` @@ -443,8 +451,7 @@ def __init__(self, post_disable=None, post_enable=None, post_install=None, post_ class ExtensionFile(Model): - """ExtensionFile. - + """ :param asset_type: :type asset_type: str :param language: @@ -467,7 +474,8 @@ def __init__(self, asset_type=None, language=None, source=None): class ExtensionIdentifier(Model): - """ExtensionIdentifier. + """ + Represents the component pieces of an extensions fully qualified name, along with the fully qualified name. :param extension_name: The ExtensionName component part of the fully qualified ExtensionIdentifier :type extension_name: str @@ -487,7 +495,8 @@ def __init__(self, extension_name=None, publisher_name=None): class ExtensionLicensing(Model): - """ExtensionLicensing. + """ + How an extension should handle including contributions based on licensing :param overrides: A list of contributions which deviate from the default licensing behavior :type overrides: list of :class:`LicensingOverride ` @@ -503,7 +512,8 @@ def __init__(self, overrides=None): class ExtensionManifest(Model): - """ExtensionManifest. + """ + Base class for extension properties which are shared by the extension manifest and the extension model :param base_uri: Uri used as base for other relative uri's defined in extension :type base_uri: str @@ -567,7 +577,8 @@ def __init__(self, base_uri=None, constraints=None, contributions=None, contribu class ExtensionPolicy(Model): - """ExtensionPolicy. + """ + Policy with a set of permissions on extension operations :param install: Permissions on 'Install' operation :type install: object @@ -587,7 +598,8 @@ def __init__(self, install=None, request=None): class ExtensionRequest(Model): - """ExtensionRequest. + """ + A request for an extension (to be installed or have a license assigned) :param reject_message: Required message supplied if the request is rejected :type reject_message: str @@ -627,8 +639,7 @@ def __init__(self, reject_message=None, request_date=None, requested_by=None, re class ExtensionShare(Model): - """ExtensionShare. - + """ :param id: :type id: str :param is_org: @@ -655,8 +666,7 @@ def __init__(self, id=None, is_org=None, name=None, type=None): class ExtensionStatistic(Model): - """ExtensionStatistic. - + """ :param statistic_name: :type statistic_name: str :param value: @@ -675,8 +685,7 @@ def __init__(self, statistic_name=None, value=None): class ExtensionVersion(Model): - """ExtensionVersion. - + """ :param asset_uri: :type asset_uri: str :param badges: @@ -727,8 +736,7 @@ def __init__(self, asset_uri=None, badges=None, fallback_asset_uri=None, files=N class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -755,8 +763,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -815,8 +822,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class InstallationTarget(Model): - """InstallationTarget. - + """ :param target: :type target: str :param target_version: @@ -835,7 +841,8 @@ def __init__(self, target=None, target_version=None): class InstalledExtension(ExtensionManifest): - """InstalledExtension. + """ + Represents a VSTS extension along with its installation state :param base_uri: Uri used as base for other relative uri's defined in extension :type base_uri: str @@ -926,8 +933,7 @@ def __init__(self, base_uri=None, constraints=None, contributions=None, contribu class InstalledExtensionQuery(Model): - """InstalledExtensionQuery. - + """ :param asset_types: :type asset_types: list of str :param monikers: @@ -946,7 +952,8 @@ def __init__(self, asset_types=None, monikers=None): class InstalledExtensionState(Model): - """InstalledExtensionState. + """ + The state of an installed extension :param flags: States of an installed extension :type flags: object @@ -970,7 +977,8 @@ def __init__(self, flags=None, installation_issues=None, last_updated=None): class InstalledExtensionStateIssue(Model): - """InstalledExtensionStateIssue. + """ + Represents an installation issue :param message: The error message :type message: str @@ -994,7 +1002,8 @@ def __init__(self, message=None, source=None, type=None): class LicensingOverride(Model): - """LicensingOverride. + """ + Maps a contribution to a licensing behavior :param behavior: How the inclusion of this contribution should change based on licensing :type behavior: object @@ -1014,8 +1023,7 @@ def __init__(self, behavior=None, id=None): class PublishedExtension(Model): - """PublishedExtension. - + """ :param categories: :type categories: list of str :param deployment_type: @@ -1094,7 +1102,8 @@ def __init__(self, categories=None, deployment_type=None, display_name=None, ext class PublisherFacts(Model): - """PublisherFacts. + """ + High-level information about the publisher, like id's and names :param display_name: :type display_name: str @@ -1122,7 +1131,8 @@ def __init__(self, display_name=None, flags=None, publisher_id=None, publisher_n class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -1138,7 +1148,8 @@ def __init__(self, links=None): class RequestedExtension(Model): - """RequestedExtension. + """ + A request for an extension (to be installed or have a license assigned) :param extension_name: The unique name of the extension :type extension_name: str @@ -1170,7 +1181,8 @@ def __init__(self, extension_name=None, extension_requests=None, publisher_displ class UserExtensionPolicy(Model): - """UserExtensionPolicy. + """ + Represents the extension policy applied to a given user :param display_name: User display name that this policy refers to :type display_name: str @@ -1194,7 +1206,8 @@ def __init__(self, display_name=None, permissions=None, user_id=None): class Contribution(ContributionBase): - """Contribution. + """ + An individual contribution made by an extension :param description: Description of the contribution/type :type description: str @@ -1239,7 +1252,8 @@ def __init__(self, description=None, id=None, visible_to=None, constraints=None, class ExtensionState(InstalledExtensionState): - """ExtensionState. + """ + The state of an extension :param flags: States of an installed extension :type flags: object diff --git a/azure-devops/azure/devops/v5_1/feature_availability/models.py b/azure-devops/azure/devops/v5_1/feature_availability/models.py index 6e0534c8..335a11e6 100644 --- a/azure-devops/azure/devops/v5_1/feature_availability/models.py +++ b/azure-devops/azure/devops/v5_1/feature_availability/models.py @@ -10,8 +10,7 @@ class FeatureFlag(Model): - """FeatureFlag. - + """ :param description: :type description: str :param effective_state: @@ -42,7 +41,8 @@ def __init__(self, description=None, effective_state=None, explicit_state=None, class FeatureFlagPatch(Model): - """FeatureFlagPatch. + """ + This is passed to the FeatureFlagController to edit the status of a feature flag :param state: :type state: str diff --git a/azure-devops/azure/devops/v5_1/feature_management/models.py b/azure-devops/azure/devops/v5_1/feature_management/models.py index 6241698f..0eb827bf 100644 --- a/azure-devops/azure/devops/v5_1/feature_management/models.py +++ b/azure-devops/azure/devops/v5_1/feature_management/models.py @@ -10,7 +10,8 @@ class ContributedFeature(Model): - """ContributedFeature. + """ + A feature that can be enabled or disabled :param _links: Named links describing the feature :type _links: :class:`ReferenceLinks ` @@ -78,8 +79,7 @@ def __init__(self, _links=None, default_state=None, default_value_rules=None, de class ContributedFeatureHandlerSettings(Model): - """ContributedFeatureHandlerSettings. - + """ :param name: Name of the handler to run :type name: str :param properties: Properties to feed to the handler @@ -98,7 +98,8 @@ def __init__(self, name=None, properties=None): class ContributedFeatureListener(ContributedFeatureHandlerSettings): - """ContributedFeatureListener. + """ + An identifier and properties used to pass into a handler for a listener or plugin :param name: Name of the handler to run :type name: str @@ -116,7 +117,8 @@ def __init__(self, name=None, properties=None): class ContributedFeatureSettingScope(Model): - """ContributedFeatureSettingScope. + """ + The scope to which a feature setting applies :param setting_scope: The name of the settings scope to use when reading/writing the setting :type setting_scope: str @@ -136,7 +138,8 @@ def __init__(self, setting_scope=None, user_scoped=None): class ContributedFeatureState(Model): - """ContributedFeatureState. + """ + A contributed feature/state pair :param feature_id: The full contribution id of the feature :type feature_id: str @@ -168,7 +171,8 @@ def __init__(self, feature_id=None, overridden=None, reason=None, scope=None, st class ContributedFeatureStateQuery(Model): - """ContributedFeatureStateQuery. + """ + A query for the effective contributed feature states for a list of feature ids :param feature_ids: The list of feature ids to query :type feature_ids: list of str @@ -192,7 +196,8 @@ def __init__(self, feature_ids=None, feature_states=None, scope_values=None): class ContributedFeatureValueRule(ContributedFeatureHandlerSettings): - """ContributedFeatureValueRule. + """ + A rule for dynamically getting the enabled/disabled state of a feature :param name: Name of the handler to run :type name: str @@ -210,7 +215,8 @@ def __init__(self, name=None, properties=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict diff --git a/azure-devops/azure/devops/v5_1/feed/models.py b/azure-devops/azure/devops/v5_1/feed/models.py index 8d5e0715..8b80662c 100644 --- a/azure-devops/azure/devops/v5_1/feed/models.py +++ b/azure-devops/azure/devops/v5_1/feed/models.py @@ -10,8 +10,7 @@ class FeedBatchData(Model): - """FeedBatchData. - + """ :param data: :type data: :class:`FeedBatchOperationData ` :param operation: @@ -30,8 +29,7 @@ def __init__(self, data=None, operation=None): class FeedBatchOperationData(Model): - """FeedBatchOperationData. - + """ """ _attribute_map = { @@ -42,7 +40,8 @@ def __init__(self): class FeedChange(Model): - """FeedChange. + """ + A container that encapsulates the state of the feed after a create, update, or delete. :param change_type: The type of operation. :type change_type: object @@ -70,7 +69,8 @@ def __init__(self, change_type=None, feed=None, feed_continuation_token=None, la class FeedChangesResponse(Model): - """FeedChangesResponse. + """ + A result set containing the feed changes for the range that was requested. :param _links: :type _links: :class:`ReferenceLinks ` @@ -98,7 +98,8 @@ def __init__(self, _links=None, count=None, feed_changes=None, next_feed_continu class FeedCore(Model): - """FeedCore. + """ + An object that contains all of the settings for a specific feed. :param allow_upstream_name_conflict: OBSOLETE: If set, the feed will allow upload of packages that exist on the upstream :type allow_upstream_name_conflict: bool @@ -162,7 +163,8 @@ def __init__(self, allow_upstream_name_conflict=None, capabilities=None, fully_q class FeedPermission(Model): - """FeedPermission. + """ + Permissions for a feed. :param display_name: Display name for the identity. :type display_name: str @@ -190,7 +192,8 @@ def __init__(self, display_name=None, identity_descriptor=None, identity_id=None class FeedRetentionPolicy(Model): - """FeedRetentionPolicy. + """ + Retention policy settings. :param age_limit_in_days: This attribute is deprecated and is not honoured by retention :type age_limit_in_days: int @@ -214,7 +217,8 @@ def __init__(self, age_limit_in_days=None, count_limit=None, days_to_keep_recent class FeedUpdate(Model): - """FeedUpdate. + """ + Update a feed definition with these new values. :param allow_upstream_name_conflict: If set, the feed will allow upload of packages that exist on the upstream :type allow_upstream_name_conflict: bool @@ -262,7 +266,8 @@ def __init__(self, allow_upstream_name_conflict=None, badges_enabled=None, defau class FeedView(Model): - """FeedView. + """ + A view on top of a feed. :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -298,7 +303,8 @@ def __init__(self, _links=None, id=None, name=None, type=None, url=None, visibil class GlobalPermission(Model): - """GlobalPermission. + """ + Permissions for feed service-wide operations such as the creation of new feeds. :param identity_descriptor: Identity of the user with the provided Role. :type identity_descriptor: :class:`str ` @@ -322,7 +328,8 @@ def __init__(self, identity_descriptor=None, identity_id=None, role=None): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -350,7 +357,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class MinimalPackageVersion(Model): - """MinimalPackageVersion. + """ + Core data about any package, including its id and version information and basic state. :param direct_upstream_source_id: Upstream source this package was ingested from. :type direct_upstream_source_id: str @@ -410,7 +418,8 @@ def __init__(self, direct_upstream_source_id=None, id=None, is_cached_version=No class Package(Model): - """Package. + """ + A package, which is a container for one or more package versions. :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -458,7 +467,8 @@ def __init__(self, _links=None, id=None, is_cached=None, name=None, normalized_n class PackageChange(Model): - """PackageChange. + """ + A single change to a feed's packages. :param package: Package that was changed. :type package: :class:`Package ` @@ -478,7 +488,8 @@ def __init__(self, package=None, package_version_change=None): class PackageChangesResponse(Model): - """PackageChangesResponse. + """ + A set of change operations to a feed's packages. :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -506,7 +517,8 @@ def __init__(self, _links=None, count=None, next_package_continuation_token=None class PackageDependency(Model): - """PackageDependency. + """ + A dependency on another package version. :param group: Dependency package group (an optional classification within some package types). :type group: str @@ -530,7 +542,8 @@ def __init__(self, group=None, package_name=None, version_range=None): class PackageFile(Model): - """PackageFile. + """ + A package file for a specific package version, only relevant to package types that contain multiple files per version. :param children: Hierarchical representation of files. :type children: list of :class:`PackageFile ` @@ -554,7 +567,8 @@ def __init__(self, children=None, name=None, protocol_metadata=None): class PackageMetrics(Model): - """PackageMetrics. + """ + All metrics for a certain package id :param download_count: Total count of downloads per package id. :type download_count: float @@ -582,7 +596,8 @@ def __init__(self, download_count=None, download_unique_users=None, last_downloa class PackageMetricsQuery(Model): - """PackageMetricsQuery. + """ + Query to get package metrics :param package_ids: List of package ids :type package_ids: list of str @@ -598,7 +613,8 @@ def __init__(self, package_ids=None): class PackageVersion(MinimalPackageVersion): - """PackageVersion. + """ + A specific version of a package. :param direct_upstream_source_id: Upstream source this package was ingested from. :type direct_upstream_source_id: str @@ -694,7 +710,8 @@ def __init__(self, direct_upstream_source_id=None, id=None, is_cached_version=No class PackageVersionChange(Model): - """PackageVersionChange. + """ + A change to a single package version. :param change_type: The type of change that was performed. :type change_type: object @@ -718,7 +735,8 @@ def __init__(self, change_type=None, continuation_token=None, package_version=No class PackageVersionMetrics(Model): - """PackageVersionMetrics. + """ + All metrics for a certain package version id :param download_count: Total count of downloads per package version id. :type download_count: float @@ -750,7 +768,8 @@ def __init__(self, download_count=None, download_unique_users=None, last_downloa class PackageVersionMetricsQuery(Model): - """PackageVersionMetricsQuery. + """ + Query to get package version metrics :param package_version_ids: List of package version ids :type package_version_ids: list of str @@ -766,7 +785,8 @@ def __init__(self, package_version_ids=None): class PackageVersionProvenance(Model): - """PackageVersionProvenance. + """ + Provenance for a published package version :param feed_id: Name or Id of the feed. :type feed_id: str @@ -794,8 +814,7 @@ def __init__(self, feed_id=None, package_id=None, package_version_id=None, prove class ProjectReference(Model): - """ProjectReference. - + """ :param id: Gets or sets id of the project. :type id: str :param name: Gets or sets name of the project. @@ -818,7 +837,8 @@ def __init__(self, id=None, name=None, visibility=None): class ProtocolMetadata(Model): - """ProtocolMetadata. + """ + Extended metadata for a specific package type. :param data: Extended metadata for a specific package type, formatted to the associated schema version definition. :type data: object @@ -838,7 +858,8 @@ def __init__(self, data=None, schema_version=None): class Provenance(Model): - """Provenance. + """ + Data about the origin of a published package :param data: Other provenance data. :type data: dict @@ -866,7 +887,8 @@ def __init__(self, data=None, provenance_source=None, publisher_user_identity=No class RecycleBinPackageVersion(PackageVersion): - """RecycleBinPackageVersion. + """ + A single package version within the recycle bin. :param direct_upstream_source_id: Upstream source this package was ingested from. :type direct_upstream_source_id: str @@ -954,7 +976,8 @@ def __init__(self, direct_upstream_source_id=None, id=None, is_cached_version=No class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -970,7 +993,8 @@ def __init__(self, links=None): class UpstreamSource(Model): - """UpstreamSource. + """ + Upstream source definition, including its Identity, package type, and other associated information. :param deleted_date: UTC date that this upstream was deleted. :type deleted_date: datetime @@ -1022,7 +1046,8 @@ def __init__(self, deleted_date=None, display_location=None, id=None, internal_u class Feed(FeedCore): - """Feed. + """ + A container for artifacts. :param allow_upstream_name_conflict: OBSOLETE: If set, the feed will allow upload of packages that exist on the upstream :type allow_upstream_name_conflict: bool diff --git a/azure-devops/azure/devops/v5_1/feed_token/models.py b/azure-devops/azure/devops/v5_1/feed_token/models.py index e9a65cf4..43b24b24 100644 --- a/azure-devops/azure/devops/v5_1/feed_token/models.py +++ b/azure-devops/azure/devops/v5_1/feed_token/models.py @@ -10,7 +10,8 @@ class FeedSessionToken(Model): - """FeedSessionToken. + """ + A cut-down version of SessionToken that just has what FeedSessionTokenController needs to serve the UI and which actually generates a TypeScript type for the UI to use :param token: :type token: str diff --git a/azure-devops/azure/devops/v5_1/file_container/models.py b/azure-devops/azure/devops/v5_1/file_container/models.py index 1b8b6fe1..d4a58a1e 100644 --- a/azure-devops/azure/devops/v5_1/file_container/models.py +++ b/azure-devops/azure/devops/v5_1/file_container/models.py @@ -10,7 +10,8 @@ class FileContainer(Model): - """FileContainer. + """ + Represents a container that encapsulates a hierarchical file system. :param artifact_uri: Uri of the artifact associated with the container. :type artifact_uri: str @@ -78,7 +79,8 @@ def __init__(self, artifact_uri=None, content_location=None, created_by=None, da class FileContainerItem(Model): - """FileContainerItem. + """ + Represents an item in a container. :param container_id: Container Id. :type container_id: long diff --git a/azure-devops/azure/devops/v5_1/gallery/models.py b/azure-devops/azure/devops/v5_1/gallery/models.py index c9837d99..39cf6cdb 100644 --- a/azure-devops/azure/devops/v5_1/gallery/models.py +++ b/azure-devops/azure/devops/v5_1/gallery/models.py @@ -10,8 +10,7 @@ class AcquisitionOperation(Model): - """AcquisitionOperation. - + """ :param operation_state: State of the the AcquisitionOperation for the current user :type operation_state: object :param operation_type: AcquisitionOperationType: install, request, buy, etc... @@ -34,7 +33,8 @@ def __init__(self, operation_state=None, operation_type=None, reason=None): class AcquisitionOptions(Model): - """AcquisitionOptions. + """ + Market item acquisition options (install, buy, etc) for an installation target. :param default_operation: Default Operation for the ItemId in this target :type default_operation: :class:`AcquisitionOperation ` @@ -62,8 +62,7 @@ def __init__(self, default_operation=None, item_id=None, operations=None, target class Answers(Model): - """Answers. - + """ :param vSMarketplace_extension_name: Gets or sets the vs marketplace extension name :type vSMarketplace_extension_name: str :param vSMarketplace_publisher_name: Gets or sets the vs marketplace publsiher name @@ -82,8 +81,7 @@ def __init__(self, vSMarketplace_extension_name=None, vSMarketplace_publisher_na class AssetDetails(Model): - """AssetDetails. - + """ :param answers: Gets or sets the Answers, which contains vs marketplace extension name and publisher name :type answers: :class:`Answers ` :param publisher_natural_identifier: Gets or sets the VS publisher Id @@ -102,8 +100,7 @@ def __init__(self, answers=None, publisher_natural_identifier=None): class AzurePublisher(Model): - """AzurePublisher. - + """ :param azure_publisher_id: :type azure_publisher_id: str :param publisher_name: @@ -122,8 +119,7 @@ def __init__(self, azure_publisher_id=None, publisher_name=None): class AzureRestApiRequestModel(Model): - """AzureRestApiRequestModel. - + """ :param asset_details: Gets or sets the Asset details :type asset_details: :class:`AssetDetails ` :param asset_id: Gets or sets the asset id @@ -170,7 +166,8 @@ def __init__(self, asset_details=None, asset_id=None, asset_version=None, custom class CategoriesResult(Model): - """CategoriesResult. + """ + This is the set of categories in response to the get category query :param categories: :type categories: list of :class:`ExtensionCategory ` @@ -186,7 +183,8 @@ def __init__(self, categories=None): class CategoryLanguageTitle(Model): - """CategoryLanguageTitle. + """ + Definition of one title of a category :param lang: The language for which the title is applicable :type lang: str @@ -210,8 +208,7 @@ def __init__(self, lang=None, lcid=None, title=None): class EventCounts(Model): - """EventCounts. - + """ :param average_rating: Average rating on the day for extension :type average_rating: int :param buy_count: Number of times the extension was bought in hosted scenario (applies only to VSTS extensions) @@ -258,7 +255,8 @@ def __init__(self, average_rating=None, buy_count=None, connected_buy_count=None class ExtensionAcquisitionRequest(Model): - """ExtensionAcquisitionRequest. + """ + Contract for handling the extension acquisition process :param assignment_type: How the item is being assigned :type assignment_type: object @@ -298,8 +296,7 @@ def __init__(self, assignment_type=None, billing_id=None, item_id=None, operatio class ExtensionBadge(Model): - """ExtensionBadge. - + """ :param description: :type description: str :param img_uri: @@ -322,8 +319,7 @@ def __init__(self, description=None, img_uri=None, link=None): class ExtensionCategory(Model): - """ExtensionCategory. - + """ :param associated_products: The name of the products with which this category is associated to. :type associated_products: list of str :param category_id: @@ -358,8 +354,7 @@ def __init__(self, associated_products=None, category_id=None, category_name=Non class ExtensionDailyStat(Model): - """ExtensionDailyStat. - + """ :param counts: Stores the event counts :type counts: :class:`EventCounts ` :param extended_stats: Generic key/value pair to store extended statistics. Used for sending paid extension stats like Upgrade, Downgrade, Cancel trend etc. @@ -386,8 +381,7 @@ def __init__(self, counts=None, extended_stats=None, statistic_date=None, versio class ExtensionDailyStats(Model): - """ExtensionDailyStats. - + """ :param daily_stats: List of extension statistics data points :type daily_stats: list of :class:`ExtensionDailyStat ` :param extension_id: Id of the extension, this will never be sent back to the client. For internal use only. @@ -418,8 +412,7 @@ def __init__(self, daily_stats=None, extension_id=None, extension_name=None, pub class ExtensionDraft(Model): - """ExtensionDraft. - + """ :param assets: :type assets: list of :class:`ExtensionDraftAsset ` :param created_date: @@ -474,8 +467,7 @@ def __init__(self, assets=None, created_date=None, draft_state=None, extension_n class ExtensionDraftPatch(Model): - """ExtensionDraftPatch. - + """ :param extension_data: :type extension_data: :class:`UnpackagedExtensionData ` :param operation: @@ -494,7 +486,8 @@ def __init__(self, extension_data=None, operation=None): class ExtensionEvent(Model): - """ExtensionEvent. + """ + Stores details of each event :param id: Id which identifies each data point uniquely :type id: long @@ -522,7 +515,8 @@ def __init__(self, id=None, properties=None, statistic_date=None, version=None): class ExtensionEvents(Model): - """ExtensionEvents. + """ + Container object for all extension events. Stores all install and uninstall events related to an extension. The events container is generic so can store data of any type of event. New event types can be added without altering the contract. :param events: Generic container for events data. The dictionary key denotes the type of event and the list contains properties related to that event :type events: dict @@ -550,8 +544,7 @@ def __init__(self, events=None, extension_id=None, extension_name=None, publishe class ExtensionFile(Model): - """ExtensionFile. - + """ :param asset_type: :type asset_type: str :param language: @@ -574,7 +567,8 @@ def __init__(self, asset_type=None, language=None, source=None): class ExtensionFilterResult(Model): - """ExtensionFilterResult. + """ + The FilterResult is the set of extensions that matched a particular query filter. :param extensions: This is the set of appplications that matched the query filter supplied. :type extensions: list of :class:`PublishedExtension ` @@ -598,7 +592,8 @@ def __init__(self, extensions=None, paging_token=None, result_metadata=None): class ExtensionFilterResultMetadata(Model): - """ExtensionFilterResultMetadata. + """ + ExtensionFilterResultMetadata is one set of metadata for the result e.g. Total count. There can be multiple metadata items for one metadata. :param metadata_items: The metadata items for the category :type metadata_items: list of :class:`MetadataItem ` @@ -618,7 +613,8 @@ def __init__(self, metadata_items=None, metadata_type=None): class ExtensionPackage(Model): - """ExtensionPackage. + """ + Package that will be used to create or update a published extension :param extension_manifest: Base 64 encoded extension package :type extension_manifest: str @@ -634,8 +630,7 @@ def __init__(self, extension_manifest=None): class ExtensionPayload(Model): - """ExtensionPayload. - + """ :param description: :type description: str :param display_name: @@ -682,7 +677,8 @@ def __init__(self, description=None, display_name=None, file_name=None, installa class ExtensionQuery(Model): - """ExtensionQuery. + """ + An ExtensionQuery is used to search the gallery for a set of extensions that match one of many filter values. :param asset_types: When retrieving extensions with a query; frequently the caller only needs a small subset of the assets. The caller may specify a list of asset types that should be returned if the extension contains it. All other assets will not be returned. :type asset_types: list of str @@ -706,7 +702,8 @@ def __init__(self, asset_types=None, filters=None, flags=None): class ExtensionQueryResult(Model): - """ExtensionQueryResult. + """ + This is the set of extensions that matched a supplied query through the filters given. :param results: For each filter supplied in the query, a filter result will be returned in the query result. :type results: list of :class:`ExtensionFilterResult ` @@ -722,8 +719,7 @@ def __init__(self, results=None): class ExtensionShare(Model): - """ExtensionShare. - + """ :param id: :type id: str :param is_org: @@ -750,8 +746,7 @@ def __init__(self, id=None, is_org=None, name=None, type=None): class ExtensionStatistic(Model): - """ExtensionStatistic. - + """ :param statistic_name: :type statistic_name: str :param value: @@ -770,8 +765,7 @@ def __init__(self, statistic_name=None, value=None): class ExtensionStatisticUpdate(Model): - """ExtensionStatisticUpdate. - + """ :param extension_name: :type extension_name: str :param operation: @@ -798,8 +792,7 @@ def __init__(self, extension_name=None, operation=None, publisher_name=None, sta class ExtensionVersion(Model): - """ExtensionVersion. - + """ :param asset_uri: :type asset_uri: str :param badges: @@ -850,7 +843,8 @@ def __init__(self, asset_uri=None, badges=None, fallback_asset_uri=None, files=N class FilterCriteria(Model): - """FilterCriteria. + """ + One condition in a QueryFilter. :param filter_type: :type filter_type: int @@ -870,8 +864,7 @@ def __init__(self, filter_type=None, value=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -898,8 +891,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -958,8 +950,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class InstallationTarget(Model): - """InstallationTarget. - + """ :param target: :type target: str :param target_version: @@ -978,7 +969,8 @@ def __init__(self, target=None, target_version=None): class MetadataItem(Model): - """MetadataItem. + """ + MetadataItem is one value of metadata under a given category of metadata :param count: The count of the metadata item :type count: int @@ -998,7 +990,8 @@ def __init__(self, count=None, name=None): class NotificationsData(Model): - """NotificationsData. + """ + Information needed for sending mail notification :param data: Notification data needed :type data: dict @@ -1022,7 +1015,8 @@ def __init__(self, data=None, identities=None, type=None): class ProductCategoriesResult(Model): - """ProductCategoriesResult. + """ + This is the set of categories in response to the get category query :param categories: :type categories: list of :class:`ProductCategory ` @@ -1038,7 +1032,8 @@ def __init__(self, categories=None): class ProductCategory(Model): - """ProductCategory. + """ + This is the interface object to be used by Root Categories and Category Tree APIs for Visual Studio Ide. :param children: :type children: list of :class:`ProductCategory ` @@ -1066,8 +1061,7 @@ def __init__(self, children=None, has_children=None, id=None, title=None): class PublishedExtension(Model): - """PublishedExtension. - + """ :param categories: :type categories: list of str :param deployment_type: @@ -1146,7 +1140,8 @@ def __init__(self, categories=None, deployment_type=None, display_name=None, ext class PublisherBase(Model): - """PublisherBase. + """ + Keeping base class separate since publisher DB model class and publisher contract class share these common properties :param display_name: :type display_name: str @@ -1198,7 +1193,8 @@ def __init__(self, display_name=None, email_address=None, extensions=None, flags class PublisherFacts(Model): - """PublisherFacts. + """ + High-level information about the publisher, like id's and names :param display_name: :type display_name: str @@ -1226,7 +1222,8 @@ def __init__(self, display_name=None, flags=None, publisher_id=None, publisher_n class PublisherFilterResult(Model): - """PublisherFilterResult. + """ + The FilterResult is the set of publishers that matched a particular query filter. :param publishers: This is the set of appplications that matched the query filter supplied. :type publishers: list of :class:`Publisher ` @@ -1242,7 +1239,8 @@ def __init__(self, publishers=None): class PublisherQuery(Model): - """PublisherQuery. + """ + An PublisherQuery is used to search the gallery for a set of publishers that match one of many filter values. :param filters: Each filter is a unique query and will have matching set of publishers returned from the request. Each result will have the same index in the resulting array that the filter had in the incoming query. :type filters: list of :class:`QueryFilter ` @@ -1262,7 +1260,8 @@ def __init__(self, filters=None, flags=None): class PublisherQueryResult(Model): - """PublisherQueryResult. + """ + This is the set of publishers that matched a supplied query through the filters given. :param results: For each filter supplied in the query, a filter result will be returned in the query result. :type results: list of :class:`PublisherFilterResult ` @@ -1278,8 +1277,7 @@ def __init__(self, results=None): class PublisherRoleAssignment(Model): - """PublisherRoleAssignment. - + """ :param access: Designates the role as explicitly assigned or inherited. :type access: object :param access_display_name: User friendly description of access assignment. @@ -1306,8 +1304,7 @@ def __init__(self, access=None, access_display_name=None, identity=None, role=No class PublisherSecurityRole(Model): - """PublisherSecurityRole. - + """ :param allow_permissions: Permissions the role is allowed. :type allow_permissions: int :param deny_permissions: Permissions the role is denied. @@ -1346,8 +1343,7 @@ def __init__(self, allow_permissions=None, deny_permissions=None, description=No class PublisherUserRoleAssignmentRef(Model): - """PublisherUserRoleAssignmentRef. - + """ :param role_name: The name of the role assigned. :type role_name: str :param unique_name: Identifier of the user given the role assignment. @@ -1370,7 +1366,8 @@ def __init__(self, role_name=None, unique_name=None, user_id=None): class QnAItem(Model): - """QnAItem. + """ + The core structure of a QnA item :param created_date: Time when the review was first created :type created_date: datetime @@ -1406,7 +1403,8 @@ def __init__(self, created_date=None, id=None, status=None, text=None, updated_d class QueryFilter(Model): - """QueryFilter. + """ + A filter used to define a set of extensions to return during a query. :param criteria: The filter values define the set of values in this query. They are applied based on the QueryFilterType. :type criteria: list of :class:`FilterCriteria ` @@ -1446,7 +1444,8 @@ def __init__(self, criteria=None, direction=None, page_number=None, page_size=No class Question(QnAItem): - """Question. + """ + The structure of the question / thread :param created_date: Time when the review was first created :type created_date: datetime @@ -1480,8 +1479,7 @@ def __init__(self, created_date=None, id=None, status=None, text=None, updated_d class QuestionsResult(Model): - """QuestionsResult. - + """ :param has_more_questions: Flag indicating if there are more QnA threads to be shown (for paging) :type has_more_questions: bool :param questions: List of the QnA threads @@ -1500,8 +1498,7 @@ def __init__(self, has_more_questions=None, questions=None): class RatingCountPerRating(Model): - """RatingCountPerRating. - + """ :param rating: Rating value :type rating: str :param rating_count: Count of total ratings @@ -1520,7 +1517,8 @@ def __init__(self, rating=None, rating_count=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -1536,7 +1534,8 @@ def __init__(self, links=None): class Response(QnAItem): - """Response. + """ + The structure of a response :param created_date: Time when the review was first created :type created_date: datetime @@ -1566,8 +1565,7 @@ def __init__(self, created_date=None, id=None, status=None, text=None, updated_d class Review(Model): - """Review. - + """ :param admin_reply: Admin Reply, if any, for this review :type admin_reply: :class:`ReviewReply ` :param id: Unique identifier of a review item @@ -1626,8 +1624,7 @@ def __init__(self, admin_reply=None, id=None, is_deleted=None, is_ignored=None, class ReviewPatch(Model): - """ReviewPatch. - + """ :param operation: Denotes the patch operation type :type operation: object :param reported_concern: Use when patch operation is FlagReview @@ -1650,8 +1647,7 @@ def __init__(self, operation=None, reported_concern=None, review_item=None): class ReviewReply(Model): - """ReviewReply. - + """ :param id: Id of the reply :type id: long :param is_deleted: Flag for soft deletion @@ -1694,8 +1690,7 @@ def __init__(self, id=None, is_deleted=None, product_version=None, reply_text=No class ReviewsResult(Model): - """ReviewsResult. - + """ :param has_more_reviews: Flag indicating if there are more reviews to be shown (for paging) :type has_more_reviews: bool :param reviews: List of reviews @@ -1718,8 +1713,7 @@ def __init__(self, has_more_reviews=None, reviews=None, total_review_count=None) class ReviewSummary(Model): - """ReviewSummary. - + """ :param average_rating: Average Rating :type average_rating: int :param rating_count: Count of total ratings @@ -1742,8 +1736,7 @@ def __init__(self, average_rating=None, rating_count=None, rating_split=None): class UnpackagedExtensionData(Model): - """UnpackagedExtensionData. - + """ :param categories: :type categories: list of str :param description: @@ -1822,7 +1815,8 @@ def __init__(self, categories=None, description=None, display_name=None, draft_i class UserIdentityRef(Model): - """UserIdentityRef. + """ + Identity reference with name and guid :param display_name: User display name :type display_name: str @@ -1842,8 +1836,7 @@ def __init__(self, display_name=None, id=None): class UserReportedConcern(Model): - """UserReportedConcern. - + """ :param category: Category of the concern :type category: object :param concern_text: User comment associated with the report @@ -1874,7 +1867,8 @@ def __init__(self, category=None, concern_text=None, review_id=None, submitted_d class Concern(QnAItem): - """Concern. + """ + The structure of a Concern Rather than defining a separate data structure having same fields as QnAItem, we are inheriting from the QnAItem. :param created_date: Time when the review was first created :type created_date: datetime @@ -1908,8 +1902,7 @@ def __init__(self, created_date=None, id=None, status=None, text=None, updated_d class ExtensionDraftAsset(ExtensionFile): - """ExtensionDraftAsset. - + """ :param asset_type: :type asset_type: str :param language: @@ -1929,8 +1922,7 @@ def __init__(self, asset_type=None, language=None, source=None): class Publisher(PublisherBase): - """Publisher. - + """ :param display_name: :type display_name: str :param email_address: diff --git a/azure-devops/azure/devops/v5_1/git/models.py b/azure-devops/azure/devops/v5_1/git/models.py index 28c02b6a..6be4d37d 100644 --- a/azure-devops/azure/devops/v5_1/git/models.py +++ b/azure-devops/azure/devops/v5_1/git/models.py @@ -10,7 +10,8 @@ class Attachment(Model): - """Attachment. + """ + Meta data for a file attached to an artifact. :param _links: Links to other related objects. :type _links: :class:`ReferenceLinks ` @@ -58,8 +59,7 @@ def __init__(self, _links=None, author=None, content_hash=None, created_date=Non class Change(Model): - """Change. - + """ :param change_type: The type of change that was made to the item. :type change_type: object :param item: Current version. @@ -90,7 +90,8 @@ def __init__(self, change_type=None, item=None, new_content=None, source_server_ class Comment(Model): - """Comment. + """ + Represents a comment which is one of potentially many in a comment thread. :param _links: Links to other related objects. :type _links: :class:`ReferenceLinks ` @@ -146,7 +147,8 @@ def __init__(self, _links=None, author=None, comment_type=None, content=None, id class CommentIterationContext(Model): - """CommentIterationContext. + """ + Comment iteration context is used to identify which diff was being viewed when the thread was created. :param first_comparing_iteration: The iteration of the file on the left side of the diff when the thread was created. If this value is equal to SecondComparingIteration, then this version is the common commit between the source and target branches of the pull request. :type first_comparing_iteration: int @@ -166,8 +168,7 @@ def __init__(self, first_comparing_iteration=None, second_comparing_iteration=No class CommentPosition(Model): - """CommentPosition. - + """ :param line: The line number of a thread's position. Starts at 1. :type line: int :param offset: The character offset of a thread's position inside of a line. Starts at 0. @@ -186,7 +187,8 @@ def __init__(self, line=None, offset=None): class CommentThread(Model): - """CommentThread. + """ + Represents a comment thread of a pull request. A thread contains meta data about the file it was left on along with one or more comments (an initial comment and the subsequent replies). :param _links: Links to other related objects. :type _links: :class:`ReferenceLinks ` @@ -238,8 +240,7 @@ def __init__(self, _links=None, comments=None, id=None, identities=None, is_dele class CommentThreadContext(Model): - """CommentThreadContext. - + """ :param file_path: File path relative to the root of the repository. It's up to the client to use any path format. :type file_path: str :param left_file_end: Position of last character of the thread's span in left file. @@ -270,7 +271,8 @@ def __init__(self, file_path=None, left_file_end=None, left_file_start=None, rig class CommentTrackingCriteria(Model): - """CommentTrackingCriteria. + """ + Comment tracking criteria is used to identify which iteration context the thread has been tracked to (if any) along with some detail about the original position and filename. :param first_comparing_iteration: The iteration of the file on the left side of the diff that the thread will be tracked to. Threads were tracked if this is greater than 0. :type first_comparing_iteration: int @@ -310,8 +312,7 @@ def __init__(self, first_comparing_iteration=None, orig_file_path=None, orig_lef class FileContentMetadata(Model): - """FileContentMetadata. - + """ :param content_type: :type content_type: str :param encoding: @@ -350,7 +351,8 @@ def __init__(self, content_type=None, encoding=None, extension=None, file_name=N class FileDiff(Model): - """FileDiff. + """ + Provides properties that describe file differences :param line_diff_blocks: The collection of line diff blocks :type line_diff_blocks: list of :class:`LineDiffBlock ` @@ -374,7 +376,8 @@ def __init__(self, line_diff_blocks=None, original_path=None, path=None): class FileDiffParams(Model): - """FileDiffParams. + """ + Provides parameters that describe inputs for the file diff :param original_path: Original path of the file :type original_path: str @@ -394,7 +397,8 @@ def __init__(self, original_path=None, path=None): class FileDiffsCriteria(Model): - """FileDiffsCriteria. + """ + Provides properties that describe inputs for the file diffs :param base_version_commit: Commit ID of the base version :type base_version_commit: str @@ -418,7 +422,8 @@ def __init__(self, base_version_commit=None, file_diff_params=None, target_versi class GitAnnotatedTag(Model): - """GitAnnotatedTag. + """ + A Git annotated tag. :param message: The tagging Message :type message: str @@ -454,8 +459,7 @@ def __init__(self, message=None, name=None, object_id=None, tagged_by=None, tagg class GitAsyncRefOperation(Model): - """GitAsyncRefOperation. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param detailed_status: @@ -486,7 +490,8 @@ def __init__(self, _links=None, detailed_status=None, parameters=None, status=No class GitAsyncRefOperationDetail(Model): - """GitAsyncRefOperationDetail. + """ + Information about the progress of a cherry pick or revert operation. :param conflict: Indicates if there was a conflict generated when trying to cherry pick or revert the changes. :type conflict: bool @@ -522,7 +527,8 @@ def __init__(self, conflict=None, current_commit_id=None, failure_message=None, class GitAsyncRefOperationParameters(Model): - """GitAsyncRefOperationParameters. + """ + Parameters that are provided in the request body when requesting to cherry pick or revert. :param generated_ref_name: Proposed target branch name for the cherry pick or revert operation. :type generated_ref_name: str @@ -550,7 +556,8 @@ def __init__(self, generated_ref_name=None, onto_ref_name=None, repository=None, class GitAsyncRefOperationSource(Model): - """GitAsyncRefOperationSource. + """ + GitAsyncRefOperationSource specifies the pull request or list of commits to use when making a cherry pick and revert operation request. Only one should be provided. :param commit_list: A list of commits to cherry pick or revert :type commit_list: list of :class:`GitCommitRef ` @@ -570,8 +577,7 @@ def __init__(self, commit_list=None, pull_request_id=None): class GitBlobRef(Model): - """GitBlobRef. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param object_id: SHA1 hash of git object @@ -598,7 +604,8 @@ def __init__(self, _links=None, object_id=None, size=None, url=None): class GitBranchStats(Model): - """GitBranchStats. + """ + Ahead and behind counts for a particular ref. :param ahead_count: Number of commits ahead. :type ahead_count: int @@ -630,7 +637,8 @@ def __init__(self, ahead_count=None, behind_count=None, commit=None, is_base_ver class GitCherryPick(GitAsyncRefOperation): - """GitCherryPick. + """ + This object is returned from Cherry Pick operations and provides the id and status of the operation :param _links: :type _links: :class:`ReferenceLinks ` @@ -661,8 +669,7 @@ def __init__(self, _links=None, detailed_status=None, parameters=None, status=No class GitCommitChanges(Model): - """GitCommitChanges. - + """ :param change_counts: :type change_counts: dict :param changes: @@ -681,8 +688,7 @@ def __init__(self, change_counts=None, changes=None): class GitCommitDiffs(Model): - """GitCommitDiffs. - + """ :param ahead_count: :type ahead_count: int :param all_changes_included: @@ -725,7 +731,8 @@ def __init__(self, ahead_count=None, all_changes_included=None, base_commit=None class GitCommitRef(Model): - """GitCommitRef. + """ + Provides properties that describe a Git commit and associated metadata. :param _links: A collection of related REST reference links. :type _links: :class:`ReferenceLinks ` @@ -793,8 +800,7 @@ def __init__(self, _links=None, author=None, change_counts=None, changes=None, c class GitConflict(Model): - """GitConflict. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param conflict_id: @@ -857,8 +863,7 @@ def __init__(self, _links=None, conflict_id=None, conflict_path=None, conflict_t class GitConflictUpdateResult(Model): - """GitConflictUpdateResult. - + """ :param conflict_id: Conflict ID that was provided by input :type conflict_id: int :param custom_message: Reason for failing @@ -885,8 +890,7 @@ def __init__(self, conflict_id=None, custom_message=None, updated_conflict=None, class GitDeletedRepository(Model): - """GitDeletedRepository. - + """ :param created_date: :type created_date: datetime :param deleted_by: @@ -921,8 +925,7 @@ def __init__(self, created_date=None, deleted_by=None, deleted_date=None, id=Non class GitFilePathsCollection(Model): - """GitFilePathsCollection. - + """ :param commit_id: :type commit_id: str :param paths: @@ -945,7 +948,8 @@ def __init__(self, commit_id=None, paths=None, url=None): class GitForkOperationStatusDetail(Model): - """GitForkOperationStatusDetail. + """ + Status information about a requested fork operation. :param all_steps: All valid steps for the forking process :type all_steps: list of str @@ -969,7 +973,8 @@ def __init__(self, all_steps=None, current_step=None, error_message=None): class GitForkSyncRequest(Model): - """GitForkSyncRequest. + """ + Request to sync data between two forks. :param _links: Collection of related links :type _links: :class:`ReferenceLinks ` @@ -1005,7 +1010,8 @@ def __init__(self, _links=None, detailed_status=None, operation_id=None, source= class GitForkSyncRequestParameters(Model): - """GitForkSyncRequestParameters. + """ + Parameters for creating a fork request :param source: Fully-qualified identifier for the source repository. :type source: :class:`GlobalGitRepositoryKey ` @@ -1025,7 +1031,8 @@ def __init__(self, source=None, source_to_target_refs=None): class GitImportGitSource(Model): - """GitImportGitSource. + """ + Parameter for creating a git import request when source is Git version control :param overwrite: Tells if this is a sync request or not :type overwrite: bool @@ -1045,7 +1052,8 @@ def __init__(self, overwrite=None, url=None): class GitImportRequest(Model): - """GitImportRequest. + """ + A request to import data from a remote source control system. :param _links: Links to related resources. :type _links: :class:`ReferenceLinks ` @@ -1085,7 +1093,8 @@ def __init__(self, _links=None, detailed_status=None, import_request_id=None, pa class GitImportRequestParameters(Model): - """GitImportRequestParameters. + """ + Parameters for creating an import request :param delete_service_endpoint_after_import_is_done: Option to delete service endpoint when import is done :type delete_service_endpoint_after_import_is_done: bool @@ -1113,7 +1122,8 @@ def __init__(self, delete_service_endpoint_after_import_is_done=None, git_source class GitImportStatusDetail(Model): - """GitImportStatusDetail. + """ + Additional status information about an import request. :param all_steps: All valid steps for the import process :type all_steps: list of str @@ -1137,7 +1147,8 @@ def __init__(self, all_steps=None, current_step=None, error_message=None): class GitImportTfvcSource(Model): - """GitImportTfvcSource. + """ + Parameter for creating a git import request when source is tfvc version control :param import_history: Set true to import History, false otherwise :type import_history: bool @@ -1161,8 +1172,7 @@ def __init__(self, import_history=None, import_history_duration_in_days=None, pa class GitItemDescriptor(Model): - """GitItemDescriptor. - + """ :param path: Path to item :type path: str :param recursion_level: Specifies whether to include children (OneLevel), all descendants (Full), or None @@ -1193,8 +1203,7 @@ def __init__(self, path=None, recursion_level=None, version=None, version_option class GitItemRequestData(Model): - """GitItemRequestData. - + """ :param include_content_metadata: Whether to include metadata for all items :type include_content_metadata: bool :param include_links: Whether to include the _links field on the shallow references @@ -1221,7 +1230,8 @@ def __init__(self, include_content_metadata=None, include_links=None, item_descr class GitMergeOperationStatusDetail(Model): - """GitMergeOperationStatusDetail. + """ + Status information about a requested merge operation. :param failure_message: Error message if the operation failed. :type failure_message: str @@ -1241,8 +1251,7 @@ def __init__(self, failure_message=None, merge_commit_id=None): class GitMergeOriginRef(Model): - """GitMergeOriginRef. - + """ :param pull_request_id: :type pull_request_id: int """ @@ -1257,7 +1266,8 @@ def __init__(self, pull_request_id=None): class GitMergeParameters(Model): - """GitMergeParameters. + """ + Parameters required for performing git merge. :param comment: Comment or message of the commit. :type comment: str @@ -1277,7 +1287,8 @@ def __init__(self, comment=None, parents=None): class GitObject(Model): - """GitObject. + """ + Git object identifier and type information. :param object_id: Object Id (Sha1Id). :type object_id: str @@ -1297,8 +1308,7 @@ def __init__(self, object_id=None, object_type=None): class GitPolicyConfigurationResponse(Model): - """GitPolicyConfigurationResponse. - + """ :param continuation_token: The HTTP client methods find the continuation token header in the response and populate this field. :type continuation_token: str :param policy_configurations: @@ -1317,7 +1327,8 @@ def __init__(self, continuation_token=None, policy_configurations=None): class GitPullRequest(Model): - """GitPullRequest. + """ + Represents all the data associated with a pull request. :param _links: Links to other related objects. :type _links: :class:`ReferenceLinks ` @@ -1465,7 +1476,8 @@ def __init__(self, _links=None, artifact_id=None, auto_complete_set_by=None, clo class GitPullRequestChange(Model): - """GitPullRequestChange. + """ + Change made in a pull request. :param change_tracking_id: ID used to track files through multiple changes. :type change_tracking_id: int @@ -1481,7 +1493,8 @@ def __init__(self, change_tracking_id=None): class GitPullRequestCommentThread(CommentThread): - """GitPullRequestCommentThread. + """ + Represents a comment thread of a pull request. A thread contains meta data about the file it was left on (if any) along with one or more comments (an initial comment and the subsequent replies). :param _links: Links to other related objects. :type _links: :class:`ReferenceLinks ` @@ -1527,7 +1540,8 @@ def __init__(self, _links=None, comments=None, id=None, identities=None, is_dele class GitPullRequestCommentThreadContext(Model): - """GitPullRequestCommentThreadContext. + """ + Comment thread context contains details about what diffs were being viewed at the time of thread creation and whether or not the thread has been tracked from that original diff. :param change_tracking_id: Used to track a comment across iterations. This value can be found by looking at the iteration's changes list. Must be set for pull requests with iteration support. Otherwise, it's not required for 'legacy' pull requests. :type change_tracking_id: int @@ -1551,7 +1565,8 @@ def __init__(self, change_tracking_id=None, iteration_context=None, tracking_cri class GitPullRequestCompletionOptions(Model): - """GitPullRequestCompletionOptions. + """ + Preferences about how the pull request should be completed. :param bypass_policy: If true, policies will be explicitly bypassed while the pull request is completed. :type bypass_policy: bool @@ -1595,7 +1610,8 @@ def __init__(self, bypass_policy=None, bypass_reason=None, delete_source_branch= class GitPullRequestIteration(Model): - """GitPullRequestIteration. + """ + Provides properties that describe a Git pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request. :param _links: A collection of related REST reference links. :type _links: :class:`ReferenceLinks ` @@ -1671,7 +1687,8 @@ def __init__(self, _links=None, author=None, change_list=None, commits=None, com class GitPullRequestIterationChanges(Model): - """GitPullRequestIterationChanges. + """ + Collection of changes made in a pull request. :param change_entries: Changes made in the iteration. :type change_entries: list of :class:`GitPullRequestChange ` @@ -1695,7 +1712,8 @@ def __init__(self, change_entries=None, next_skip=None, next_top=None): class GitPullRequestMergeOptions(Model): - """GitPullRequestMergeOptions. + """ + The options which are used when a pull request merge is created. :param detect_rename_false_positives: :type detect_rename_false_positives: bool @@ -1715,7 +1733,8 @@ def __init__(self, detect_rename_false_positives=None, disable_renames=None): class GitPullRequestQuery(Model): - """GitPullRequestQuery. + """ + A set of pull request queries and their results. :param queries: The queries to perform. :type queries: list of :class:`GitPullRequestQueryInput ` @@ -1735,7 +1754,8 @@ def __init__(self, queries=None, results=None): class GitPullRequestQueryInput(Model): - """GitPullRequestQueryInput. + """ + Pull request query input parameters. :param items: The list of commit IDs to search for. :type items: list of str @@ -1755,7 +1775,8 @@ def __init__(self, items=None, type=None): class GitPullRequestSearchCriteria(Model): - """GitPullRequestSearchCriteria. + """ + Pull requests can be searched for matching this criteria. :param creator_id: If set, search for pull requests that were created by this identity. :type creator_id: str @@ -1799,8 +1820,7 @@ def __init__(self, creator_id=None, include_links=None, repository_id=None, revi class GitPushRef(Model): - """GitPushRef. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param date: @@ -1835,8 +1855,7 @@ def __init__(self, _links=None, date=None, push_correlation_id=None, pushed_by=N class GitPushSearchCriteria(Model): - """GitPushSearchCriteria. - + """ :param from_date: :type from_date: datetime :param include_links: Whether to include the _links field on the shallow references @@ -1871,8 +1890,7 @@ def __init__(self, from_date=None, include_links=None, include_ref_updates=None, class GitQueryBranchStatsCriteria(Model): - """GitQueryBranchStatsCriteria. - + """ :param base_commit: :type base_commit: :class:`GitVersionDescriptor ` :param target_commits: @@ -1891,8 +1909,7 @@ def __init__(self, base_commit=None, target_commits=None): class GitQueryCommitsCriteria(Model): - """GitQueryCommitsCriteria. - + """ :param skip: Number of entries to skip :type skip: int :param top: Maximum number of entries to retrieve @@ -1975,8 +1992,7 @@ def __init__(self, skip=None, top=None, author=None, compare_version=None, exclu class GitRecycleBinRepositoryDetails(Model): - """GitRecycleBinRepositoryDetails. - + """ :param deleted: Setting to false will undo earlier deletion and restore the repository. :type deleted: bool """ @@ -1991,8 +2007,7 @@ def __init__(self, deleted=None): class GitRef(Model): - """GitRef. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param creator: @@ -2039,8 +2054,7 @@ def __init__(self, _links=None, creator=None, is_locked=None, is_locked_by=None, class GitRefFavorite(Model): - """GitRefFavorite. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param id: @@ -2079,8 +2093,7 @@ def __init__(self, _links=None, id=None, identity_id=None, name=None, repository class GitRefUpdate(Model): - """GitRefUpdate. - + """ :param is_locked: :type is_locked: bool :param name: @@ -2111,8 +2124,7 @@ def __init__(self, is_locked=None, name=None, new_object_id=None, old_object_id= class GitRefUpdateResult(Model): - """GitRefUpdateResult. - + """ :param custom_message: Custom message for the result object For instance, Reason for failing. :type custom_message: str :param is_locked: Whether the ref is locked or not @@ -2159,8 +2171,7 @@ def __init__(self, custom_message=None, is_locked=None, name=None, new_object_id class GitRepository(Model): - """GitRepository. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param default_branch: @@ -2223,8 +2234,7 @@ def __init__(self, _links=None, default_branch=None, id=None, is_fork=None, name class GitRepositoryCreateOptions(Model): - """GitRepositoryCreateOptions. - + """ :param name: :type name: str :param parent_repository: @@ -2247,8 +2257,7 @@ def __init__(self, name=None, parent_repository=None, project=None): class GitRepositoryRef(Model): - """GitRepositoryRef. - + """ :param collection: Team Project Collection where this Fork resides :type collection: :class:`TeamProjectCollectionReference ` :param id: @@ -2291,8 +2300,7 @@ def __init__(self, collection=None, id=None, is_fork=None, name=None, project=No class GitRepositoryStats(Model): - """GitRepositoryStats. - + """ :param active_pull_requests_count: :type active_pull_requests_count: int :param branches_count: @@ -2319,8 +2327,7 @@ def __init__(self, active_pull_requests_count=None, branches_count=None, commits class GitRevert(GitAsyncRefOperation): - """GitRevert. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param detailed_status: @@ -2350,7 +2357,8 @@ def __init__(self, _links=None, detailed_status=None, parameters=None, status=No class GitStatus(Model): - """GitStatus. + """ + This class contains the metadata of a service/extension posting a status. :param _links: Reference links. :type _links: :class:`ReferenceLinks ` @@ -2398,7 +2406,8 @@ def __init__(self, _links=None, context=None, created_by=None, creation_date=Non class GitStatusContext(Model): - """GitStatusContext. + """ + Status context that uniquely identifies the status. :param genre: Genre of the status. Typically name of the service/tool generating the status, can be empty. :type genre: str @@ -2418,7 +2427,8 @@ def __init__(self, genre=None, name=None): class GitSuggestion(Model): - """GitSuggestion. + """ + An object describing the git suggestion. Git suggestions are currently limited to suggested pull requests. :param properties: Specific properties describing the suggestion. :type properties: dict @@ -2438,8 +2448,7 @@ def __init__(self, properties=None, type=None): class GitTemplate(Model): - """GitTemplate. - + """ :param name: Name of the Template :type name: str :param type: Type of the Template @@ -2458,8 +2467,7 @@ def __init__(self, name=None, type=None): class GitTreeDiff(Model): - """GitTreeDiff. - + """ :param base_tree_id: ObjectId of the base tree of this diff. :type base_tree_id: str :param diff_entries: List of tree entries that differ between the base and target tree. Renames and object type changes are returned as a delete for the old object and add for the new object. If a continuation token is returned in the response header, some tree entries are yet to be processed and may yeild more diff entries. If the continuation token is not returned all the diff entries have been included in this response. @@ -2486,8 +2494,7 @@ def __init__(self, base_tree_id=None, diff_entries=None, target_tree_id=None, ur class GitTreeDiffEntry(Model): - """GitTreeDiffEntry. - + """ :param base_object_id: SHA1 hash of the object in the base tree, if it exists. Will be null in case of adds. :type base_object_id: str :param change_type: Type of change that affected this entry. @@ -2518,8 +2525,7 @@ def __init__(self, base_object_id=None, change_type=None, object_type=None, path class GitTreeDiffResponse(Model): - """GitTreeDiffResponse. - + """ :param continuation_token: The HTTP client methods find the continuation token header in the response and populate this field. :type continuation_token: list of str :param tree_diff: @@ -2538,8 +2544,7 @@ def __init__(self, continuation_token=None, tree_diff=None): class GitTreeEntryRef(Model): - """GitTreeEntryRef. - + """ :param git_object_type: Blob or tree :type git_object_type: object :param mode: Mode represented as octal string @@ -2574,8 +2579,7 @@ def __init__(self, git_object_type=None, mode=None, object_id=None, relative_pat class GitTreeRef(Model): - """GitTreeRef. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param object_id: SHA1 hash of git object @@ -2606,7 +2610,8 @@ def __init__(self, _links=None, object_id=None, size=None, tree_entries=None, ur class GitUserDate(Model): - """GitUserDate. + """ + User info and date for Git operations. :param date: Date of the Git operation. :type date: datetime @@ -2634,8 +2639,7 @@ def __init__(self, date=None, email=None, image_url=None, name=None): class GitVersionDescriptor(Model): - """GitVersionDescriptor. - + """ :param version: Version string identifier (name of tag/branch, SHA1 of commit) :type version: str :param version_options: Version options - Specify additional modifiers to version (e.g Previous) @@ -2658,7 +2662,8 @@ def __init__(self, version=None, version_options=None, version_type=None): class GlobalGitRepositoryKey(Model): - """GlobalGitRepositoryKey. + """ + Globally unique key for a repository. :param collection_id: Team Project Collection ID of the collection for the repository. :type collection_id: str @@ -2682,8 +2687,7 @@ def __init__(self, collection_id=None, project_id=None, repository_id=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -2710,8 +2714,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -2770,7 +2773,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class IdentityRefWithVote(IdentityRef): - """IdentityRefWithVote. + """ + Identity information including a vote on a pull request. :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` @@ -2837,8 +2841,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class ImportRepositoryValidation(Model): - """ImportRepositoryValidation. - + """ :param git_source: :type git_source: :class:`GitImportGitSource ` :param password: @@ -2865,8 +2868,7 @@ def __init__(self, git_source=None, password=None, tfvc_source=None, username=No class ItemContent(Model): - """ItemContent. - + """ :param content: :type content: str :param content_type: @@ -2885,8 +2887,7 @@ def __init__(self, content=None, content_type=None): class ItemModel(Model): - """ItemModel. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param content: @@ -2925,7 +2926,8 @@ def __init__(self, _links=None, content=None, content_metadata=None, is_folder=N class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -2953,7 +2955,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class LineDiffBlock(Model): - """LineDiffBlock. + """ + The class to represent the line diff block :param change_type: Type of change that was made to the block. :type change_type: object @@ -2985,7 +2988,8 @@ def __init__(self, change_type=None, modified_line_number_start=None, modified_l class PolicyConfigurationRef(Model): - """PolicyConfigurationRef. + """ + Policy configuration reference. :param id: The policy configuration ID. :type id: int @@ -3009,7 +3013,8 @@ def __init__(self, id=None, type=None, url=None): class PolicyTypeRef(Model): - """PolicyTypeRef. + """ + Policy type reference. :param display_name: Display name of the policy type. :type display_name: str @@ -3033,7 +3038,8 @@ def __init__(self, display_name=None, id=None, url=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -3049,8 +3055,7 @@ def __init__(self, links=None): class ResourceRef(Model): - """ResourceRef. - + """ :param id: :type id: str :param url: @@ -3069,7 +3074,8 @@ def __init__(self, id=None, url=None): class ShareNotificationContext(Model): - """ShareNotificationContext. + """ + Context used while sharing a pull request. :param message: Optional user note or message. :type message: str @@ -3089,8 +3095,7 @@ def __init__(self, message=None, receivers=None): class SourceToTargetRef(Model): - """SourceToTargetRef. - + """ :param source_ref: The source ref to copy. For example, refs/heads/master. :type source_ref: str :param target_ref: The target ref to update. For example, refs/heads/master. @@ -3109,7 +3114,8 @@ def __init__(self, source_ref=None, target_ref=None): class TeamProjectCollectionReference(Model): - """TeamProjectCollectionReference. + """ + Reference object for a TeamProjectCollection. :param id: Collection Id. :type id: str @@ -3133,7 +3139,8 @@ def __init__(self, id=None, name=None, url=None): class TeamProjectReference(Model): - """TeamProjectReference. + """ + Represents a shallow reference to a TeamProject. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -3185,7 +3192,8 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class VersionedPolicyConfigurationRef(PolicyConfigurationRef): - """VersionedPolicyConfigurationRef. + """ + A particular revision for a policy configuration. :param id: The policy configuration ID. :type id: int @@ -3210,8 +3218,7 @@ def __init__(self, id=None, type=None, url=None, revision=None): class VstsInfo(Model): - """VstsInfo. - + """ :param collection: :type collection: :class:`TeamProjectCollectionReference ` :param repository: @@ -3234,7 +3241,8 @@ def __init__(self, collection=None, repository=None, server_url=None): class WebApiCreateTagRequestData(Model): - """WebApiCreateTagRequestData. + """ + The representation of data needed to create a tag definition which is sent across the wire. :param name: Name of the tag definition that will be created. :type name: str @@ -3250,7 +3258,8 @@ def __init__(self, name=None): class WebApiTagDefinition(Model): - """WebApiTagDefinition. + """ + The representation of a tag definition which is sent across the wire. :param active: Whether or not the tag definition is active. :type active: bool @@ -3278,8 +3287,7 @@ def __init__(self, active=None, id=None, name=None, url=None): class GitBaseVersionDescriptor(GitVersionDescriptor): - """GitBaseVersionDescriptor. - + """ :param version: Version string identifier (name of tag/branch, SHA1 of commit) :type version: str :param version_options: Version options - Specify additional modifiers to version (e.g Previous) @@ -3311,8 +3319,7 @@ def __init__(self, version=None, version_options=None, version_type=None, base_v class GitCommit(GitCommitRef): - """GitCommit. - + """ :param _links: A collection of related REST reference links. :type _links: :class:`ReferenceLinks ` :param author: Author of the commit. @@ -3369,7 +3376,8 @@ def __init__(self, _links=None, author=None, change_counts=None, changes=None, c class GitForkRef(GitRef): - """GitForkRef. + """ + Information about a fork ref. :param _links: :type _links: :class:`ReferenceLinks ` @@ -3412,8 +3420,7 @@ def __init__(self, _links=None, creator=None, is_locked=None, is_locked_by=None, class GitItem(ItemModel): - """GitItem. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param content: @@ -3465,8 +3472,7 @@ def __init__(self, _links=None, content=None, content_metadata=None, is_folder=N class GitMerge(GitMergeParameters): - """GitMerge. - + """ :param comment: Comment or message of the commit. :type comment: str :param parents: An enumeration of the parent commit IDs for the merge commit. @@ -3499,7 +3505,8 @@ def __init__(self, comment=None, parents=None, _links=None, detailed_status=None class GitPullRequestStatus(GitStatus): - """GitPullRequestStatus. + """ + This class contains the metadata of a service/extension posting pull request status. Status can be associated with a pull request or an iteration. :param _links: Reference links. :type _links: :class:`ReferenceLinks ` @@ -3546,8 +3553,7 @@ def __init__(self, _links=None, context=None, created_by=None, creation_date=Non class GitPush(GitPushRef): - """GitPush. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param date: @@ -3588,8 +3594,7 @@ def __init__(self, _links=None, date=None, push_correlation_id=None, pushed_by=N class GitTargetVersionDescriptor(GitVersionDescriptor): - """GitTargetVersionDescriptor. - + """ :param version: Version string identifier (name of tag/branch, SHA1 of commit) :type version: str :param version_options: Version options - Specify additional modifiers to version (e.g Previous) @@ -3621,7 +3626,8 @@ def __init__(self, version=None, version_options=None, version_type=None, target class PolicyConfiguration(VersionedPolicyConfigurationRef): - """PolicyConfiguration. + """ + The full policy configuration with settings. :param id: The policy configuration ID. :type id: int diff --git a/azure-devops/azure/devops/v5_1/graph/models.py b/azure-devops/azure/devops/v5_1/graph/models.py index 35ba8fd0..8c444def 100644 --- a/azure-devops/azure/devops/v5_1/graph/models.py +++ b/azure-devops/azure/devops/v5_1/graph/models.py @@ -10,8 +10,7 @@ class Avatar(Model): - """Avatar. - + """ :param is_auto_generated: :type is_auto_generated: bool :param size: @@ -38,8 +37,7 @@ def __init__(self, is_auto_generated=None, size=None, time_stamp=None, value=Non class GraphCachePolicies(Model): - """GraphCachePolicies. - + """ :param cache_size: Size of the cache :type cache_size: int """ @@ -54,7 +52,8 @@ def __init__(self, cache_size=None): class GraphDescriptorResult(Model): - """GraphDescriptorResult. + """ + Subject descriptor of a Graph entity :param _links: This field contains zero or more interesting links about the graph descriptor. These links may be invoked to obtain additional relationships or more detailed information about this graph descriptor. :type _links: :class:`ReferenceLinks ` @@ -74,7 +73,8 @@ def __init__(self, _links=None, value=None): class GraphFederatedProviderData(Model): - """GraphFederatedProviderData. + """ + Represents a set of data used to communicate with a federated provider on behalf of a particular user. :param access_token: The access token that can be used to communicated with the federated provider on behalf on the target identity, if we were able to successfully acquire one, otherwise null, if we were not. :type access_token: str @@ -102,7 +102,8 @@ def __init__(self, access_token=None, provider_name=None, subject_descriptor=Non class GraphGroupCreationContext(Model): - """GraphGroupCreationContext. + """ + Do not attempt to use this type to create a new group. This type does not contain sufficient fields to create a new group. :param storage_key: Optional: If provided, we will use this identifier for the storage key of the created group :type storage_key: str @@ -118,7 +119,8 @@ def __init__(self, storage_key=None): class GraphMembership(Model): - """GraphMembership. + """ + Relationship between a container and a member :param _links: This field contains zero or more interesting links about the graph membership. These links may be invoked to obtain additional relationships or more detailed information about this graph membership. :type _links: :class:`ReferenceLinks ` @@ -142,7 +144,8 @@ def __init__(self, _links=None, container_descriptor=None, member_descriptor=Non class GraphMembershipState(Model): - """GraphMembershipState. + """ + Status of a Graph membership (active/inactive) :param _links: This field contains zero or more interesting links about the graph membership state. These links may be invoked to obtain additional relationships or more detailed information about this graph membership state. :type _links: :class:`ReferenceLinks ` @@ -162,8 +165,7 @@ def __init__(self, _links=None, active=None): class GraphMembershipTraversal(Model): - """GraphMembershipTraversal. - + """ :param incompleteness_reason: Reason why the subject could not be traversed completely :type incompleteness_reason: str :param is_complete: When true, the subject is traversed completely @@ -194,7 +196,8 @@ def __init__(self, incompleteness_reason=None, is_complete=None, subject_descrip class GraphProviderInfo(Model): - """GraphProviderInfo. + """ + Who is the provider for this user and what is the identifier and domain that is used to uniquely identify the user. :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. :type descriptor: str @@ -222,7 +225,8 @@ def __init__(self, descriptor=None, domain=None, origin=None, origin_id=None): class GraphScopeCreationContext(Model): - """GraphScopeCreationContext. + """ + This type is the subset of fields that can be provided by the user to create a Vsts scope. Scope creation is currently limited to internal back-compat scenarios. End users that attempt to create a scope with this API will fail. :param admin_group_description: Set this field to override the default description of this scope's admin group. :type admin_group_description: str @@ -258,7 +262,8 @@ def __init__(self, admin_group_description=None, admin_group_name=None, creator_ class GraphStorageKeyResult(Model): - """GraphStorageKeyResult. + """ + Storage key of a Graph entity :param _links: This field contains zero or more interesting links about the graph storage key. These links may be invoked to obtain additional relationships or more detailed information about this graph storage key. :type _links: :class:`ReferenceLinks ` @@ -278,8 +283,7 @@ def __init__(self, _links=None, value=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -306,7 +310,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class GraphSubjectLookup(Model): - """GraphSubjectLookup. + """ + Batching of subjects to lookup using the Graph API :param lookup_keys: :type lookup_keys: list of :class:`GraphSubjectLookupKey ` @@ -322,8 +327,7 @@ def __init__(self, lookup_keys=None): class GraphSubjectLookupKey(Model): - """GraphSubjectLookupKey. - + """ :param descriptor: :type descriptor: :class:`str ` """ @@ -338,7 +342,8 @@ def __init__(self, descriptor=None): class GraphUserCreationContext(Model): - """GraphUserCreationContext. + """ + Do not attempt to use this type to create a new user. Use one of the subclasses instead. This type does not contain sufficient fields to create a new user. :param storage_key: Optional: If provided, we will use this identifier for the storage key of the created user :type storage_key: str @@ -354,7 +359,8 @@ def __init__(self, storage_key=None): class GraphUserUpdateContext(Model): - """GraphUserUpdateContext. + """ + Do not attempt to use this type to update user. Use one of the subclasses instead. This type does not contain sufficient fields to create a new user. :param storage_key: Storage key should not be specified in case of updating user :type storage_key: str @@ -370,7 +376,8 @@ def __init__(self, storage_key=None): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -398,8 +405,7 @@ def __init__(self, from_=None, op=None, path=None, value=None): class PagedGraphGroups(Model): - """PagedGraphGroups. - + """ :param continuation_token: This will be non-null if there is another page of data. There will never be more than one continuation token returned by a request. :type continuation_token: list of str :param graph_groups: The enumerable list of groups found within a page. @@ -418,8 +424,7 @@ def __init__(self, continuation_token=None, graph_groups=None): class PagedGraphUsers(Model): - """PagedGraphUsers. - + """ :param continuation_token: This will be non-null if there is another page of data. There will never be more than one continuation token returned by a request. :type continuation_token: list of str :param graph_users: The enumerable set of users found within a page. @@ -438,7 +443,8 @@ def __init__(self, continuation_token=None, graph_users=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -454,7 +460,8 @@ def __init__(self, links=None): class GraphSubject(GraphSubjectBase): - """GraphSubject. + """ + Top-level graph entity :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` @@ -494,8 +501,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, le class GraphMember(GraphSubject): - """GraphMember. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -542,7 +548,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, le class GraphScope(GraphSubject): - """GraphScope. + """ + Container where a graph entity is defined (organization, project, team) :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` @@ -598,7 +605,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, le class GraphUser(GraphMember): - """GraphUser. + """ + Graph user entity :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` @@ -659,7 +667,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, le class GraphGroup(GraphMember): - """GraphGroup. + """ + Graph group entity :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` diff --git a/azure-devops/azure/devops/v5_1/identity/models.py b/azure-devops/azure/devops/v5_1/identity/models.py index 778e1b4b..1ab60571 100644 --- a/azure-devops/azure/devops/v5_1/identity/models.py +++ b/azure-devops/azure/devops/v5_1/identity/models.py @@ -10,8 +10,7 @@ class AccessTokenResult(Model): - """AccessTokenResult. - + """ :param access_token: :type access_token: :class:`JsonWebToken ` :param access_token_error: @@ -54,8 +53,7 @@ def __init__(self, access_token=None, access_token_error=None, authorization_id= class AuthorizationGrant(Model): - """AuthorizationGrant. - + """ :param grant_type: :type grant_type: object """ @@ -70,7 +68,8 @@ def __init__(self, grant_type=None): class ChangedIdentities(Model): - """ChangedIdentities. + """ + Container class for changed identities :param identities: Changed Identities :type identities: list of :class:`Identity ` @@ -94,7 +93,8 @@ def __init__(self, identities=None, more_data=None, sequence_context=None): class ChangedIdentitiesContext(Model): - """ChangedIdentitiesContext. + """ + Context class for changed identities :param group_sequence_id: Last Group SequenceId :type group_sequence_id: int @@ -122,8 +122,7 @@ def __init__(self, group_sequence_id=None, identity_sequence_id=None, organizati class CreateScopeInfo(Model): - """CreateScopeInfo. - + """ :param admin_group_description: :type admin_group_description: str :param admin_group_name: @@ -158,8 +157,7 @@ def __init__(self, admin_group_description=None, admin_group_name=None, creator_ class FrameworkIdentityInfo(Model): - """FrameworkIdentityInfo. - + """ :param display_name: :type display_name: str :param identifier: @@ -186,8 +184,7 @@ def __init__(self, display_name=None, identifier=None, identity_type=None, role= class GroupMembership(Model): - """GroupMembership. - + """ :param active: :type active: bool :param descriptor: @@ -214,7 +211,8 @@ def __init__(self, active=None, descriptor=None, id=None, queried_id=None): class IdentityBase(Model): - """IdentityBase. + """ + Base Identity class to allow "trimmed" identity class in the GetConnectionData API Makes sure that on-the-wire representations of the derived classes are compatible with each other (e.g. Server responds with PublicIdentity object while client deserializes it as Identity object) Derived classes should not have additional [DataMember] properties :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str @@ -290,8 +288,7 @@ def __init__(self, custom_display_name=None, descriptor=None, id=None, is_active class IdentityBatchInfo(Model): - """IdentityBatchInfo. - + """ :param descriptors: :type descriptors: list of :class:`str ` :param identity_ids: @@ -330,8 +327,7 @@ def __init__(self, descriptors=None, identity_ids=None, include_restricted_visib class IdentityScope(Model): - """IdentityScope. - + """ :param administrators: :type administrators: :class:`str ` :param id: @@ -382,7 +378,8 @@ def __init__(self, administrators=None, id=None, is_active=None, is_global=None, class IdentitySelf(Model): - """IdentitySelf. + """ + Identity information. :param account_name: The UserPrincipalName (UPN) of the account. This value comes from the source provider. :type account_name: str @@ -422,8 +419,7 @@ def __init__(self, account_name=None, display_name=None, domain=None, id=None, o class IdentitySnapshot(Model): - """IdentitySnapshot. - + """ :param groups: :type groups: list of :class:`Identity ` :param identity_ids: @@ -454,8 +450,7 @@ def __init__(self, groups=None, identity_ids=None, memberships=None, scope_id=No class IdentityUpdateData(Model): - """IdentityUpdateData. - + """ :param id: :type id: str :param index: @@ -478,7 +473,8 @@ def __init__(self, id=None, index=None, updated=None): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -506,8 +502,7 @@ def __init__(self, from_=None, op=None, path=None, value=None): class JsonWebToken(Model): - """JsonWebToken. - + """ """ _attribute_map = { @@ -518,8 +513,7 @@ def __init__(self): class RefreshTokenGrant(AuthorizationGrant): - """RefreshTokenGrant. - + """ :param grant_type: :type grant_type: object :param jwt: @@ -537,8 +531,7 @@ def __init__(self, grant_type=None, jwt=None): class SwapIdentityInfo(Model): - """SwapIdentityInfo. - + """ :param id1: :type id1: str :param id2: @@ -557,8 +550,7 @@ def __init__(self, id1=None, id2=None): class TenantInfo(Model): - """TenantInfo. - + """ :param home_tenant: :type home_tenant: bool :param tenant_id: @@ -585,8 +577,7 @@ def __init__(self, home_tenant=None, tenant_id=None, tenant_name=None, verified_ class Identity(IdentityBase): - """Identity. - + """ :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str :param descriptor: diff --git a/azure-devops/azure/devops/v5_1/location/models.py b/azure-devops/azure/devops/v5_1/location/models.py index 482a210e..5b44fbc7 100644 --- a/azure-devops/azure/devops/v5_1/location/models.py +++ b/azure-devops/azure/devops/v5_1/location/models.py @@ -10,8 +10,7 @@ class AccessMapping(Model): - """AccessMapping. - + """ :param access_point: :type access_point: str :param display_name: @@ -42,7 +41,8 @@ def __init__(self, access_point=None, display_name=None, moniker=None, service_o class ConnectionData(Model): - """ConnectionData. + """ + Data transfer class that holds information needed to set up a connection with a VSS server. :param authenticated_user: The Id of the authenticated user who made this request. More information about the user can be obtained by passing this Id to the Identity service :type authenticated_user: :class:`Identity ` @@ -86,7 +86,8 @@ def __init__(self, authenticated_user=None, authorized_user=None, deployment_id= class IdentityBase(Model): - """IdentityBase. + """ + Base Identity class to allow "trimmed" identity class in the GetConnectionData API Makes sure that on-the-wire representations of the derived classes are compatible with each other (e.g. Server responds with PublicIdentity object while client deserializes it as Identity object) Derived classes should not have additional [DataMember] properties :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str @@ -162,8 +163,7 @@ def __init__(self, custom_display_name=None, descriptor=None, id=None, is_active class LocationMapping(Model): - """LocationMapping. - + """ :param access_mapping_moniker: :type access_mapping_moniker: str :param location: @@ -182,7 +182,8 @@ def __init__(self, access_mapping_moniker=None, location=None): class LocationServiceData(Model): - """LocationServiceData. + """ + Data transfer class used to transfer data about the location service data over the web service. :param access_mappings: Data about the access mappings contained by this location service. :type access_mappings: list of :class:`AccessMapping ` @@ -226,8 +227,7 @@ def __init__(self, access_mappings=None, client_cache_fresh=None, client_cache_t class ResourceAreaInfo(Model): - """ResourceAreaInfo. - + """ :param id: :type id: str :param location_url: @@ -250,8 +250,7 @@ def __init__(self, id=None, location_url=None, name=None): class ServiceDefinition(Model): - """ServiceDefinition. - + """ :param description: :type description: str :param display_name: @@ -334,8 +333,7 @@ def __init__(self, description=None, display_name=None, identifier=None, inherit class Identity(IdentityBase): - """Identity. - + """ :param custom_display_name: The custom display name for the identity (if any). Setting this property to an empty string will clear the existing custom display name. Setting this property to null will not affect the existing persisted value (since null values do not get sent over the wire or to the database) :type custom_display_name: str :param descriptor: diff --git a/azure-devops/azure/devops/v5_1/maven/models.py b/azure-devops/azure/devops/v5_1/maven/models.py index 9e119681..0600fb07 100644 --- a/azure-devops/azure/devops/v5_1/maven/models.py +++ b/azure-devops/azure/devops/v5_1/maven/models.py @@ -10,7 +10,8 @@ class BatchOperationData(Model): - """BatchOperationData. + """ + Do not attempt to use this type to create a new BatchOperationData. This type does not contain sufficient fields to create a new batch operation data. """ @@ -22,8 +23,7 @@ def __init__(self): class MavenDistributionManagement(Model): - """MavenDistributionManagement. - + """ :param repository: :type repository: :class:`MavenRepository ` :param snapshot_repository: @@ -42,7 +42,8 @@ def __init__(self, repository=None, snapshot_repository=None): class MavenMinimalPackageDetails(Model): - """MavenMinimalPackageDetails. + """ + Identifies a particular Maven package version :param artifact: Package artifact ID :type artifact: str @@ -66,8 +67,7 @@ def __init__(self, artifact=None, group=None, version=None): class MavenPackage(Model): - """MavenPackage. - + """ :param artifact_id: :type artifact_id: str :param artifact_index: @@ -126,7 +126,8 @@ def __init__(self, artifact_id=None, artifact_index=None, artifact_metadata=None class MavenPackagesBatchRequest(Model): - """MavenPackagesBatchRequest. + """ + A batch of operations to apply to package versions. :param data: Data required to perform the operation. This is optional based on type of operation. Use BatchPromoteData if performing a promote operation. :type data: :class:`BatchOperationData ` @@ -150,7 +151,8 @@ def __init__(self, data=None, operation=None, packages=None): class MavenPackageVersionDeletionState(Model): - """MavenPackageVersionDeletionState. + """ + Deletion state of a maven package. :param artifact_id: Artifact Id of the package. :type artifact_id: str @@ -178,8 +180,7 @@ def __init__(self, artifact_id=None, deleted_date=None, group_id=None, version=N class MavenPomBuild(Model): - """MavenPomBuild. - + """ :param plugins: :type plugins: list of :class:`Plugin ` """ @@ -194,8 +195,7 @@ def __init__(self, plugins=None): class MavenPomCi(Model): - """MavenPomCi. - + """ :param notifiers: :type notifiers: list of :class:`MavenPomCiNotifier ` :param system: @@ -218,8 +218,7 @@ def __init__(self, notifiers=None, system=None, url=None): class MavenPomCiNotifier(Model): - """MavenPomCiNotifier. - + """ :param configuration: :type configuration: list of str :param send_on_error: @@ -254,8 +253,7 @@ def __init__(self, configuration=None, send_on_error=None, send_on_failure=None, class MavenPomDependencyManagement(Model): - """MavenPomDependencyManagement. - + """ :param dependencies: :type dependencies: list of :class:`MavenPomDependency ` """ @@ -270,8 +268,7 @@ def __init__(self, dependencies=None): class MavenPomGav(Model): - """MavenPomGav. - + """ :param artifact_id: :type artifact_id: str :param group_id: @@ -294,8 +291,7 @@ def __init__(self, artifact_id=None, group_id=None, version=None): class MavenPomIssueManagement(Model): - """MavenPomIssueManagement. - + """ :param system: :type system: str :param url: @@ -314,8 +310,7 @@ def __init__(self, system=None, url=None): class MavenPomMailingList(Model): - """MavenPomMailingList. - + """ :param archive: :type archive: str :param name: @@ -350,8 +345,7 @@ def __init__(self, archive=None, name=None, other_archives=None, post=None, subs class MavenPomMetadata(MavenPomGav): - """MavenPomMetadata. - + """ :param artifact_id: :type artifact_id: str :param group_id: @@ -459,8 +453,7 @@ def __init__(self, artifact_id=None, group_id=None, version=None, build=None, ci class MavenPomOrganization(Model): - """MavenPomOrganization. - + """ :param name: :type name: str :param url: @@ -479,8 +472,7 @@ def __init__(self, name=None, url=None): class MavenPomParent(MavenPomGav): - """MavenPomParent. - + """ :param artifact_id: :type artifact_id: str :param group_id: @@ -504,8 +496,7 @@ def __init__(self, artifact_id=None, group_id=None, version=None, relative_path= class MavenPomPerson(Model): - """MavenPomPerson. - + """ :param email: :type email: str :param id: @@ -548,8 +539,7 @@ def __init__(self, email=None, id=None, name=None, organization=None, organizati class MavenPomScm(Model): - """MavenPomScm. - + """ :param connection: :type connection: str :param developer_connection: @@ -576,8 +566,7 @@ def __init__(self, connection=None, developer_connection=None, tag=None, url=Non class MavenRecycleBinPackageVersionDetails(Model): - """MavenRecycleBinPackageVersionDetails. - + """ :param deleted: Setting to false will undo earlier deletion and restore the package to feed. :type deleted: bool """ @@ -592,8 +581,7 @@ def __init__(self, deleted=None): class MavenRepository(Model): - """MavenRepository. - + """ :param unique_version: :type unique_version: bool """ @@ -608,8 +596,7 @@ def __init__(self, unique_version=None): class MavenSnapshotRepository(MavenRepository): - """MavenSnapshotRepository. - + """ :param unique_version: :type unique_version: bool """ @@ -623,7 +610,8 @@ def __init__(self, unique_version=None): class Package(Model): - """Package. + """ + Package version metadata for a Maven package :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -663,8 +651,7 @@ def __init__(self, _links=None, deleted_date=None, id=None, name=None, permanent class Plugin(MavenPomGav): - """Plugin. - + """ :param artifact_id: :type artifact_id: str :param group_id: @@ -688,8 +675,7 @@ def __init__(self, artifact_id=None, group_id=None, version=None, configuration= class PluginConfiguration(Model): - """PluginConfiguration. - + """ :param goal_prefix: :type goal_prefix: str """ @@ -704,7 +690,8 @@ def __init__(self, goal_prefix=None): class ReferenceLink(Model): - """ReferenceLink. + """ + The class to represent a REST reference link. RFC: http://tools.ietf.org/html/draft-kelly-json-hal-06 The RFC is not fully implemented, additional properties are allowed on the reference link but as of yet we don't have a need for them. :param href: :type href: str @@ -720,7 +707,8 @@ def __init__(self, href=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -736,7 +724,8 @@ def __init__(self, links=None): class UpstreamSourceInfo(Model): - """UpstreamSourceInfo. + """ + Upstream source definition, including its Identity, package type, and other associated information. :param display_location: Locator for connecting to the upstream source in a user friendly format, that may potentially change over time :type display_location: str @@ -768,8 +757,7 @@ def __init__(self, display_location=None, id=None, location=None, name=None, sou class MavenPomDependency(MavenPomGav): - """MavenPomDependency. - + """ :param artifact_id: :type artifact_id: str :param group_id: @@ -801,8 +789,7 @@ def __init__(self, artifact_id=None, group_id=None, version=None, optional=None, class MavenPomLicense(MavenPomOrganization): - """MavenPomLicense. - + """ :param name: :type name: str :param url: diff --git a/azure-devops/azure/devops/v5_1/member_entitlement_management/models.py b/azure-devops/azure/devops/v5_1/member_entitlement_management/models.py index 3d71a845..d0beae5a 100644 --- a/azure-devops/azure/devops/v5_1/member_entitlement_management/models.py +++ b/azure-devops/azure/devops/v5_1/member_entitlement_management/models.py @@ -10,7 +10,8 @@ class AccessLevel(Model): - """AccessLevel. + """ + License assigned to a user :param account_license_type: Type of Account License (e.g. Express, Stakeholder etc.) :type account_license_type: object @@ -50,8 +51,7 @@ def __init__(self, account_license_type=None, assignment_source=None, license_di class BaseOperationResult(Model): - """BaseOperationResult. - + """ :param errors: List of error codes paired with their corresponding error messages :type errors: list of { key: int; value: str } :param is_success: Success status of the operation @@ -70,7 +70,8 @@ def __init__(self, errors=None, is_success=None): class Extension(Model): - """Extension. + """ + An extension assigned to a user :param assignment_source: Assignment source for this extension. I.e. explicitly assigned or from a group rule. :type assignment_source: object @@ -98,8 +99,7 @@ def __init__(self, assignment_source=None, id=None, name=None, source=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -126,7 +126,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class Group(Model): - """Group. + """ + Project Group (e.g. Contributor, Reader etc.) :param display_name: Display Name of the Group :type display_name: str @@ -146,7 +147,8 @@ def __init__(self, display_name=None, group_type=None): class GroupEntitlement(Model): - """GroupEntitlement. + """ + A group entity with additional properties including its license, extensions, and project membership :param extension_rules: Extension Rules. :type extension_rules: list of :class:`Extension ` @@ -190,8 +192,7 @@ def __init__(self, extension_rules=None, group=None, id=None, last_executed=None class GroupOperationResult(BaseOperationResult): - """GroupOperationResult. - + """ :param errors: List of error codes paired with their corresponding error messages :type errors: list of { key: int; value: str } :param is_success: Success status of the operation @@ -216,7 +217,8 @@ def __init__(self, errors=None, is_success=None, group_id=None, result=None): class GroupOption(Model): - """GroupOption. + """ + Group option to add a user to :param access_level: Access Level :type access_level: :class:`AccessLevel ` @@ -236,7 +238,8 @@ def __init__(self, access_level=None, group=None): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -264,8 +267,7 @@ def __init__(self, from_=None, op=None, path=None, value=None): class MemberEntitlementsResponseBase(Model): - """MemberEntitlementsResponseBase. - + """ :param is_success: True if all operations were successful. :type is_success: bool :param member_entitlement: Result of the member entitlement after the operations. have been applied @@ -284,7 +286,8 @@ def __init__(self, is_success=None, member_entitlement=None): class OperationReference(Model): - """OperationReference. + """ + Reference for an async operation. :param id: Unique identifier for the operation. :type id: str @@ -312,8 +315,7 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None): class OperationResult(Model): - """OperationResult. - + """ :param errors: List of error codes paired with their corresponding error messages. :type errors: list of { key: int; value: str } :param is_success: Success status of the operation. @@ -340,8 +342,7 @@ def __init__(self, errors=None, is_success=None, member_id=None, result=None): class PagedList(Model): - """PagedList. - + """ :param continuation_token: :type continuation_token: str :param items: @@ -364,7 +365,8 @@ def __init__(self, continuation_token=None, items=None, total_count=None): class ProjectEntitlement(Model): - """ProjectEntitlement. + """ + Relation between a project and the user's effective permissions in that project. :param assignment_source: Assignment Source (e.g. Group or Unknown). :type assignment_source: object @@ -400,7 +402,8 @@ def __init__(self, assignment_source=None, group=None, is_project_permission_inh class ProjectRef(Model): - """ProjectRef. + """ + A reference to a project :param id: Project ID. :type id: str @@ -420,7 +423,8 @@ def __init__(self, id=None, name=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -436,8 +440,7 @@ def __init__(self, links=None): class SummaryData(Model): - """SummaryData. - + """ :param assigned: Count of Licenses already assigned. :type assigned: int :param available: Available Count. @@ -464,7 +467,8 @@ def __init__(self, assigned=None, available=None, included_quantity=None, total= class TeamRef(Model): - """TeamRef. + """ + A reference to a team :param id: Team ID :type id: str @@ -484,7 +488,8 @@ def __init__(self, id=None, name=None): class UserEntitlement(Model): - """UserEntitlement. + """ + A user entity with additional properties including thier license, extensions, and project membership :param access_level: User's access level denoted by a license. :type access_level: :class:`AccessLevel ` @@ -528,8 +533,7 @@ def __init__(self, access_level=None, date_created=None, extensions=None, group_ class UserEntitlementOperationReference(OperationReference): - """UserEntitlementOperationReference. - + """ :param id: Unique identifier for the operation. :type id: str :param plugin_id: Unique identifier for the plugin. @@ -564,8 +568,7 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None, completed=Non class UserEntitlementOperationResult(Model): - """UserEntitlementOperationResult. - + """ :param errors: List of error codes paired with their corresponding error messages. :type errors: list of { key: int; value: str } :param is_success: Success status of the operation. @@ -592,8 +595,7 @@ def __init__(self, errors=None, is_success=None, result=None, user_id=None): class UserEntitlementsResponseBase(Model): - """UserEntitlementsResponseBase. - + """ :param is_success: True if all operations were successful. :type is_success: bool :param user_entitlement: Result of the user entitlement after the operations have been applied. @@ -612,7 +614,8 @@ def __init__(self, is_success=None, user_entitlement=None): class UsersSummary(Model): - """UsersSummary. + """ + Summary of licenses and extensions assigned to users in the organization :param available_access_levels: Available Access Levels :type available_access_levels: list of :class:`AccessLevel ` @@ -644,7 +647,8 @@ def __init__(self, available_access_levels=None, extensions=None, group_options= class ExtensionSummaryData(SummaryData): - """ExtensionSummaryData. + """ + Summary of Extensions in the organization. :param assigned: Count of Licenses already assigned. :type assigned: int @@ -696,7 +700,8 @@ def __init__(self, assigned=None, available=None, included_quantity=None, total= class GraphSubject(GraphSubjectBase): - """GraphSubject. + """ + Top-level graph entity :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` @@ -736,8 +741,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, le class GroupEntitlementOperationReference(OperationReference): - """GroupEntitlementOperationReference. - + """ :param id: Unique identifier for the operation. :type id: str :param plugin_id: Unique identifier for the plugin. @@ -772,7 +776,8 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None, completed=Non class LicenseSummaryData(SummaryData): - """LicenseSummaryData. + """ + Summary of Licenses in the organization. :param assigned: Count of Licenses already assigned. :type assigned: int @@ -828,7 +833,8 @@ def __init__(self, assigned=None, available=None, included_quantity=None, total= class MemberEntitlement(UserEntitlement): - """MemberEntitlement. + """ + Deprecated: Use UserEntitlement instead :param access_level: User's access level denoted by a license. :type access_level: :class:`AccessLevel ` @@ -868,8 +874,7 @@ def __init__(self, access_level=None, date_created=None, extensions=None, group_ class MemberEntitlementOperationReference(OperationReference): - """MemberEntitlementOperationReference. - + """ :param id: Unique identifier for the operation. :type id: str :param plugin_id: Unique identifier for the plugin. @@ -904,8 +909,7 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None, completed=Non class MemberEntitlementsPatchResponse(MemberEntitlementsResponseBase): - """MemberEntitlementsPatchResponse. - + """ :param is_success: True if all operations were successful. :type is_success: bool :param member_entitlement: Result of the member entitlement after the operations. have been applied @@ -926,8 +930,7 @@ def __init__(self, is_success=None, member_entitlement=None, operation_results=N class MemberEntitlementsPostResponse(MemberEntitlementsResponseBase): - """MemberEntitlementsPostResponse. - + """ :param is_success: True if all operations were successful. :type is_success: bool :param member_entitlement: Result of the member entitlement after the operations. have been applied @@ -948,7 +951,8 @@ def __init__(self, is_success=None, member_entitlement=None, operation_result=No class PagedGraphMemberList(PagedList): - """PagedGraphMemberList. + """ + A page of users :param members: :type members: list of :class:`UserEntitlement ` @@ -964,8 +968,7 @@ def __init__(self, members=None): class UserEntitlementsPatchResponse(UserEntitlementsResponseBase): - """UserEntitlementsPatchResponse. - + """ :param is_success: True if all operations were successful. :type is_success: bool :param user_entitlement: Result of the user entitlement after the operations have been applied. @@ -986,8 +989,7 @@ def __init__(self, is_success=None, user_entitlement=None, operation_results=Non class UserEntitlementsPostResponse(UserEntitlementsResponseBase): - """UserEntitlementsPostResponse. - + """ :param is_success: True if all operations were successful. :type is_success: bool :param user_entitlement: Result of the user entitlement after the operations have been applied. @@ -1008,8 +1010,7 @@ def __init__(self, is_success=None, user_entitlement=None, operation_result=None class GraphMember(GraphSubject): - """GraphMember. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -1056,7 +1057,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, le class GraphUser(GraphMember): - """GraphUser. + """ + Graph user entity :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` @@ -1117,7 +1119,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, le class GraphGroup(GraphMember): - """GraphGroup. + """ + Graph group entity :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` diff --git a/azure-devops/azure/devops/v5_1/notification/models.py b/azure-devops/azure/devops/v5_1/notification/models.py index c04ae0b0..0ca251cf 100644 --- a/azure-devops/azure/devops/v5_1/notification/models.py +++ b/azure-devops/azure/devops/v5_1/notification/models.py @@ -10,8 +10,7 @@ class BaseSubscriptionFilter(Model): - """BaseSubscriptionFilter. - + """ :param event_type: :type event_type: str :param type: @@ -30,8 +29,7 @@ def __init__(self, event_type=None, type=None): class BatchNotificationOperation(Model): - """BatchNotificationOperation. - + """ :param notification_operation: :type notification_operation: object :param notification_query_conditions: @@ -50,7 +48,8 @@ def __init__(self, notification_operation=None, notification_query_conditions=No class EventActor(Model): - """EventActor. + """ + Defines an "actor" for an event. :param id: Required: This is the identity of the user for the specified role. :type id: str @@ -70,7 +69,8 @@ def __init__(self, id=None, role=None): class EventScope(Model): - """EventScope. + """ + Defines a scope for an event. :param id: Required: This is the identity of the scope for the type. :type id: str @@ -94,7 +94,8 @@ def __init__(self, id=None, name=None, type=None): class EventsEvaluationResult(Model): - """EventsEvaluationResult. + """ + Encapsulates events result properties. It defines the total number of events used and the number of matched events. :param count: Count of events evaluated. :type count: int @@ -114,7 +115,8 @@ def __init__(self, count=None, matched_count=None): class EventTransformRequest(Model): - """EventTransformRequest. + """ + A transform request specify the properties of a notification event to be transformed. :param event_payload: Event payload. :type event_payload: str @@ -138,7 +140,8 @@ def __init__(self, event_payload=None, event_type=None, system_inputs=None): class EventTransformResult(Model): - """EventTransformResult. + """ + Result of transforming a notification event. :param content: Transformed html content. :type content: str @@ -162,7 +165,8 @@ def __init__(self, content=None, data=None, system_inputs=None): class ExpressionFilterClause(Model): - """ExpressionFilterClause. + """ + Subscription Filter Clause represents a single clause in a subscription filter e.g. If the subscription has the following criteria "Project Name = [Current Project] AND Assigned To = [Me] it will be represented as two Filter Clauses Clause 1: Index = 1, Logical Operator: NULL , FieldName = 'Project Name', Operator = '=', Value = '[Current Project]' Clause 2: Index = 2, Logical Operator: 'AND' , FieldName = 'Assigned To' , Operator = '=', Value = '[Me]' :param field_name: :type field_name: str @@ -194,7 +198,8 @@ def __init__(self, field_name=None, index=None, logical_operator=None, operator= class ExpressionFilterGroup(Model): - """ExpressionFilterGroup. + """ + Represents a hierarchy of SubscritionFilterClauses that have been grouped together through either adding a group in the WebUI or using parethesis in the Subscription condition string :param end: The index of the last FilterClause in this group :type end: int @@ -218,8 +223,7 @@ def __init__(self, end=None, level=None, start=None): class ExpressionFilterModel(Model): - """ExpressionFilterModel. - + """ :param clauses: Flat list of clauses in this subscription :type clauses: list of :class:`ExpressionFilterClause ` :param groups: Grouping of clauses in the subscription @@ -242,8 +246,7 @@ def __init__(self, clauses=None, groups=None, max_group_level=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -270,8 +273,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -330,7 +332,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class INotificationDiagnosticLog(Model): - """INotificationDiagnosticLog. + """ + Abstraction interface for the diagnostic log. Primarily for deserialization. :param activity_id: :type activity_id: str @@ -378,7 +381,8 @@ def __init__(self, activity_id=None, description=None, end_time=None, id=None, l class InputValue(Model): - """InputValue. + """ + Information about a single value for an input :param data: Any other data about this input :type data: dict @@ -402,7 +406,8 @@ def __init__(self, data=None, display_value=None, value=None): class InputValues(Model): - """InputValues. + """ + Information about the possible/allowed values for a given subscription input :param default_value: The default value to use for this input :type default_value: str @@ -442,7 +447,8 @@ def __init__(self, default_value=None, error=None, input_id=None, is_disabled=No class InputValuesError(Model): - """InputValuesError. + """ + Error information related to a subscription input value. :param message: The error message. :type message: str @@ -458,8 +464,7 @@ def __init__(self, message=None): class InputValuesQuery(Model): - """InputValuesQuery. - + """ :param current_values: :type current_values: dict :param input_values: The input values to return on input, and the result from the consumer on output. @@ -482,8 +487,7 @@ def __init__(self, current_values=None, input_values=None, resource=None): class ISubscriptionChannel(Model): - """ISubscriptionChannel. - + """ :param type: :type type: str """ @@ -498,8 +502,7 @@ def __init__(self, type=None): class ISubscriptionFilter(Model): - """ISubscriptionFilter. - + """ :param event_type: :type event_type: str :param type: @@ -518,8 +521,7 @@ def __init__(self, event_type=None, type=None): class NotificationAdminSettings(Model): - """NotificationAdminSettings. - + """ :param default_group_delivery_preference: The default group delivery preference for groups in this collection :type default_group_delivery_preference: object """ @@ -534,8 +536,7 @@ def __init__(self, default_group_delivery_preference=None): class NotificationAdminSettingsUpdateParameters(Model): - """NotificationAdminSettingsUpdateParameters. - + """ :param default_group_delivery_preference: :type default_group_delivery_preference: object """ @@ -550,8 +551,7 @@ def __init__(self, default_group_delivery_preference=None): class NotificationDiagnosticLogMessage(Model): - """NotificationDiagnosticLogMessage. - + """ :param level: Corresponds to .Net TraceLevel enumeration :type level: int :param message: @@ -574,7 +574,8 @@ def __init__(self, level=None, message=None, time=None): class NotificationEventField(Model): - """NotificationEventField. + """ + Encapsulates the properties of a filterable field. A filterable field is a field in an event that can used to filter notifications for a certain event type. :param field_type: Gets or sets the type of this field. :type field_type: :class:`NotificationEventFieldType ` @@ -606,7 +607,8 @@ def __init__(self, field_type=None, id=None, name=None, path=None, supported_sco class NotificationEventFieldOperator(Model): - """NotificationEventFieldOperator. + """ + Encapsulates the properties of a field type. It includes a unique id for the operator and a localized string for display name :param display_name: Gets or sets the display name of an operator :type display_name: str @@ -626,7 +628,8 @@ def __init__(self, display_name=None, id=None): class NotificationEventFieldType(Model): - """NotificationEventFieldType. + """ + Encapsulates the properties of a field type. It describes the data type of a field, the operators it support and how to populate it in the UI :param id: Gets or sets the unique identifier of this field type. :type id: str @@ -658,7 +661,8 @@ def __init__(self, id=None, operator_constraints=None, operators=None, subscript class NotificationEventPublisher(Model): - """NotificationEventPublisher. + """ + Encapsulates the properties of a notification event publisher. :param id: :type id: str @@ -682,7 +686,8 @@ def __init__(self, id=None, subscription_management_info=None, url=None): class NotificationEventRole(Model): - """NotificationEventRole. + """ + Encapsulates the properties of an event role. An event Role is used for role based subscription for example for a buildCompletedEvent, one role is request by field :param id: Gets or sets an Id for that role, this id is used by the event. :type id: str @@ -706,7 +711,8 @@ def __init__(self, id=None, name=None, supports_groups=None): class NotificationEventType(Model): - """NotificationEventType. + """ + Encapsulates the properties of an event type. It defines the fields, that can be used for filtering, for that event type. :param category: :type category: :class:`NotificationEventTypeCategory ` @@ -766,7 +772,8 @@ def __init__(self, category=None, color=None, custom_subscriptions_allowed=None, class NotificationEventTypeCategory(Model): - """NotificationEventTypeCategory. + """ + Encapsulates the properties of a category. A category will be used by the UI to group event types :param id: Gets or sets the unique identifier of this category. :type id: str @@ -786,8 +793,7 @@ def __init__(self, id=None, name=None): class NotificationQueryCondition(Model): - """NotificationQueryCondition. - + """ :param event_initiator: :type event_initiator: str :param event_type: @@ -814,8 +820,7 @@ def __init__(self, event_initiator=None, event_type=None, subscriber=None, subsc class NotificationReason(Model): - """NotificationReason. - + """ :param notification_reason_type: :type notification_reason_type: object :param target_identities: @@ -834,7 +839,8 @@ def __init__(self, notification_reason_type=None, target_identities=None): class NotificationsEvaluationResult(Model): - """NotificationsEvaluationResult. + """ + Encapsulates notifications result properties. It defines the number of notifications and the recipients of notifications. :param count: Count of generated notifications :type count: int @@ -850,8 +856,7 @@ def __init__(self, count=None): class NotificationStatistic(Model): - """NotificationStatistic. - + """ :param date: :type date: datetime :param hit_count: @@ -882,8 +887,7 @@ def __init__(self, date=None, hit_count=None, path=None, type=None, user=None): class NotificationStatisticsQuery(Model): - """NotificationStatisticsQuery. - + """ :param conditions: :type conditions: list of :class:`NotificationStatisticsQueryConditions ` """ @@ -898,8 +902,7 @@ def __init__(self, conditions=None): class NotificationStatisticsQueryConditions(Model): - """NotificationStatisticsQueryConditions. - + """ :param end_date: :type end_date: datetime :param hit_count_minimum: @@ -934,7 +937,8 @@ def __init__(self, end_date=None, hit_count_minimum=None, path=None, start_date= class NotificationSubscriber(Model): - """NotificationSubscriber. + """ + A subscriber is a user or group that has the potential to receive notifications. :param delivery_preference: Indicates how the subscriber should be notified by default. :type delivery_preference: object @@ -962,7 +966,8 @@ def __init__(self, delivery_preference=None, flags=None, id=None, preferred_emai class NotificationSubscriberUpdateParameters(Model): - """NotificationSubscriberUpdateParameters. + """ + Updates to a subscriber. Typically used to change (or set) a preferred email address or default delivery preference. :param delivery_preference: New delivery preference for the subscriber (indicates how the subscriber should be notified). :type delivery_preference: object @@ -982,7 +987,8 @@ def __init__(self, delivery_preference=None, preferred_email_address=None): class NotificationSubscription(Model): - """NotificationSubscription. + """ + A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. :param _links: Links to related resources, APIs, and views for the subscription. :type _links: :class:`ReferenceLinks ` @@ -1066,7 +1072,8 @@ def __init__(self, _links=None, admin_settings=None, channel=None, description=N class NotificationSubscriptionCreateParameters(Model): - """NotificationSubscriptionCreateParameters. + """ + Parameters for creating a new subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. :param channel: Channel for delivering notifications triggered by the new subscription. :type channel: :class:`ISubscriptionChannel ` @@ -1098,8 +1105,7 @@ def __init__(self, channel=None, description=None, filter=None, scope=None, subs class NotificationSubscriptionTemplate(Model): - """NotificationSubscriptionTemplate. - + """ :param description: :type description: str :param filter: @@ -1130,7 +1136,8 @@ def __init__(self, description=None, filter=None, id=None, notification_event_in class NotificationSubscriptionUpdateParameters(Model): - """NotificationSubscriptionUpdateParameters. + """ + Parameters for updating an existing subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. Note: only the fields to be updated should be set. :param admin_settings: Admin-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group. :type admin_settings: :class:`SubscriptionAdminSettings ` @@ -1174,7 +1181,8 @@ def __init__(self, admin_settings=None, channel=None, description=None, filter=N class OperatorConstraint(Model): - """OperatorConstraint. + """ + Encapsulates the properties of an operator constraint. An operator constraint defines if some operator is available only for specific scope like a project scope. :param operator: :type operator: str @@ -1194,7 +1202,8 @@ def __init__(self, operator=None, supported_scopes=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -1210,7 +1219,8 @@ def __init__(self, links=None): class SubscriptionAdminSettings(Model): - """SubscriptionAdminSettings. + """ + Admin-managed settings for a group subscription. :param block_user_opt_out: If true, members of the group subscribed to the associated subscription cannot opt (choose not to get notified) :type block_user_opt_out: bool @@ -1226,8 +1236,7 @@ def __init__(self, block_user_opt_out=None): class SubscriptionChannelWithAddress(Model): - """SubscriptionChannelWithAddress. - + """ :param address: :type address: str :param type: @@ -1250,8 +1259,7 @@ def __init__(self, address=None, type=None, use_custom_address=None): class SubscriptionDiagnostics(Model): - """SubscriptionDiagnostics. - + """ :param delivery_results: :type delivery_results: :class:`SubscriptionTracing ` :param delivery_tracing: @@ -1274,7 +1282,8 @@ def __init__(self, delivery_results=None, delivery_tracing=None, evaluation_trac class SubscriptionEvaluationRequest(Model): - """SubscriptionEvaluationRequest. + """ + Encapsulates the properties of a SubscriptionEvaluationRequest. It defines the subscription to be evaluated and time interval for events used in evaluation. :param min_events_created_date: The min created date for the events used for matching in UTC. Use all events created since this date :type min_events_created_date: datetime @@ -1294,7 +1303,8 @@ def __init__(self, min_events_created_date=None, subscription_create_parameters= class SubscriptionEvaluationResult(Model): - """SubscriptionEvaluationResult. + """ + Ecapsulates the subscription evaluation results. It defines the Date Interval that was used, number of events evaluated and events and notifications results :param evaluation_job_status: Subscription evaluation job status :type evaluation_job_status: object @@ -1322,7 +1332,8 @@ def __init__(self, evaluation_job_status=None, events=None, id=None, notificatio class SubscriptionEvaluationSettings(Model): - """SubscriptionEvaluationSettings. + """ + Encapsulates the subscription evaluation settings needed for the UI :param enabled: Indicates whether subscription evaluation before saving is enabled or not :type enabled: bool @@ -1350,7 +1361,8 @@ def __init__(self, enabled=None, interval=None, threshold=None, time_out=None): class SubscriptionManagement(Model): - """SubscriptionManagement. + """ + Encapsulates the properties needed to manage subscriptions, opt in and out of subscriptions. :param service_instance_type: :type service_instance_type: str @@ -1370,7 +1382,8 @@ def __init__(self, service_instance_type=None, url=None): class SubscriptionQuery(Model): - """SubscriptionQuery. + """ + Notification subscriptions query input. :param conditions: One or more conditions to query on. If more than 2 conditions are specified, the combined results of each condition is returned (i.e. conditions are logically OR'ed). :type conditions: list of :class:`SubscriptionQueryCondition ` @@ -1390,7 +1403,8 @@ def __init__(self, conditions=None, query_flags=None): class SubscriptionQueryCondition(Model): - """SubscriptionQueryCondition. + """ + Conditions a subscription must match to qualify for the query result set. Not all fields are required. A subscription must match all conditions specified in order to qualify for the result set. :param filter: Filter conditions that matching subscriptions must have. Typically only the filter's type and event type are used for matching. :type filter: :class:`ISubscriptionFilter ` @@ -1422,7 +1436,8 @@ def __init__(self, filter=None, flags=None, scope=None, subscriber_id=None, subs class SubscriptionScope(EventScope): - """SubscriptionScope. + """ + A resource, typically an account or project, in which events are published from. :param id: Required: This is the identity of the scope for the type. :type id: str @@ -1443,8 +1458,7 @@ def __init__(self, id=None, name=None, type=None): class SubscriptionTracing(Model): - """SubscriptionTracing. - + """ :param enabled: :type enabled: bool :param end_date: Trace until the specified end date. @@ -1475,7 +1489,8 @@ def __init__(self, enabled=None, end_date=None, max_traced_entries=None, start_d class SubscriptionUserSettings(Model): - """SubscriptionUserSettings. + """ + User-managed settings for a group subscription. :param opted_out: Indicates whether the user will receive notifications for the associated group subscription. :type opted_out: bool @@ -1491,8 +1506,7 @@ def __init__(self, opted_out=None): class UpdateSubscripitonDiagnosticsParameters(Model): - """UpdateSubscripitonDiagnosticsParameters. - + """ :param delivery_results: :type delivery_results: :class:`UpdateSubscripitonTracingParameters ` :param delivery_tracing: @@ -1515,8 +1529,7 @@ def __init__(self, delivery_results=None, delivery_tracing=None, evaluation_trac class UpdateSubscripitonTracingParameters(Model): - """UpdateSubscripitonTracingParameters. - + """ :param enabled: :type enabled: bool """ @@ -1531,7 +1544,8 @@ def __init__(self, enabled=None): class ValueDefinition(Model): - """ValueDefinition. + """ + Encapsulates the properties of a field value definition. It has the information needed to retrieve the list of possible values for a certain field and how to handle that field values in the UI. This information includes what type of object this value represents, which property to use for UI display and which property to use for saving the subscription :param data_source: Gets or sets the data source. :type data_source: list of :class:`InputValue ` @@ -1555,7 +1569,8 @@ def __init__(self, data_source=None, end_point=None, result_template=None): class VssNotificationEvent(Model): - """VssNotificationEvent. + """ + This is the type used for firing notifications intended for the subsystem in the Notifications SDK. For components that can't take a dependency on the Notifications SDK directly, they can use ITeamFoundationEventService.PublishNotification and the Notifications SDK ISubscriber implementation will get it. :param actors: Optional: A list of actors which are additional identities with corresponding roles that are relevant to the event. :type actors: list of :class:`EventActor ` @@ -1603,7 +1618,8 @@ def __init__(self, actors=None, artifact_uris=None, data=None, event_type=None, class ArtifactFilter(BaseSubscriptionFilter): - """ArtifactFilter. + """ + Artifact filter options. Used in "follow" subscriptions. :param event_type: :type event_type: str @@ -1634,8 +1650,7 @@ def __init__(self, event_type=None, artifact_id=None, artifact_type=None, artifa class FieldInputValues(InputValues): - """FieldInputValues. - + """ :param default_value: The default value to use for this input :type default_value: str :param error: Errors encountered while computing dynamic values. @@ -1671,8 +1686,7 @@ def __init__(self, default_value=None, error=None, input_id=None, is_disabled=No class FieldValuesQuery(InputValuesQuery): - """FieldValuesQuery. - + """ :param current_values: :type current_values: dict :param resource: Subscription containing information about the publisher/consumer and the current input values diff --git a/azure-devops/azure/devops/v5_1/npm/models.py b/azure-devops/azure/devops/v5_1/npm/models.py index ee728987..2e723377 100644 --- a/azure-devops/azure/devops/v5_1/npm/models.py +++ b/azure-devops/azure/devops/v5_1/npm/models.py @@ -10,7 +10,8 @@ class BatchOperationData(Model): - """BatchOperationData. + """ + Do not attempt to use this type to create a new BatchOperationData. This type does not contain sufficient fields to create a new batch operation data. """ @@ -22,7 +23,8 @@ def __init__(self): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -50,7 +52,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class MinimalPackageDetails(Model): - """MinimalPackageDetails. + """ + Minimal package details required to identify a package within a protocol. :param id: Package name. :type id: str @@ -70,7 +73,8 @@ def __init__(self, id=None, version=None): class NpmPackagesBatchRequest(Model): - """NpmPackagesBatchRequest. + """ + A batch of operations to apply to package versions. :param data: Data required to perform the operation. This is optional based on type of operation. Use BatchPromoteData if performing a promote operation. :type data: :class:`BatchOperationData ` @@ -94,7 +98,8 @@ def __init__(self, data=None, operation=None, packages=None): class NpmPackageVersionDeletionState(Model): - """NpmPackageVersionDeletionState. + """ + Deletion state of an npm package. :param name: Name of the package. :type name: str @@ -118,8 +123,7 @@ def __init__(self, name=None, unpublished_date=None, version=None): class NpmRecycleBinPackageVersionDetails(Model): - """NpmRecycleBinPackageVersionDetails. - + """ :param deleted: Setting to false will undo earlier deletion and restore the package to feed. :type deleted: bool """ @@ -134,7 +138,8 @@ def __init__(self, deleted=None): class Package(Model): - """Package. + """ + Package version metadata for an npm package :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -178,8 +183,7 @@ def __init__(self, _links=None, deprecate_message=None, id=None, name=None, perm class PackageVersionDetails(Model): - """PackageVersionDetails. - + """ :param deprecate_message: Indicates the deprecate message of a package version :type deprecate_message: str :param views: The view to which the package version will be added @@ -198,7 +202,8 @@ def __init__(self, deprecate_message=None, views=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -214,7 +219,8 @@ def __init__(self, links=None): class UpstreamSourceInfo(Model): - """UpstreamSourceInfo. + """ + Upstream source definition, including its Identity, package type, and other associated information. :param display_location: Locator for connecting to the upstream source in a user friendly format, that may potentially change over time :type display_location: str @@ -246,7 +252,8 @@ def __init__(self, display_location=None, id=None, location=None, name=None, sou class BatchDeprecateData(BatchOperationData): - """BatchDeprecateData. + """ + Data required to deprecate multiple package versions. Pass this while performing NpmBatchOperationTypes.Deprecate batch operation. :param message: Deprecate message that will be added to packages :type message: str diff --git a/azure-devops/azure/devops/v5_1/nuget/models.py b/azure-devops/azure/devops/v5_1/nuget/models.py index db93fd76..69a758a5 100644 --- a/azure-devops/azure/devops/v5_1/nuget/models.py +++ b/azure-devops/azure/devops/v5_1/nuget/models.py @@ -10,7 +10,8 @@ class BatchOperationData(Model): - """BatchOperationData. + """ + Do not attempt to use this type to create a new BatchOperationData. This type does not contain sufficient fields to create a new batch operation data. """ @@ -22,7 +23,8 @@ def __init__(self): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -50,7 +52,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class MinimalPackageDetails(Model): - """MinimalPackageDetails. + """ + Minimal package details required to identify a package within a protocol. :param id: Package name. :type id: str @@ -70,7 +73,8 @@ def __init__(self, id=None, version=None): class NuGetPackagesBatchRequest(Model): - """NuGetPackagesBatchRequest. + """ + A batch of operations to apply to package versions. :param data: Data required to perform the operation. This is optional based on the type of the operation. Use BatchPromoteData if performing a promote operation. :type data: :class:`BatchOperationData ` @@ -94,7 +98,8 @@ def __init__(self, data=None, operation=None, packages=None): class NuGetPackageVersionDeletionState(Model): - """NuGetPackageVersionDeletionState. + """ + Deletion state of a NuGet package. :param deleted_date: Utc date the package was deleted. :type deleted_date: datetime @@ -118,8 +123,7 @@ def __init__(self, deleted_date=None, name=None, version=None): class NuGetRecycleBinPackageVersionDetails(Model): - """NuGetRecycleBinPackageVersionDetails. - + """ :param deleted: Setting to false will undo earlier deletion and restore the package to feed. :type deleted: bool """ @@ -134,7 +138,8 @@ def __init__(self, deleted=None): class Package(Model): - """Package. + """ + Package version metadata for a NuGet package :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -174,8 +179,7 @@ def __init__(self, _links=None, deleted_date=None, id=None, name=None, permanent class PackageVersionDetails(Model): - """PackageVersionDetails. - + """ :param listed: Indicates the listing state of a package :type listed: bool :param views: The view to which the package version will be added @@ -194,7 +198,8 @@ def __init__(self, listed=None, views=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -210,7 +215,8 @@ def __init__(self, links=None): class UpstreamSourceInfo(Model): - """UpstreamSourceInfo. + """ + Upstream source definition, including its Identity, package type, and other associated information. :param display_location: Locator for connecting to the upstream source in a user friendly format, that may potentially change over time :type display_location: str @@ -242,7 +248,8 @@ def __init__(self, display_location=None, id=None, location=None, name=None, sou class BatchListData(BatchOperationData): - """BatchListData. + """ + Data required to unlist or relist multiple package versions. Pass this while performing NuGetBatchOperationTypes.List batch operation. :param listed: The desired listed status for the package versions. :type listed: bool diff --git a/azure-devops/azure/devops/v5_1/operations/models.py b/azure-devops/azure/devops/v5_1/operations/models.py index 79715934..04faed19 100644 --- a/azure-devops/azure/devops/v5_1/operations/models.py +++ b/azure-devops/azure/devops/v5_1/operations/models.py @@ -10,7 +10,8 @@ class OperationReference(Model): - """OperationReference. + """ + Reference for an async operation. :param id: Unique identifier for the operation. :type id: str @@ -38,8 +39,7 @@ def __init__(self, id=None, plugin_id=None, status=None, url=None): class OperationResultReference(Model): - """OperationResultReference. - + """ :param result_url: URL to the operation result. :type result_url: str """ @@ -54,7 +54,8 @@ def __init__(self, result_url=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -70,7 +71,8 @@ def __init__(self, links=None): class Operation(OperationReference): - """Operation. + """ + Contains information about the progress or result of an async operation. :param id: Unique identifier for the operation. :type id: str diff --git a/azure-devops/azure/devops/v5_1/pipelines/models.py b/azure-devops/azure/devops/v5_1/pipelines/models.py index bd2e3649..b07e7c78 100644 --- a/azure-devops/azure/devops/v5_1/pipelines/models.py +++ b/azure-devops/azure/devops/v5_1/pipelines/models.py @@ -10,8 +10,7 @@ class CreatePipelineConfigurationParameters(Model): - """CreatePipelineConfigurationParameters. - + """ :param type: :type type: object """ @@ -26,8 +25,7 @@ def __init__(self, type=None): class CreatePipelineParameters(Model): - """CreatePipelineParameters. - + """ :param configuration: :type configuration: :class:`CreatePipelineConfigurationParameters ` :param folder: @@ -50,8 +48,7 @@ def __init__(self, configuration=None, folder=None, name=None): class Log(Model): - """Log. - + """ :param created_on: The date and time the log was created. :type created_on: datetime :param id: The ID of the log. @@ -86,8 +83,7 @@ def __init__(self, created_on=None, id=None, last_changed_on=None, line_count=No class LogCollection(Model): - """LogCollection. - + """ :param logs: :type logs: list of :class:`Log ` :param signed_content: @@ -110,8 +106,7 @@ def __init__(self, logs=None, signed_content=None, url=None): class PipelineBase(Model): - """PipelineBase. - + """ :param folder: :type folder: str :param id: @@ -138,8 +133,7 @@ def __init__(self, folder=None, id=None, name=None, revision=None): class PipelineConfiguration(Model): - """PipelineConfiguration. - + """ :param type: :type type: object """ @@ -154,7 +148,8 @@ def __init__(self, type=None): class PipelineReference(PipelineBase): - """PipelineReference. + """ + A reference to a Pipeline. :param folder: :type folder: str @@ -182,7 +177,8 @@ def __init__(self, folder=None, id=None, name=None, revision=None, url=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -198,8 +194,7 @@ def __init__(self, links=None): class Repository(Model): - """Repository. - + """ :param type: :type type: object """ @@ -214,8 +209,7 @@ def __init__(self, type=None): class RepositoryResource(Model): - """RepositoryResource. - + """ :param ref_name: :type ref_name: str :param repository: @@ -238,8 +232,7 @@ def __init__(self, ref_name=None, repository=None, version=None): class RepositoryResourceParameters(Model): - """RepositoryResourceParameters. - + """ :param ref_name: :type ref_name: str :param token: This is the security token to use when connecting to the repository. @@ -266,8 +259,7 @@ def __init__(self, ref_name=None, token=None, token_type=None, version=None): class RunPipelineParameters(Model): - """RunPipelineParameters. - + """ :param configuration: :type configuration: JustInTimeConfiguration :param context: @@ -298,8 +290,7 @@ def __init__(self, configuration=None, context=None, resources=None, secrets=Non class RunReference(Model): - """RunReference. - + """ :param id: :type id: int :param name: @@ -318,8 +309,7 @@ def __init__(self, id=None, name=None): class RunResources(Model): - """RunResources. - + """ :param repositories: :type repositories: dict """ @@ -334,8 +324,7 @@ def __init__(self, repositories=None): class RunResourcesParameters(Model): - """RunResourcesParameters. - + """ :param repositories: :type repositories: dict """ @@ -350,7 +339,8 @@ def __init__(self, repositories=None): class SignedUrl(Model): - """SignedUrl. + """ + A signed url allowing limited-time anonymous access to private resources. :param signature_expires: :type signature_expires: datetime @@ -370,8 +360,7 @@ def __init__(self, signature_expires=None, url=None): class Variable(Model): - """Variable. - + """ :param is_secret: :type is_secret: bool :param value: @@ -390,8 +379,7 @@ def __init__(self, is_secret=None, value=None): class Pipeline(PipelineBase): - """Pipeline. - + """ :param folder: :type folder: str :param id: @@ -426,8 +414,7 @@ def __init__(self, folder=None, id=None, name=None, revision=None, _links=None, class Run(RunReference): - """Run. - + """ :param id: :type id: int :param name: diff --git a/azure-devops/azure/devops/v5_1/policy/models.py b/azure-devops/azure/devops/v5_1/policy/models.py index 03491033..defd4edb 100644 --- a/azure-devops/azure/devops/v5_1/policy/models.py +++ b/azure-devops/azure/devops/v5_1/policy/models.py @@ -10,8 +10,7 @@ class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -38,8 +37,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -98,7 +96,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class PolicyConfigurationRef(Model): - """PolicyConfigurationRef. + """ + Policy configuration reference. :param id: The policy configuration ID. :type id: int @@ -122,7 +121,8 @@ def __init__(self, id=None, type=None, url=None): class PolicyEvaluationRecord(Model): - """PolicyEvaluationRecord. + """ + This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to. :param _links: Links to other related objects :type _links: :class:`ReferenceLinks ` @@ -166,7 +166,8 @@ def __init__(self, _links=None, artifact_id=None, completed_date=None, configura class PolicyTypeRef(Model): - """PolicyTypeRef. + """ + Policy type reference. :param display_name: Display name of the policy type. :type display_name: str @@ -190,7 +191,8 @@ def __init__(self, display_name=None, id=None, url=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -206,7 +208,8 @@ def __init__(self, links=None): class VersionedPolicyConfigurationRef(PolicyConfigurationRef): - """VersionedPolicyConfigurationRef. + """ + A particular revision for a policy configuration. :param id: The policy configuration ID. :type id: int @@ -231,7 +234,8 @@ def __init__(self, id=None, type=None, url=None, revision=None): class PolicyConfiguration(VersionedPolicyConfigurationRef): - """PolicyConfiguration. + """ + The full policy configuration with settings. :param id: The policy configuration ID. :type id: int @@ -283,7 +287,8 @@ def __init__(self, id=None, type=None, url=None, revision=None, _links=None, cre class PolicyType(PolicyTypeRef): - """PolicyType. + """ + User-friendly policy type with description (used for querying policy types). :param display_name: Display name of the policy type. :type display_name: str diff --git a/azure-devops/azure/devops/v5_1/profile/models.py b/azure-devops/azure/devops/v5_1/profile/models.py index 0fee2061..dbf75d21 100644 --- a/azure-devops/azure/devops/v5_1/profile/models.py +++ b/azure-devops/azure/devops/v5_1/profile/models.py @@ -10,7 +10,8 @@ class AttributeDescriptor(Model): - """AttributeDescriptor. + """ + Identifies an attribute with a name and a container. :param attribute_name: The name of the attribute. :type attribute_name: str @@ -30,7 +31,8 @@ def __init__(self, attribute_name=None, container_name=None): class AttributesContainer(Model): - """AttributesContainer. + """ + Stores a set of named profile attributes. :param attributes: The attributes stored by the container. :type attributes: dict @@ -54,8 +56,7 @@ def __init__(self, attributes=None, container_name=None, revision=None): class Avatar(Model): - """Avatar. - + """ :param is_auto_generated: :type is_auto_generated: bool :param size: @@ -82,8 +83,7 @@ def __init__(self, is_auto_generated=None, size=None, time_stamp=None, value=Non class CreateProfileContext(Model): - """CreateProfileContext. - + """ :param cIData: :type cIData: dict :param contact_with_offers: @@ -130,8 +130,7 @@ def __init__(self, cIData=None, contact_with_offers=None, country_name=None, dis class GeoRegion(Model): - """GeoRegion. - + """ :param region_code: :type region_code: str """ @@ -146,7 +145,8 @@ def __init__(self, region_code=None): class Profile(Model): - """Profile. + """ + A user profile. :param application_container: The attributes of this profile. :type application_container: :class:`AttributesContainer ` @@ -186,8 +186,7 @@ def __init__(self, application_container=None, core_attributes=None, core_revisi class ProfileAttributeBase(Model): - """ProfileAttributeBase. - + """ :param descriptor: The descriptor of the attribute. :type descriptor: :class:`AttributeDescriptor ` :param revision: The revision number of the attribute. @@ -214,7 +213,8 @@ def __init__(self, descriptor=None, revision=None, time_stamp=None, value=None): class ProfileRegion(Model): - """ProfileRegion. + """ + Country/region information :param code: The two-letter code defined in ISO 3166 for the country/region. :type code: str @@ -234,7 +234,8 @@ def __init__(self, code=None, name=None): class ProfileRegions(Model): - """ProfileRegions. + """ + Container of country/region information :param notice_contact_consent_requirement_regions: List of country/region code with contact consent requirement type of notice :type notice_contact_consent_requirement_regions: list of str @@ -258,7 +259,8 @@ def __init__(self, notice_contact_consent_requirement_regions=None, opt_out_cont class CoreProfileAttribute(ProfileAttributeBase): - """CoreProfileAttribute. + """ + A profile attribute which always has a value for each profile. """ @@ -270,7 +272,8 @@ def __init__(self): class ProfileAttribute(ProfileAttributeBase): - """ProfileAttribute. + """ + A named object associated with a profile. """ diff --git a/azure-devops/azure/devops/v5_1/profile_regions/models.py b/azure-devops/azure/devops/v5_1/profile_regions/models.py index 97914fd6..3ba8fc48 100644 --- a/azure-devops/azure/devops/v5_1/profile_regions/models.py +++ b/azure-devops/azure/devops/v5_1/profile_regions/models.py @@ -10,8 +10,7 @@ class GeoRegion(Model): - """GeoRegion. - + """ :param region_code: :type region_code: str """ @@ -26,7 +25,8 @@ def __init__(self, region_code=None): class ProfileRegion(Model): - """ProfileRegion. + """ + Country/region information :param code: The two-letter code defined in ISO 3166 for the country/region. :type code: str @@ -46,7 +46,8 @@ def __init__(self, code=None, name=None): class ProfileRegions(Model): - """ProfileRegions. + """ + Container of country/region information :param notice_contact_consent_requirement_regions: List of country/region code with contact consent requirement type of notice :type notice_contact_consent_requirement_regions: list of str diff --git a/azure-devops/azure/devops/v5_1/project_analysis/models.py b/azure-devops/azure/devops/v5_1/project_analysis/models.py index 6c12c3e2..7370cafe 100644 --- a/azure-devops/azure/devops/v5_1/project_analysis/models.py +++ b/azure-devops/azure/devops/v5_1/project_analysis/models.py @@ -10,8 +10,7 @@ class CodeChangeTrendItem(Model): - """CodeChangeTrendItem. - + """ :param time: :type time: datetime :param value: @@ -30,8 +29,7 @@ def __init__(self, time=None, value=None): class LanguageMetricsSecuredObject(Model): - """LanguageMetricsSecuredObject. - + """ :param namespace_id: :type namespace_id: str :param project_id: @@ -54,8 +52,7 @@ def __init__(self, namespace_id=None, project_id=None, required_permissions=None class LanguageStatistics(LanguageMetricsSecuredObject): - """LanguageStatistics. - + """ :param namespace_id: :type namespace_id: str :param project_id: @@ -95,8 +92,7 @@ def __init__(self, namespace_id=None, project_id=None, required_permissions=None class ProjectActivityMetrics(Model): - """ProjectActivityMetrics. - + """ :param authors_count: :type authors_count: int :param code_changes_count: @@ -131,8 +127,7 @@ def __init__(self, authors_count=None, code_changes_count=None, code_changes_tre class ProjectLanguageAnalytics(LanguageMetricsSecuredObject): - """ProjectLanguageAnalytics. - + """ :param namespace_id: :type namespace_id: str :param project_id: @@ -172,8 +167,7 @@ def __init__(self, namespace_id=None, project_id=None, required_permissions=None class RepositoryActivityMetrics(Model): - """RepositoryActivityMetrics. - + """ :param code_changes_count: :type code_changes_count: int :param code_changes_trend: @@ -196,8 +190,7 @@ def __init__(self, code_changes_count=None, code_changes_trend=None, repository_ class RepositoryLanguageAnalytics(LanguageMetricsSecuredObject): - """RepositoryLanguageAnalytics. - + """ :param namespace_id: :type namespace_id: str :param project_id: diff --git a/azure-devops/azure/devops/v5_1/provenance/models.py b/azure-devops/azure/devops/v5_1/provenance/models.py index 58dd0b07..45158e2f 100644 --- a/azure-devops/azure/devops/v5_1/provenance/models.py +++ b/azure-devops/azure/devops/v5_1/provenance/models.py @@ -10,8 +10,7 @@ class SessionRequest(Model): - """SessionRequest. - + """ :param data: Generic property bag to store data about the session :type data: dict :param feed: The feed name or id for the session @@ -34,8 +33,7 @@ def __init__(self, data=None, feed=None, source=None): class SessionResponse(Model): - """SessionResponse. - + """ :param session_id: The unique identifier for the session :type session_id: str :param session_name: The name for the session diff --git a/azure-devops/azure/devops/v5_1/py_pi_api/models.py b/azure-devops/azure/devops/v5_1/py_pi_api/models.py index 219e435f..6e5b7a40 100644 --- a/azure-devops/azure/devops/v5_1/py_pi_api/models.py +++ b/azure-devops/azure/devops/v5_1/py_pi_api/models.py @@ -10,7 +10,8 @@ class BatchOperationData(Model): - """BatchOperationData. + """ + Do not attempt to use this type to create a new BatchOperationData. This type does not contain sufficient fields to create a new batch operation data. """ @@ -22,7 +23,8 @@ def __init__(self): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -50,7 +52,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class MinimalPackageDetails(Model): - """MinimalPackageDetails. + """ + Minimal package details required to identify a package within a protocol. :param id: Package name. :type id: str @@ -70,7 +73,8 @@ def __init__(self, id=None, version=None): class Package(Model): - """Package. + """ + Package version metadata for a Python package :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -110,8 +114,7 @@ def __init__(self, _links=None, deleted_date=None, id=None, name=None, permanent class PackageVersionDetails(Model): - """PackageVersionDetails. - + """ :param views: The view to which the package version will be added :type views: :class:`JsonPatchOperation ` """ @@ -126,7 +129,8 @@ def __init__(self, views=None): class PyPiPackagesBatchRequest(Model): - """PyPiPackagesBatchRequest. + """ + A batch of operations to apply to package versions. :param data: Data required to perform the operation. This is optional based on the type of the operation. Use BatchPromoteData if performing a promote operation. :type data: :class:`BatchOperationData ` @@ -150,7 +154,8 @@ def __init__(self, data=None, operation=None, packages=None): class PyPiPackageVersionDeletionState(Model): - """PyPiPackageVersionDeletionState. + """ + Deletion state of a Python package. :param deleted_date: UTC date the package was deleted. :type deleted_date: datetime @@ -174,8 +179,7 @@ def __init__(self, deleted_date=None, name=None, version=None): class PyPiRecycleBinPackageVersionDetails(Model): - """PyPiRecycleBinPackageVersionDetails. - + """ :param deleted: Setting to false will undo earlier deletion and restore the package to feed. :type deleted: bool """ @@ -190,7 +194,8 @@ def __init__(self, deleted=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -206,7 +211,8 @@ def __init__(self, links=None): class UpstreamSourceInfo(Model): - """UpstreamSourceInfo. + """ + Upstream source definition, including its Identity, package type, and other associated information. :param display_location: Locator for connecting to the upstream source in a user friendly format, that may potentially change over time :type display_location: str diff --git a/azure-devops/azure/devops/v5_1/release/models.py b/azure-devops/azure/devops/v5_1/release/models.py index 40314028..9fd55920 100644 --- a/azure-devops/azure/devops/v5_1/release/models.py +++ b/azure-devops/azure/devops/v5_1/release/models.py @@ -10,8 +10,7 @@ class AgentArtifactDefinition(Model): - """AgentArtifactDefinition. - + """ :param alias: Gets or sets the artifact definition alias. :type alias: str :param artifact_type: Gets or sets the artifact type. @@ -42,8 +41,7 @@ def __init__(self, alias=None, artifact_type=None, details=None, name=None, vers class ApprovalOptions(Model): - """ApprovalOptions. - + """ :param auto_triggered_and_previous_environment_approved_can_be_skipped: Specify whether the approval can be skipped if the same approver approved the previous stage. :type auto_triggered_and_previous_environment_approved_can_be_skipped: bool :param enforce_identity_revalidation: Specify whether revalidate identity of approver before completing the approval. @@ -78,8 +76,7 @@ def __init__(self, auto_triggered_and_previous_environment_approved_can_be_skipp class Artifact(Model): - """Artifact. - + """ :param alias: Gets or sets alias. :type alias: str :param definition_reference: Gets or sets definition reference. e.g. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}. @@ -114,8 +111,7 @@ def __init__(self, alias=None, definition_reference=None, is_primary=None, is_re class ArtifactMetadata(Model): - """ArtifactMetadata. - + """ :param alias: Sets alias of artifact. :type alias: str :param instance_reference: Sets instance reference of artifact. e.g. for build artifact it is build number. @@ -134,8 +130,7 @@ def __init__(self, alias=None, instance_reference=None): class ArtifactSourceReference(Model): - """ArtifactSourceReference. - + """ :param id: ID of the artifact source. :type id: str :param name: Name of the artifact source. @@ -154,8 +149,7 @@ def __init__(self, id=None, name=None): class ArtifactTriggerConfiguration(Model): - """ArtifactTriggerConfiguration. - + """ :param is_trigger_supported: Gets or sets the whether trigger is supported or not. :type is_trigger_supported: bool :param is_trigger_supported_only_in_hosted: Gets or sets the whether trigger is supported only on hosted environment. @@ -190,8 +184,7 @@ def __init__(self, is_trigger_supported=None, is_trigger_supported_only_in_hoste class ArtifactTypeDefinition(Model): - """ArtifactTypeDefinition. - + """ :param artifact_trigger_configuration: Gets or sets the artifact trigger configuration of artifact type defintion. :type artifact_trigger_configuration: :class:`ArtifactTriggerConfiguration ` :param artifact_type: Gets or sets the artifact type of artifact type defintion. Valid values are 'Build', 'Package', 'Source' or 'ContainerImage'. @@ -230,8 +223,7 @@ def __init__(self, artifact_trigger_configuration=None, artifact_type=None, disp class ArtifactVersion(Model): - """ArtifactVersion. - + """ :param alias: Gets or sets the alias of artifact. :type alias: str :param default_version: Gets or sets the default version of artifact. @@ -262,8 +254,7 @@ def __init__(self, alias=None, default_version=None, error_message=None, source_ class ArtifactVersionQueryResult(Model): - """ArtifactVersionQueryResult. - + """ :param artifact_versions: Gets or sets the list for artifact versions of artifact version query result. :type artifact_versions: list of :class:`ArtifactVersion ` """ @@ -278,8 +269,7 @@ def __init__(self, artifact_versions=None): class AuthorizationHeader(Model): - """AuthorizationHeader. - + """ :param name: :type name: str :param value: @@ -298,8 +288,7 @@ def __init__(self, name=None, value=None): class AutoTriggerIssue(Model): - """AutoTriggerIssue. - + """ :param issue: :type issue: :class:`Issue ` :param issue_source: @@ -330,8 +319,7 @@ def __init__(self, issue=None, issue_source=None, project=None, release_definiti class BuildVersion(Model): - """BuildVersion. - + """ :param commit_message: Gets or sets the commit message for the artifact. :type commit_message: str :param definition_id: Gets or sets the definition id. @@ -386,7 +374,8 @@ def __init__(self, commit_message=None, definition_id=None, definition_name=None class Change(Model): - """Change. + """ + Represents a change associated with a build. :param author: The author of the change. :type author: :class:`IdentityRef ` @@ -434,8 +423,7 @@ def __init__(self, author=None, change_type=None, display_uri=None, id=None, loc class ComplianceSettings(Model): - """ComplianceSettings. - + """ :param check_for_credentials_and_other_secrets: Scan the release definition for secrets :type check_for_credentials_and_other_secrets: bool """ @@ -450,8 +438,7 @@ def __init__(self, check_for_credentials_and_other_secrets=None): class Condition(Model): - """Condition. - + """ :param condition_type: Gets or sets the condition type. :type condition_type: object :param name: Gets or sets the name of the condition. e.g. 'ReleaseStarted'. @@ -474,8 +461,7 @@ def __init__(self, condition_type=None, name=None, value=None): class ConfigurationVariableValue(Model): - """ConfigurationVariableValue. - + """ :param allow_override: Gets and sets if a variable can be overridden at deployment time or not. :type allow_override: bool :param is_secret: Gets or sets as variable is secret or not. @@ -498,7 +484,8 @@ def __init__(self, allow_override=None, is_secret=None, value=None): class DataSourceBindingBase(Model): - """DataSourceBindingBase. + """ + Represents binding of data source for the service endpoint request. :param callback_context_template: Pagination format supported by this data source(ContinuationToken/SkipTop). :type callback_context_template: str @@ -562,8 +549,7 @@ def __init__(self, callback_context_template=None, callback_required_template=No class DefinitionEnvironmentReference(Model): - """DefinitionEnvironmentReference. - + """ :param definition_environment_id: Definition environment ID. :type definition_environment_id: int :param definition_environment_name: Definition environment name. @@ -590,8 +576,7 @@ def __init__(self, definition_environment_id=None, definition_environment_name=N class Deployment(Model): - """Deployment. - + """ :param _links: Gets links to access the deployment. :type _links: :class:`ReferenceLinks ` :param attempt: Gets attempt number. @@ -690,8 +675,7 @@ def __init__(self, _links=None, attempt=None, completed_on=None, conditions=None class DeploymentAttempt(Model): - """DeploymentAttempt. - + """ :param attempt: Deployment attempt. :type attempt: int :param deployment_id: ID of the deployment. @@ -782,8 +766,7 @@ def __init__(self, attempt=None, deployment_id=None, error_log=None, has_started class DeploymentJob(Model): - """DeploymentJob. - + """ :param job: Parent task of all executed tasks. :type job: :class:`ReleaseTask ` :param tasks: List of executed tasks with in job. @@ -802,8 +785,7 @@ def __init__(self, job=None, tasks=None): class DeploymentQueryParameters(Model): - """DeploymentQueryParameters. - + """ :param artifact_source_id: Query deployments based specified artifact source id. :type artifact_source_id: str :param artifact_type_id: Query deployments based specified artifact type id. @@ -878,8 +860,7 @@ def __init__(self, artifact_source_id=None, artifact_type_id=None, artifact_vers class EmailRecipients(Model): - """EmailRecipients. - + """ :param email_addresses: List of email addresses. :type email_addresses: list of str :param tfs_ids: List of TFS IDs guids. @@ -898,7 +879,8 @@ def __init__(self, email_addresses=None, tfs_ids=None): class EnvironmentExecutionPolicy(Model): - """EnvironmentExecutionPolicy. + """ + Defines policy on environment queuing at Release Management side queue. We will send to Environment Runner [creating pre-deploy and other steps] only when the policies mentioned are satisfied. :param concurrency_count: This policy decides, how many environments would be with Environment Runner. :type concurrency_count: int @@ -918,8 +900,7 @@ def __init__(self, concurrency_count=None, queue_depth_count=None): class EnvironmentOptions(Model): - """EnvironmentOptions. - + """ :param auto_link_work_items: Gets and sets as the auto link workitems or not. :type auto_link_work_items: bool :param badge_enabled: Gets and sets as the badge enabled or not. @@ -966,8 +947,7 @@ def __init__(self, auto_link_work_items=None, badge_enabled=None, email_notifica class EnvironmentRetentionPolicy(Model): - """EnvironmentRetentionPolicy. - + """ :param days_to_keep: Gets and sets the number of days to keep environment. :type days_to_keep: int :param releases_to_keep: Gets and sets the number of releases to keep. @@ -990,8 +970,7 @@ def __init__(self, days_to_keep=None, releases_to_keep=None, retain_build=None): class EnvironmentTrigger(Model): - """EnvironmentTrigger. - + """ :param definition_environment_id: Definition environment ID on which this trigger applicable. :type definition_environment_id: int :param release_definition_id: ReleaseDefinition ID on which this trigger applicable. @@ -1018,7 +997,8 @@ def __init__(self, definition_environment_id=None, release_definition_id=None, t class FavoriteItem(Model): - """FavoriteItem. + """ + Class to represent favorite entry. :param data: Application specific data for the entry. :type data: str @@ -1046,8 +1026,7 @@ def __init__(self, data=None, id=None, name=None, type=None): class Folder(Model): - """Folder. - + """ :param created_by: Identity who created this folder. :type created_by: :class:`IdentityRef ` :param created_on: Time when this folder created. @@ -1082,8 +1061,7 @@ def __init__(self, created_by=None, created_on=None, description=None, last_chan class GateUpdateMetadata(Model): - """GateUpdateMetadata. - + """ :param comment: Comment. :type comment: str :param gates_to_ignore: Name of gate to be ignored. @@ -1102,8 +1080,7 @@ def __init__(self, comment=None, gates_to_ignore=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -1130,8 +1107,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -1190,8 +1166,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class IgnoredGate(Model): - """IgnoredGate. - + """ :param last_modified_on: Gets the date on which gate is last ignored. :type last_modified_on: datetime :param name: Name of gate ignored. @@ -1210,7 +1185,8 @@ def __init__(self, last_modified_on=None, name=None): class InputDescriptor(Model): - """InputDescriptor. + """ + Describes an input for subscriptions. :param dependency_input_ids: The ids of all inputs that the value of this input is dependent on. :type dependency_input_ids: list of str @@ -1278,7 +1254,8 @@ def __init__(self, dependency_input_ids=None, description=None, group_name=None, class InputValidation(Model): - """InputValidation. + """ + Describes what values are valid for a subscription input :param data_type: Gets or sets the data data type to validate. :type data_type: object @@ -1322,7 +1299,8 @@ def __init__(self, data_type=None, is_required=None, max_length=None, max_value= class InputValue(Model): - """InputValue. + """ + Information about a single value for an input :param data: Any other data about this input :type data: dict @@ -1346,7 +1324,8 @@ def __init__(self, data=None, display_value=None, value=None): class InputValues(Model): - """InputValues. + """ + Information about the possible/allowed values for a given subscription input :param default_value: The default value to use for this input :type default_value: str @@ -1386,7 +1365,8 @@ def __init__(self, default_value=None, error=None, input_id=None, is_disabled=No class InputValuesError(Model): - """InputValuesError. + """ + Error information related to a subscription input value. :param message: The error message. :type message: str @@ -1402,8 +1382,7 @@ def __init__(self, message=None): class InputValuesQuery(Model): - """InputValuesQuery. - + """ :param current_values: :type current_values: dict :param input_values: The input values to return on input, and the result from the consumer on output. @@ -1426,8 +1405,7 @@ def __init__(self, current_values=None, input_values=None, resource=None): class Issue(Model): - """Issue. - + """ :param data: Issue data. :type data: dict :param issue_type: Issue type, for example error, warning or info. @@ -1450,8 +1428,7 @@ def __init__(self, data=None, issue_type=None, message=None): class MailMessage(Model): - """MailMessage. - + """ :param body: Body of mail. :type body: str :param cC: Mail CC recipients. @@ -1502,8 +1479,7 @@ def __init__(self, body=None, cC=None, in_reply_to=None, message_id=None, reply_ class ManualIntervention(Model): - """ManualIntervention. - + """ :param approver: Gets or sets the identity who should approve. :type approver: :class:`IdentityRef ` :param comments: Gets or sets comments for approval. @@ -1566,8 +1542,7 @@ def __init__(self, approver=None, comments=None, created_on=None, id=None, instr class ManualInterventionUpdateMetadata(Model): - """ManualInterventionUpdateMetadata. - + """ :param comment: Sets the comment for manual intervention update. :type comment: str :param status: Sets the status of the manual intervention. @@ -1586,8 +1561,7 @@ def __init__(self, comment=None, status=None): class Metric(Model): - """Metric. - + """ :param name: Name of the Metric. :type name: str :param value: Value of the Metric. @@ -1606,8 +1580,7 @@ def __init__(self, name=None, value=None): class PipelineProcess(Model): - """PipelineProcess. - + """ :param type: Pipeline process type. :type type: object """ @@ -1622,8 +1595,7 @@ def __init__(self, type=None): class ProcessParameters(Model): - """ProcessParameters. - + """ :param data_source_bindings: :type data_source_bindings: list of :class:`DataSourceBindingBase ` :param inputs: @@ -1646,8 +1618,7 @@ def __init__(self, data_source_bindings=None, inputs=None, source_definitions=No class ProjectReference(Model): - """ProjectReference. - + """ :param id: Gets the unique identifier of this field. :type id: str :param name: Gets name of project. @@ -1666,8 +1637,7 @@ def __init__(self, id=None, name=None): class QueuedReleaseData(Model): - """QueuedReleaseData. - + """ :param project_id: Project ID of the release. :type project_id: str :param queue_position: Release queue position. @@ -1690,7 +1660,8 @@ def __init__(self, project_id=None, queue_position=None, release_id=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -1706,8 +1677,7 @@ def __init__(self, links=None): class Release(Model): - """Release. - + """ :param _links: Gets links to access the release. :type _links: :class:`ReferenceLinks ` :param artifacts: Gets or sets the list of artifacts. @@ -1826,8 +1796,7 @@ def __init__(self, _links=None, artifacts=None, comment=None, created_by=None, c class ReleaseApproval(Model): - """ReleaseApproval. - + """ :param approval_type: Gets or sets the type of approval. :type approval_type: object :param approved_by: Gets the identity who approved. @@ -1914,8 +1883,7 @@ def __init__(self, approval_type=None, approved_by=None, approver=None, attempt= class ReleaseApprovalHistory(Model): - """ReleaseApprovalHistory. - + """ :param approver: Identity of the approver. :type approver: :class:`IdentityRef ` :param changed_by: Identity of the object who changed approval. @@ -1950,8 +1918,7 @@ def __init__(self, approver=None, changed_by=None, comments=None, created_on=Non class ReleaseCondition(Condition): - """ReleaseCondition. - + """ :param condition_type: Gets or sets the condition type. :type condition_type: object :param name: Gets or sets the name of the condition. e.g. 'ReleaseStarted'. @@ -1975,8 +1942,7 @@ def __init__(self, condition_type=None, name=None, value=None, result=None): class ReleaseDefinitionApprovals(Model): - """ReleaseDefinitionApprovals. - + """ :param approval_options: Gets or sets the approval options. :type approval_options: :class:`ApprovalOptions ` :param approvals: Gets or sets the approvals. @@ -1995,8 +1961,7 @@ def __init__(self, approval_options=None, approvals=None): class ReleaseDefinitionEnvironment(Model): - """ReleaseDefinitionEnvironment. - + """ :param badge_url: Gets or sets the BadgeUrl. BadgeUrl will be used when Badge will be enabled in Release Definition Environment. :type badge_url: str :param conditions: Gets or sets the environment conditions. @@ -2107,8 +2072,7 @@ def __init__(self, badge_url=None, conditions=None, current_release=None, demand class ReleaseDefinitionEnvironmentStep(Model): - """ReleaseDefinitionEnvironmentStep. - + """ :param id: ID of the approval or deploy step. :type id: int """ @@ -2123,8 +2087,7 @@ def __init__(self, id=None): class ReleaseDefinitionEnvironmentSummary(Model): - """ReleaseDefinitionEnvironmentSummary. - + """ :param id: ID of ReleaseDefinition environment summary. :type id: int :param last_releases: List of release shallow reference deployed using this ReleaseDefinition. @@ -2147,8 +2110,7 @@ def __init__(self, id=None, last_releases=None, name=None): class ReleaseDefinitionEnvironmentTemplate(Model): - """ReleaseDefinitionEnvironmentTemplate. - + """ :param can_delete: Indicates whether template can be deleted or not. :type can_delete: bool :param category: Category of the ReleaseDefinition environment template. @@ -2195,8 +2157,7 @@ def __init__(self, can_delete=None, category=None, description=None, environment class ReleaseDefinitionGate(Model): - """ReleaseDefinitionGate. - + """ :param tasks: Gets or sets the gates workflow. :type tasks: list of :class:`WorkflowTask ` """ @@ -2211,8 +2172,7 @@ def __init__(self, tasks=None): class ReleaseDefinitionGatesOptions(Model): - """ReleaseDefinitionGatesOptions. - + """ :param is_enabled: Gets or sets as the gates enabled or not. :type is_enabled: bool :param minimum_success_duration: Gets or sets the minimum duration for steady results after a successful gates evaluation. @@ -2243,8 +2203,7 @@ def __init__(self, is_enabled=None, minimum_success_duration=None, sampling_inte class ReleaseDefinitionGatesStep(Model): - """ReleaseDefinitionGatesStep. - + """ :param gates: Gets or sets the gates. :type gates: list of :class:`ReleaseDefinitionGate ` :param gates_options: Gets or sets the gate options. @@ -2267,8 +2226,7 @@ def __init__(self, gates=None, gates_options=None, id=None): class ReleaseDefinitionRevision(Model): - """ReleaseDefinitionRevision. - + """ :param api_version: Gets api-version for revision object. :type api_version: str :param changed_by: Gets the identity who did change. @@ -2311,8 +2269,7 @@ def __init__(self, api_version=None, changed_by=None, changed_date=None, change_ class ReleaseDefinitionShallowReference(Model): - """ReleaseDefinitionShallowReference. - + """ :param _links: Gets the links to related resources, APIs, and views for the release definition. :type _links: :class:`ReferenceLinks ` :param id: Gets the unique identifier of release definition. @@ -2347,8 +2304,7 @@ def __init__(self, _links=None, id=None, name=None, path=None, project_reference class ReleaseDefinitionSummary(Model): - """ReleaseDefinitionSummary. - + """ :param environments: List of Release Definition environment summary. :type environments: list of :class:`ReleaseDefinitionEnvironmentSummary ` :param release_definition: Release Definition reference. @@ -2371,8 +2327,7 @@ def __init__(self, environments=None, release_definition=None, releases=None): class ReleaseDefinitionUndeleteParameter(Model): - """ReleaseDefinitionUndeleteParameter. - + """ :param comment: Gets or sets comment. :type comment: str """ @@ -2387,8 +2342,7 @@ def __init__(self, comment=None): class ReleaseDeployPhase(Model): - """ReleaseDeployPhase. - + """ :param deployment_jobs: Deployment jobs of the phase. :type deployment_jobs: list of :class:`DeploymentJob ` :param error_log: Phase execution error logs. @@ -2443,8 +2397,7 @@ def __init__(self, deployment_jobs=None, error_log=None, id=None, manual_interve class ReleaseEnvironment(Model): - """ReleaseEnvironment. - + """ :param conditions: Gets list of conditions. :type conditions: list of :class:`ReleaseCondition ` :param created_on: Gets date on which it got created. @@ -2591,8 +2544,7 @@ def __init__(self, conditions=None, created_on=None, definition_environment_id=N class ReleaseEnvironmentShallowReference(Model): - """ReleaseEnvironmentShallowReference. - + """ :param _links: Gets the links to related resources, APIs, and views for the release environment. :type _links: :class:`ReferenceLinks ` :param id: Gets the unique identifier of release environment. @@ -2619,8 +2571,7 @@ def __init__(self, _links=None, id=None, name=None, url=None): class ReleaseEnvironmentUpdateMetadata(Model): - """ReleaseEnvironmentUpdateMetadata. - + """ :param comment: Gets or sets comment. :type comment: str :param scheduled_deployment_time: Gets or sets scheduled deployment time. @@ -2647,8 +2598,7 @@ def __init__(self, comment=None, scheduled_deployment_time=None, status=None, va class ReleaseGates(Model): - """ReleaseGates. - + """ :param deployment_jobs: Contains the gates job details of each evaluation. :type deployment_jobs: list of :class:`DeploymentJob ` :param id: ID of release gates. @@ -2695,8 +2645,7 @@ def __init__(self, deployment_jobs=None, id=None, ignored_gates=None, last_modif class ReleaseReference(Model): - """ReleaseReference. - + """ :param _links: Gets links to access the release. :type _links: :class:`ReferenceLinks ` :param artifacts: Gets list of artifacts. @@ -2755,8 +2704,7 @@ def __init__(self, _links=None, artifacts=None, created_by=None, created_on=None class ReleaseRevision(Model): - """ReleaseRevision. - + """ :param changed_by: Gets or sets the identity who changed. :type changed_by: :class:`IdentityRef ` :param changed_date: Change date of the revision. @@ -2795,8 +2743,7 @@ def __init__(self, changed_by=None, changed_date=None, change_details=None, chan class ReleaseSchedule(Model): - """ReleaseSchedule. - + """ :param days_to_release: Days of the week to release. :type days_to_release: object :param job_id: Team Foundation Job Definition Job Id. @@ -2831,8 +2778,7 @@ def __init__(self, days_to_release=None, job_id=None, schedule_only_with_changes class ReleaseSettings(Model): - """ReleaseSettings. - + """ :param compliance_settings: Release Compliance settings. :type compliance_settings: :class:`ComplianceSettings ` :param retention_settings: Release retention settings. @@ -2851,8 +2797,7 @@ def __init__(self, compliance_settings=None, retention_settings=None): class ReleaseShallowReference(Model): - """ReleaseShallowReference. - + """ :param _links: Gets the links to related resources, APIs, and views for the release. :type _links: :class:`ReferenceLinks ` :param id: Gets the unique identifier of release. @@ -2879,8 +2824,7 @@ def __init__(self, _links=None, id=None, name=None, url=None): class ReleaseStartEnvironmentMetadata(Model): - """ReleaseStartEnvironmentMetadata. - + """ :param definition_environment_id: Sets release definition environment id. :type definition_environment_id: int :param variables: Sets list of environments variables to be overridden at deployment time. @@ -2899,8 +2843,7 @@ def __init__(self, definition_environment_id=None, variables=None): class ReleaseStartMetadata(Model): - """ReleaseStartMetadata. - + """ :param artifacts: Sets list of artifact to create a release. :type artifacts: list of :class:`ArtifactMetadata ` :param definition_id: Sets definition Id to create a release. @@ -2947,8 +2890,7 @@ def __init__(self, artifacts=None, definition_id=None, description=None, environ class ReleaseTask(Model): - """ReleaseTask. - + """ :param agent_name: Agent name on which task executed. :type agent_name: str :param date_ended: @@ -3023,8 +2965,7 @@ def __init__(self, agent_name=None, date_ended=None, date_started=None, finish_t class ReleaseTaskAttachment(Model): - """ReleaseTaskAttachment. - + """ :param _links: Reference links of task. :type _links: :class:`ReferenceLinks ` :param created_on: Data and time when it created. @@ -3067,8 +3008,7 @@ def __init__(self, _links=None, created_on=None, modified_by=None, modified_on=N class ReleaseUpdateMetadata(Model): - """ReleaseUpdateMetadata. - + """ :param comment: Sets comment for release. :type comment: str :param keep_forever: Set 'true' to exclude the release from retention policies. @@ -3099,8 +3039,7 @@ def __init__(self, comment=None, keep_forever=None, manual_environments=None, na class ReleaseWorkItemRef(Model): - """ReleaseWorkItemRef. - + """ :param assignee: :type assignee: str :param id: Gets or sets the ID. @@ -3135,8 +3074,7 @@ def __init__(self, assignee=None, id=None, state=None, title=None, type=None, ur class RetentionPolicy(Model): - """RetentionPolicy. - + """ :param days_to_keep: Indicates the number of days to keep deployment. :type days_to_keep: int """ @@ -3151,8 +3089,7 @@ def __init__(self, days_to_keep=None): class RetentionSettings(Model): - """RetentionSettings. - + """ :param days_to_keep_deleted_releases: Number of days to keep deleted releases. :type days_to_keep_deleted_releases: int :param default_environment_retention_policy: Specifies the default environment retention policy. @@ -3175,8 +3112,7 @@ def __init__(self, days_to_keep_deleted_releases=None, default_environment_reten class SourcePullRequestVersion(Model): - """SourcePullRequestVersion. - + """ :param iteration_id: Pull Request Iteration Id for which the release will publish status. :type iteration_id: str :param pull_request_id: Pull Request Id for which the release will publish status. @@ -3211,8 +3147,7 @@ def __init__(self, iteration_id=None, pull_request_id=None, pull_request_merged_ class SummaryMailSection(Model): - """SummaryMailSection. - + """ :param html_content: Html content of summary mail. :type html_content: str :param rank: Rank of the summary mail. @@ -3239,8 +3174,7 @@ def __init__(self, html_content=None, rank=None, section_type=None, title=None): class TaskInputDefinitionBase(Model): - """TaskInputDefinitionBase. - + """ :param aliases: :type aliases: list of str :param default_value: @@ -3299,8 +3233,7 @@ def __init__(self, aliases=None, default_value=None, group_name=None, help_mark_ class TaskInputValidation(Model): - """TaskInputValidation. - + """ :param expression: Conditional expression :type expression: str :param message: Message explaining how user can correct if validation fails @@ -3319,8 +3252,7 @@ def __init__(self, expression=None, message=None): class TaskSourceDefinitionBase(Model): - """TaskSourceDefinitionBase. - + """ :param auth_key: :type auth_key: str :param endpoint: @@ -3351,8 +3283,7 @@ def __init__(self, auth_key=None, endpoint=None, key_selector=None, selector=Non class VariableGroup(Model): - """VariableGroup. - + """ :param created_by: Gets or sets the identity who created. :type created_by: :class:`IdentityRef ` :param created_on: Gets date on which it got created. @@ -3407,8 +3338,7 @@ def __init__(self, created_by=None, created_on=None, description=None, id=None, class VariableGroupProviderData(Model): - """VariableGroupProviderData. - + """ """ _attribute_map = { @@ -3419,8 +3349,7 @@ def __init__(self): class VariableValue(Model): - """VariableValue. - + """ :param is_secret: Gets or sets as the variable is secret or not. :type is_secret: bool :param value: Gets or sets the value. @@ -3439,8 +3368,7 @@ def __init__(self, is_secret=None, value=None): class WorkflowTask(Model): - """WorkflowTask. - + """ :param always_run: Gets or sets as the task always run or not. :type always_run: bool :param condition: Gets or sets the task condition. @@ -3503,8 +3431,7 @@ def __init__(self, always_run=None, condition=None, continue_on_error=None, defi class WorkflowTaskReference(Model): - """WorkflowTaskReference. - + """ :param id: Task identifier. :type id: str :param name: Name of the task. @@ -3527,8 +3454,7 @@ def __init__(self, id=None, name=None, version=None): class ReleaseDefinition(ReleaseDefinitionShallowReference): - """ReleaseDefinition. - + """ :param _links: Gets the links to related resources, APIs, and views for the release definition. :type _links: :class:`ReferenceLinks ` :param id: Gets the unique identifier of release definition. @@ -3637,8 +3563,7 @@ def __init__(self, _links=None, id=None, name=None, path=None, project_reference class ReleaseDefinitionApprovalStep(ReleaseDefinitionEnvironmentStep): - """ReleaseDefinitionApprovalStep. - + """ :param id: ID of the approval or deploy step. :type id: int :param approver: Gets and sets the approver. @@ -3668,8 +3593,7 @@ def __init__(self, id=None, approver=None, is_automated=None, is_notification_on class ReleaseDefinitionDeployStep(ReleaseDefinitionEnvironmentStep): - """ReleaseDefinitionDeployStep. - + """ :param id: ID of the approval or deploy step. :type id: int :param tasks: The list of steps for this definition. diff --git a/azure-devops/azure/devops/v5_1/security/models.py b/azure-devops/azure/devops/v5_1/security/models.py index a406cbaa..065b4c95 100644 --- a/azure-devops/azure/devops/v5_1/security/models.py +++ b/azure-devops/azure/devops/v5_1/security/models.py @@ -10,7 +10,8 @@ class AccessControlEntry(Model): - """AccessControlEntry. + """ + Class for encapsulating the allowed and denied permissions for a given IdentityDescriptor. :param allow: The set of permission bits that represent the actions that the associated descriptor is allowed to perform. :type allow: int @@ -38,7 +39,8 @@ def __init__(self, allow=None, deny=None, descriptor=None, extended_info=None): class AccessControlList(Model): - """AccessControlList. + """ + The AccessControlList class is meant to associate a set of AccessControlEntries with a security token and its inheritance settings. :param aces_dictionary: Storage of permissions keyed on the identity the permission is for. :type aces_dictionary: dict @@ -66,7 +68,8 @@ def __init__(self, aces_dictionary=None, include_extended_info=None, inherit_per class AccessControlListsCollection(Model): - """AccessControlListsCollection. + """ + A list of AccessControlList. An AccessControlList is meant to associate a set of AccessControlEntries with a security token and its inheritance settings. """ @@ -78,7 +81,8 @@ def __init__(self): class AceExtendedInformation(Model): - """AceExtendedInformation. + """ + Holds the inherited and effective permission information for a given AccessControlEntry. :param effective_allow: This is the combination of all of the explicit and inherited permissions for this identity on this token. These are the permissions used when determining if a given user has permission to perform an action. :type effective_allow: int @@ -106,8 +110,7 @@ def __init__(self, effective_allow=None, effective_deny=None, inherited_allow=No class ActionDefinition(Model): - """ActionDefinition. - + """ :param bit: The bit mask integer for this action. Must be a power of 2. :type bit: int :param display_name: The localized display name for this action. @@ -134,7 +137,8 @@ def __init__(self, bit=None, display_name=None, name=None, namespace_id=None): class PermissionEvaluation(Model): - """PermissionEvaluation. + """ + Represents an evaluated permission. :param permissions: Permission bit for this evaluated permission. :type permissions: int @@ -162,7 +166,8 @@ def __init__(self, permissions=None, security_namespace_id=None, token=None, val class PermissionEvaluationBatch(Model): - """PermissionEvaluationBatch. + """ + Represents a set of evaluated permissions. :param always_allow_administrators: True if members of the Administrators group should always pass the security check. :type always_allow_administrators: bool @@ -182,7 +187,8 @@ def __init__(self, always_allow_administrators=None, evaluations=None): class SecurityNamespaceDescription(Model): - """SecurityNamespaceDescription. + """ + Class for describing the details of a TeamFoundationSecurityNamespace. :param actions: The list of actions that this Security Namespace is responsible for securing. :type actions: list of :class:`ActionDefinition ` diff --git a/azure-devops/azure/devops/v5_1/service_endpoint/models.py b/azure-devops/azure/devops/v5_1/service_endpoint/models.py index df4f841d..c0377ec6 100644 --- a/azure-devops/azure/devops/v5_1/service_endpoint/models.py +++ b/azure-devops/azure/devops/v5_1/service_endpoint/models.py @@ -10,8 +10,7 @@ class AadOauthTokenRequest(Model): - """AadOauthTokenRequest. - + """ :param refresh: :type refresh: bool :param resource: @@ -38,8 +37,7 @@ def __init__(self, refresh=None, resource=None, tenant_id=None, token=None): class AadOauthTokenResult(Model): - """AadOauthTokenResult. - + """ :param access_token: :type access_token: str :param refresh_token_cache: @@ -58,7 +56,8 @@ def __init__(self, access_token=None, refresh_token_cache=None): class AuthenticationSchemeReference(Model): - """AuthenticationSchemeReference. + """ + Specifies the authentication scheme to be used for authentication. :param inputs: Gets or sets the key and value of the fields used for authentication. :type inputs: dict @@ -78,7 +77,8 @@ def __init__(self, inputs=None, type=None): class AuthorizationHeader(Model): - """AuthorizationHeader. + """ + Represents the header of the REST request. :param name: Gets or sets the name of authorization header. :type name: str @@ -98,7 +98,8 @@ def __init__(self, name=None, value=None): class AzureManagementGroup(Model): - """AzureManagementGroup. + """ + Azure Management Group :param display_name: Display name of azure management group :type display_name: str @@ -126,7 +127,8 @@ def __init__(self, display_name=None, id=None, name=None, tenant_id=None): class AzureManagementGroupQueryResult(Model): - """AzureManagementGroupQueryResult. + """ + Azure management group query result :param error_message: Error message in case of an exception :type error_message: str @@ -146,8 +148,7 @@ def __init__(self, error_message=None, value=None): class AzureSubscription(Model): - """AzureSubscription. - + """ :param display_name: :type display_name: str :param subscription_id: @@ -174,8 +175,7 @@ def __init__(self, display_name=None, subscription_id=None, subscription_tenant_ class AzureSubscriptionQueryResult(Model): - """AzureSubscriptionQueryResult. - + """ :param error_message: :type error_message: str :param value: @@ -194,7 +194,8 @@ def __init__(self, error_message=None, value=None): class ClientCertificate(Model): - """ClientCertificate. + """ + Specifies the client certificate to be used for the endpoint request. :param value: Gets or sets the value of client certificate. :type value: str @@ -210,7 +211,8 @@ def __init__(self, value=None): class DataSource(Model): - """DataSource. + """ + Specifies the data sources for this endpoint. :param authentication_scheme: Gets or sets the authentication scheme for the endpoint request. :type authentication_scheme: :class:`AuthenticationSchemeReference ` @@ -266,7 +268,8 @@ def __init__(self, authentication_scheme=None, callback_context_template=None, c class DataSourceBindingBase(Model): - """DataSourceBindingBase. + """ + Represents binding of data source for the service endpoint request. :param callback_context_template: Pagination format supported by this data source(ContinuationToken/SkipTop). :type callback_context_template: str @@ -330,7 +333,8 @@ def __init__(self, callback_context_template=None, callback_required_template=No class DataSourceDetails(Model): - """DataSourceDetails. + """ + Represents details of the service endpoint data source. :param data_source_name: Gets or sets the data source name. :type data_source_name: str @@ -378,7 +382,8 @@ def __init__(self, data_source_name=None, data_source_url=None, headers=None, in class DependencyBinding(Model): - """DependencyBinding. + """ + Represents the details of the input on which a given input is dependent. :param key: Gets or sets the value of the field on which url is dependent. :type key: str @@ -398,7 +403,8 @@ def __init__(self, key=None, value=None): class DependencyData(Model): - """DependencyData. + """ + Represents the dependency data for the endpoint inputs. :param input: Gets or sets the category of dependency data. :type input: str @@ -418,7 +424,8 @@ def __init__(self, input=None, map=None): class DependsOn(Model): - """DependsOn. + """ + Represents the inputs on which any given input is dependent. :param input: Gets or sets the ID of the field on which URL's value is dependent. :type input: str @@ -438,7 +445,8 @@ def __init__(self, input=None, map=None): class EndpointAuthorization(Model): - """EndpointAuthorization. + """ + Represents the authorization used for service endpoint. :param parameters: Gets or sets the parameters for the selected authorization scheme. :type parameters: dict @@ -458,7 +466,8 @@ def __init__(self, parameters=None, scheme=None): class EndpointUrl(Model): - """EndpointUrl. + """ + Represents url of the service endpoint. :param depends_on: Gets or sets the dependency bindings. :type depends_on: :class:`DependsOn ` @@ -490,8 +499,7 @@ def __init__(self, depends_on=None, display_name=None, help_text=None, is_visibl class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -518,7 +526,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class HelpLink(Model): - """HelpLink. + """ + Specifies the public url of the help documentation. :param text: Gets or sets the help text. :type text: str @@ -538,8 +547,7 @@ def __init__(self, text=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -598,7 +606,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class InputDescriptor(Model): - """InputDescriptor. + """ + Describes an input for subscriptions. :param dependency_input_ids: The ids of all inputs that the value of this input is dependent on. :type dependency_input_ids: list of str @@ -666,7 +675,8 @@ def __init__(self, dependency_input_ids=None, description=None, group_name=None, class InputValidation(Model): - """InputValidation. + """ + Describes what values are valid for a subscription input :param data_type: Gets or sets the data data type to validate. :type data_type: object @@ -710,7 +720,8 @@ def __init__(self, data_type=None, is_required=None, max_length=None, max_value= class InputValue(Model): - """InputValue. + """ + Information about a single value for an input :param data: Any other data about this input :type data: dict @@ -734,7 +745,8 @@ def __init__(self, data=None, display_value=None, value=None): class InputValues(Model): - """InputValues. + """ + Information about the possible/allowed values for a given subscription input :param default_value: The default value to use for this input :type default_value: str @@ -774,7 +786,8 @@ def __init__(self, default_value=None, error=None, input_id=None, is_disabled=No class InputValuesError(Model): - """InputValuesError. + """ + Error information related to a subscription input value. :param message: The error message. :type message: str @@ -790,8 +803,7 @@ def __init__(self, message=None): class OAuthConfiguration(Model): - """OAuthConfiguration. - + """ :param client_id: Gets or sets the ClientId :type client_id: str :param client_secret: Gets or sets the ClientSecret @@ -842,8 +854,7 @@ def __init__(self, client_id=None, client_secret=None, created_by=None, created_ class OAuthConfigurationParams(Model): - """OAuthConfigurationParams. - + """ :param client_id: Gets or sets the ClientId :type client_id: str :param client_secret: Gets or sets the ClientSecret @@ -874,8 +885,7 @@ def __init__(self, client_id=None, client_secret=None, endpoint_type=None, name= class ProjectReference(Model): - """ProjectReference. - + """ :param id: :type id: str :param name: @@ -894,7 +904,8 @@ def __init__(self, id=None, name=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -910,7 +921,8 @@ def __init__(self, links=None): class ResultTransformationDetails(Model): - """ResultTransformationDetails. + """ + Represents template to tranform the result data. :param callback_context_template: Gets or sets the template for callback parameters :type callback_context_template: str @@ -934,7 +946,8 @@ def __init__(self, callback_context_template=None, callback_required_template=No class ServiceEndpoint(Model): - """ServiceEndpoint. + """ + Represents an endpoint which may be used by an orchestration job. :param administrators_group: Gets or sets the identity reference for the administrators group of the service endpoint. :type administrators_group: :class:`IdentityRef ` @@ -1006,7 +1019,8 @@ def __init__(self, administrators_group=None, authorization=None, created_by=Non class ServiceEndpointAuthenticationScheme(Model): - """ServiceEndpointAuthenticationScheme. + """ + Represents the authentication scheme used to authenticate the endpoint. :param authorization_headers: Gets or sets the authorization headers of service endpoint authentication scheme. :type authorization_headers: list of :class:`AuthorizationHeader ` @@ -1046,7 +1060,8 @@ def __init__(self, authorization_headers=None, authorization_url=None, client_ce class ServiceEndpointDetails(Model): - """ServiceEndpointDetails. + """ + Represents details of the service endpoint. :param authorization: Gets or sets the authorization of service endpoint. :type authorization: :class:`EndpointAuthorization ` @@ -1074,7 +1089,8 @@ def __init__(self, authorization=None, data=None, type=None, url=None): class ServiceEndpointExecutionData(Model): - """ServiceEndpointExecutionData. + """ + Represents service endpoint execution data. :param definition: Gets the definition of service endpoint execution owner. :type definition: :class:`ServiceEndpointExecutionOwner ` @@ -1114,7 +1130,8 @@ def __init__(self, definition=None, finish_time=None, id=None, owner=None, plan_ class ServiceEndpointExecutionOwner(Model): - """ServiceEndpointExecutionOwner. + """ + Represents execution owner of the service endpoint. :param _links: :type _links: :class:`ReferenceLinks ` @@ -1138,7 +1155,8 @@ def __init__(self, _links=None, id=None, name=None): class ServiceEndpointExecutionRecord(Model): - """ServiceEndpointExecutionRecord. + """ + Represents the details of service ednpoint execution. :param data: Gets the execution data of service endpoint execution. :type data: :class:`ServiceEndpointExecutionData ` @@ -1158,8 +1176,7 @@ def __init__(self, data=None, endpoint_id=None): class ServiceEndpointExecutionRecordsInput(Model): - """ServiceEndpointExecutionRecordsInput. - + """ :param data: :type data: :class:`ServiceEndpointExecutionData ` :param endpoint_ids: @@ -1178,8 +1195,7 @@ def __init__(self, data=None, endpoint_ids=None): class ServiceEndpointRequest(Model): - """ServiceEndpointRequest. - + """ :param data_source_details: Gets or sets the data source details for the service endpoint request. :type data_source_details: :class:`DataSourceDetails ` :param result_transformation_details: Gets or sets the result transformation details for the service endpoint request. @@ -1202,7 +1218,8 @@ def __init__(self, data_source_details=None, result_transformation_details=None, class ServiceEndpointRequestResult(Model): - """ServiceEndpointRequestResult. + """ + Represents result of the service endpoint request. :param callback_context_parameters: Gets or sets the parameters used to make subsequent calls to the data source :type callback_context_parameters: dict @@ -1234,7 +1251,8 @@ def __init__(self, callback_context_parameters=None, callback_required=None, err class ServiceEndpointType(Model): - """ServiceEndpointType. + """ + Represents type of the service endpoint. :param authentication_schemes: Authentication scheme of service endpoint type. :type authentication_schemes: list of :class:`ServiceEndpointAuthenticationScheme ` @@ -1298,7 +1316,8 @@ def __init__(self, authentication_schemes=None, data_sources=None, dependency_da class DataSourceBinding(DataSourceBindingBase): - """DataSourceBinding. + """ + Represents the data source binding of the endpoint. :param callback_context_template: Pagination format supported by this data source(ContinuationToken/SkipTop). :type callback_context_template: str diff --git a/azure-devops/azure/devops/v5_1/service_hooks/models.py b/azure-devops/azure/devops/v5_1/service_hooks/models.py index 48a30710..437d3d6e 100644 --- a/azure-devops/azure/devops/v5_1/service_hooks/models.py +++ b/azure-devops/azure/devops/v5_1/service_hooks/models.py @@ -10,7 +10,8 @@ class Consumer(Model): - """Consumer. + """ + Defines the data contract of a consumer. :param _links: Reference Links :type _links: :class:`ReferenceLinks ` @@ -66,7 +67,8 @@ def __init__(self, _links=None, actions=None, authentication_type=None, descript class ConsumerAction(Model): - """ConsumerAction. + """ + Defines the data contract of a consumer action. :param _links: Reference Links :type _links: :class:`ReferenceLinks ` @@ -118,7 +120,8 @@ def __init__(self, _links=None, allow_resource_version_override=None, consumer_i class Event(Model): - """Event. + """ + Encapsulates the properties of an event. :param created_date: Gets or sets the UTC-based date and time that this event was created. :type created_date: datetime @@ -170,7 +173,8 @@ def __init__(self, created_date=None, detailed_message=None, event_type=None, id class EventTypeDescriptor(Model): - """EventTypeDescriptor. + """ + Describes a type of event :param description: A localized description of the event type :type description: str @@ -210,7 +214,8 @@ def __init__(self, description=None, id=None, input_descriptors=None, name=None, class ExternalConfigurationDescriptor(Model): - """ExternalConfigurationDescriptor. + """ + Describes how to configure a subscription that is managed externally. :param create_subscription_url: Url of the site to create this type of subscription. :type create_subscription_url: str @@ -234,7 +239,8 @@ def __init__(self, create_subscription_url=None, edit_subscription_property_name class FormattedEventMessage(Model): - """FormattedEventMessage. + """ + Provides different formats of an event message :param html: Gets or sets the html format of the message :type html: str @@ -258,8 +264,7 @@ def __init__(self, html=None, markdown=None, text=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -286,8 +291,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -346,7 +350,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class InputDescriptor(Model): - """InputDescriptor. + """ + Describes an input for subscriptions. :param dependency_input_ids: The ids of all inputs that the value of this input is dependent on. :type dependency_input_ids: list of str @@ -414,7 +419,8 @@ def __init__(self, dependency_input_ids=None, description=None, group_name=None, class InputFilter(Model): - """InputFilter. + """ + Defines a filter for subscription inputs. The filter matches a set of inputs if any (one or more) of the groups evaluates to true. :param conditions: Groups of input filter expressions. This filter matches a set of inputs if any (one or more) of the groups evaluates to true. :type conditions: list of :class:`InputFilterCondition ` @@ -430,7 +436,8 @@ def __init__(self, conditions=None): class InputFilterCondition(Model): - """InputFilterCondition. + """ + An expression which can be applied to filter a list of subscription inputs :param case_sensitive: Whether or not to do a case sensitive match :type case_sensitive: bool @@ -458,7 +465,8 @@ def __init__(self, case_sensitive=None, input_id=None, input_value=None, operato class InputValidation(Model): - """InputValidation. + """ + Describes what values are valid for a subscription input :param data_type: Gets or sets the data data type to validate. :type data_type: object @@ -502,7 +510,8 @@ def __init__(self, data_type=None, is_required=None, max_length=None, max_value= class InputValue(Model): - """InputValue. + """ + Information about a single value for an input :param data: Any other data about this input :type data: dict @@ -526,7 +535,8 @@ def __init__(self, data=None, display_value=None, value=None): class InputValues(Model): - """InputValues. + """ + Information about the possible/allowed values for a given subscription input :param default_value: The default value to use for this input :type default_value: str @@ -566,7 +576,8 @@ def __init__(self, default_value=None, error=None, input_id=None, is_disabled=No class InputValuesError(Model): - """InputValuesError. + """ + Error information related to a subscription input value. :param message: The error message. :type message: str @@ -582,8 +593,7 @@ def __init__(self, message=None): class InputValuesQuery(Model): - """InputValuesQuery. - + """ :param current_values: :type current_values: dict :param input_values: The input values to return on input, and the result from the consumer on output. @@ -606,7 +616,8 @@ def __init__(self, current_values=None, input_values=None, resource=None): class Notification(Model): - """Notification. + """ + Defines the data contract of the result of processing an event for a subscription. :param created_date: Gets or sets date and time that this result was created. :type created_date: datetime @@ -654,7 +665,8 @@ def __init__(self, created_date=None, details=None, event_id=None, id=None, modi class NotificationDetails(Model): - """NotificationDetails. + """ + Defines the data contract of notification details. :param completed_date: Gets or sets the time that this notification was completed (response received from the consumer) :type completed_date: datetime @@ -734,7 +746,8 @@ def __init__(self, completed_date=None, consumer_action_id=None, consumer_id=Non class NotificationResultsSummaryDetail(Model): - """NotificationResultsSummaryDetail. + """ + Summary of a particular result and count. :param notification_count: Count of notification sent out with a matching result. :type notification_count: int @@ -754,7 +767,8 @@ def __init__(self, notification_count=None, result=None): class NotificationsQuery(Model): - """NotificationsQuery. + """ + Defines a query for service hook notifications. :param associated_subscriptions: The subscriptions associated with the notifications returned from the query :type associated_subscriptions: list of :class:`Subscription ` @@ -814,7 +828,8 @@ def __init__(self, associated_subscriptions=None, include_details=None, max_crea class NotificationSummary(Model): - """NotificationSummary. + """ + Summary of the notifications for a subscription. :param results: The notification results for this particular subscription. :type results: list of :class:`NotificationResultsSummaryDetail ` @@ -834,7 +849,8 @@ def __init__(self, results=None, subscription_id=None): class Publisher(Model): - """Publisher. + """ + Defines the data contract of an event publisher. :param _links: Reference Links :type _links: :class:`ReferenceLinks ` @@ -878,7 +894,8 @@ def __init__(self, _links=None, description=None, id=None, input_descriptors=Non class PublisherEvent(Model): - """PublisherEvent. + """ + Wrapper around an event which is being published :param diagnostics: Add key/value pairs which will be stored with a published notification in the SH service DB. This key/value pairs are for diagnostic purposes only and will have not effect on the delivery of a notificaton. :type diagnostics: dict @@ -918,7 +935,8 @@ def __init__(self, diagnostics=None, event=None, is_filtered_event=None, notific class PublishersQuery(Model): - """PublishersQuery. + """ + Defines a query for service hook publishers. :param publisher_ids: Optional list of publisher ids to restrict the results to :type publisher_ids: list of str @@ -942,7 +960,8 @@ def __init__(self, publisher_ids=None, publisher_inputs=None, results=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -958,7 +977,8 @@ def __init__(self, links=None): class ResourceContainer(Model): - """ResourceContainer. + """ + The base class for all resource containers, i.e. Account, Collection, Project :param base_url: Gets or sets the container's base URL, i.e. the URL of the host (collection, application, or deploument) containing the container resource. :type base_url: str @@ -986,7 +1006,8 @@ def __init__(self, base_url=None, id=None, name=None, url=None): class SessionToken(Model): - """SessionToken. + """ + Represents a session token to be attached in Events for Consumer actions that need it. :param error: The error message in case of error :type error: str @@ -1010,7 +1031,8 @@ def __init__(self, error=None, token=None, valid_to=None): class Subscription(Model): - """Subscription. + """ + Encapsulates an event subscription. :param _links: Reference Links :type _links: :class:`ReferenceLinks ` @@ -1098,8 +1120,7 @@ def __init__(self, _links=None, action_description=None, consumer_action_id=None class SubscriptionDiagnostics(Model): - """SubscriptionDiagnostics. - + """ :param delivery_results: :type delivery_results: :class:`SubscriptionTracing ` :param delivery_tracing: @@ -1122,7 +1143,8 @@ def __init__(self, delivery_results=None, delivery_tracing=None, evaluation_trac class SubscriptionInputValuesQuery(Model): - """SubscriptionInputValuesQuery. + """ + Query for obtaining information about the possible/allowed values for one or more subscription inputs :param input_values: The input values to return on input, and the result from the consumer on output. :type input_values: list of :class:`InputValues ` @@ -1146,7 +1168,8 @@ def __init__(self, input_values=None, scope=None, subscription=None): class SubscriptionsQuery(Model): - """SubscriptionsQuery. + """ + Defines a query for service hook subscriptions. :param consumer_action_id: Optional consumer action id to restrict the results to (null for any) :type consumer_action_id: str @@ -1190,8 +1213,7 @@ def __init__(self, consumer_action_id=None, consumer_id=None, consumer_input_fil class SubscriptionTracing(Model): - """SubscriptionTracing. - + """ :param enabled: :type enabled: bool :param end_date: Trace until the specified end date. @@ -1222,8 +1244,7 @@ def __init__(self, enabled=None, end_date=None, max_traced_entries=None, start_d class UpdateSubscripitonDiagnosticsParameters(Model): - """UpdateSubscripitonDiagnosticsParameters. - + """ :param delivery_results: :type delivery_results: :class:`UpdateSubscripitonTracingParameters ` :param delivery_tracing: @@ -1246,8 +1267,7 @@ def __init__(self, delivery_results=None, delivery_tracing=None, evaluation_trac class UpdateSubscripitonTracingParameters(Model): - """UpdateSubscripitonTracingParameters. - + """ :param enabled: :type enabled: bool """ @@ -1262,7 +1282,8 @@ def __init__(self, enabled=None): class VersionedResource(Model): - """VersionedResource. + """ + Encapsulates the resource version and its data or reference to the compatible version. Only one of the two last fields should be not null. :param compatible_with: Gets or sets the reference to the compatible version. :type compatible_with: str diff --git a/azure-devops/azure/devops/v5_1/symbol/models.py b/azure-devops/azure/devops/v5_1/symbol/models.py index e9cbfbda..d190fabb 100644 --- a/azure-devops/azure/devops/v5_1/symbol/models.py +++ b/azure-devops/azure/devops/v5_1/symbol/models.py @@ -10,7 +10,8 @@ class DebugEntryCreateBatch(Model): - """DebugEntryCreateBatch. + """ + A batch of debug entry to create. :param create_behavior: Defines what to do when a debug entry in the batch already exists. :type create_behavior: object @@ -30,7 +31,8 @@ def __init__(self, create_behavior=None, debug_entries=None): class JsonBlobBlockHash(Model): - """JsonBlobBlockHash. + """ + BlobBlock hash formatted to be deserialized for symbol service. :param hash_bytes: Array of hash bytes. :type hash_bytes: str @@ -46,8 +48,7 @@ def __init__(self, hash_bytes=None): class JsonBlobIdentifier(Model): - """JsonBlobIdentifier. - + """ :param identifier_value: :type identifier_value: str """ @@ -62,7 +63,8 @@ def __init__(self, identifier_value=None): class JsonBlobIdentifierWithBlocks(Model): - """JsonBlobIdentifierWithBlocks. + """ + BlobIdentifier with block hashes formatted to be deserialzied for symbol service. :param block_hashes: List of blob block hashes. :type block_hashes: list of :class:`JsonBlobBlockHash ` @@ -82,8 +84,7 @@ def __init__(self, block_hashes=None, identifier_value=None): class ResourceBase(Model): - """ResourceBase. - + """ :param created_by: The ID of user who created this item. Optional. :type created_by: str :param created_date: The date time when this item is created. Optional. @@ -114,7 +115,8 @@ def __init__(self, created_by=None, created_date=None, id=None, storage_eTag=Non class DebugEntry(ResourceBase): - """DebugEntry. + """ + A dual-purpose data object, the debug entry is used by the client to publish the symbol file (with file's blob identifier, which can be calculated from VSTS hashing algorithm) or query the file (with a client key). Since the symbol server tries to return a matched symbol file with the richest information level, it may not always point to the same symbol file for different queries with same client key. :param created_by: The ID of user who created this item. Optional. :type created_by: str @@ -169,7 +171,8 @@ def __init__(self, created_by=None, created_date=None, id=None, storage_eTag=Non class Request(ResourceBase): - """Request. + """ + Symbol request. :param created_by: The ID of user who created this item. Optional. :type created_by: str diff --git a/azure-devops/azure/devops/v5_1/task/models.py b/azure-devops/azure/devops/v5_1/task/models.py index a9706661..f607fc63 100644 --- a/azure-devops/azure/devops/v5_1/task/models.py +++ b/azure-devops/azure/devops/v5_1/task/models.py @@ -10,8 +10,7 @@ class Issue(Model): - """Issue. - + """ :param category: :type category: str :param data: @@ -38,7 +37,8 @@ def __init__(self, category=None, data=None, message=None, type=None): class JobOption(Model): - """JobOption. + """ + Represents an option that may affect the way an agent runs the job. :param data: :type data: dict @@ -58,8 +58,7 @@ def __init__(self, data=None, id=None): class MaskHint(Model): - """MaskHint. - + """ :param type: :type type: object :param value: @@ -78,8 +77,7 @@ def __init__(self, type=None, value=None): class PlanEnvironment(Model): - """PlanEnvironment. - + """ :param mask: :type mask: list of :class:`MaskHint ` :param options: @@ -102,8 +100,7 @@ def __init__(self, mask=None, options=None, variables=None): class ProjectReference(Model): - """ProjectReference. - + """ :param id: :type id: str :param name: @@ -122,7 +119,8 @@ def __init__(self, id=None, name=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -138,8 +136,7 @@ def __init__(self, links=None): class TaskAgentJob(Model): - """TaskAgentJob. - + """ :param container: :type container: str :param id: @@ -174,8 +171,7 @@ def __init__(self, container=None, id=None, name=None, sidecar_containers=None, class TaskAgentJobStep(Model): - """TaskAgentJobStep. - + """ :param condition: :type condition: str :param continue_on_error: @@ -226,8 +222,7 @@ def __init__(self, condition=None, continue_on_error=None, enabled=None, env=Non class TaskAgentJobTask(Model): - """TaskAgentJobTask. - + """ :param id: :type id: str :param name: @@ -250,8 +245,7 @@ def __init__(self, id=None, name=None, version=None): class TaskAgentJobVariable(Model): - """TaskAgentJobVariable. - + """ :param name: :type name: str :param secret: @@ -274,8 +268,7 @@ def __init__(self, name=None, secret=None, value=None): class TaskAttachment(Model): - """TaskAttachment. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param created_on: @@ -318,8 +311,7 @@ def __init__(self, _links=None, created_on=None, last_changed_by=None, last_chan class TaskLogReference(Model): - """TaskLogReference. - + """ :param id: :type id: int :param location: @@ -338,8 +330,7 @@ def __init__(self, id=None, location=None): class TaskOrchestrationItem(Model): - """TaskOrchestrationItem. - + """ :param item_type: :type item_type: object """ @@ -354,8 +345,7 @@ def __init__(self, item_type=None): class TaskOrchestrationOwner(Model): - """TaskOrchestrationOwner. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param id: @@ -378,8 +368,7 @@ def __init__(self, _links=None, id=None, name=None): class TaskOrchestrationPlanGroupsQueueMetrics(Model): - """TaskOrchestrationPlanGroupsQueueMetrics. - + """ :param count: :type count: int :param status: @@ -398,8 +387,7 @@ def __init__(self, count=None, status=None): class TaskOrchestrationPlanReference(Model): - """TaskOrchestrationPlanReference. - + """ :param artifact_location: :type artifact_location: str :param artifact_uri: @@ -446,8 +434,7 @@ def __init__(self, artifact_location=None, artifact_uri=None, definition=None, o class TaskOrchestrationQueuedPlan(Model): - """TaskOrchestrationQueuedPlan. - + """ :param assign_time: :type assign_time: datetime :param definition: @@ -494,8 +481,7 @@ def __init__(self, assign_time=None, definition=None, owner=None, plan_group=Non class TaskOrchestrationQueuedPlanGroup(Model): - """TaskOrchestrationQueuedPlanGroup. - + """ :param definition: :type definition: :class:`TaskOrchestrationOwner ` :param owner: @@ -530,8 +516,7 @@ def __init__(self, definition=None, owner=None, plan_group=None, plans=None, pro class TaskReference(Model): - """TaskReference. - + """ :param id: :type id: str :param inputs: @@ -558,8 +543,7 @@ def __init__(self, id=None, inputs=None, name=None, version=None): class TimelineAttempt(Model): - """TimelineAttempt. - + """ :param attempt: Gets or sets the attempt of the record. :type attempt: int :param identifier: Gets or sets the unique identifier for the record. @@ -586,8 +570,7 @@ def __init__(self, attempt=None, identifier=None, record_id=None, timeline_id=No class TimelineRecord(Model): - """TimelineRecord. - + """ :param attempt: :type attempt: int :param change_id: @@ -706,8 +689,7 @@ def __init__(self, attempt=None, change_id=None, current_operation=None, details class TimelineRecordFeedLinesWrapper(Model): - """TimelineRecordFeedLinesWrapper. - + """ :param count: :type count: int :param step_id: @@ -730,8 +712,7 @@ def __init__(self, count=None, step_id=None, value=None): class TimelineReference(Model): - """TimelineReference. - + """ :param change_id: :type change_id: int :param id: @@ -754,8 +735,7 @@ def __init__(self, change_id=None, id=None, location=None): class VariableValue(Model): - """VariableValue. - + """ :param is_secret: :type is_secret: bool :param value: @@ -774,8 +754,7 @@ def __init__(self, is_secret=None, value=None): class TaskLog(TaskLogReference): - """TaskLog. - + """ :param id: :type id: int :param location: @@ -812,8 +791,7 @@ def __init__(self, id=None, location=None, created_on=None, index_location=None, class TaskOrchestrationContainer(TaskOrchestrationItem): - """TaskOrchestrationContainer. - + """ :param item_type: :type item_type: object :param children: @@ -851,8 +829,7 @@ def __init__(self, item_type=None, children=None, continue_on_error=None, data=N class TaskOrchestrationPlan(TaskOrchestrationPlanReference): - """TaskOrchestrationPlan. - + """ :param artifact_location: :type artifact_location: str :param artifact_uri: @@ -934,8 +911,7 @@ def __init__(self, artifact_location=None, artifact_uri=None, definition=None, o class Timeline(TimelineReference): - """Timeline. - + """ :param change_id: :type change_id: int :param id: diff --git a/azure-devops/azure/devops/v5_1/task_agent/models.py b/azure-devops/azure/devops/v5_1/task_agent/models.py index e1aec7ee..7d851a4f 100644 --- a/azure-devops/azure/devops/v5_1/task_agent/models.py +++ b/azure-devops/azure/devops/v5_1/task_agent/models.py @@ -10,8 +10,7 @@ class AadOauthTokenRequest(Model): - """AadOauthTokenRequest. - + """ :param refresh: :type refresh: bool :param resource: @@ -38,8 +37,7 @@ def __init__(self, refresh=None, resource=None, tenant_id=None, token=None): class AadOauthTokenResult(Model): - """AadOauthTokenResult. - + """ :param access_token: :type access_token: str :param refresh_token_cache: @@ -58,8 +56,7 @@ def __init__(self, access_token=None, refresh_token_cache=None): class AuthenticationSchemeReference(Model): - """AuthenticationSchemeReference. - + """ :param inputs: :type inputs: dict :param type: @@ -78,8 +75,7 @@ def __init__(self, inputs=None, type=None): class AuthorizationHeader(Model): - """AuthorizationHeader. - + """ :param name: Gets or sets the name of authorization header. :type name: str :param value: Gets or sets the value of authorization header. @@ -98,7 +94,8 @@ def __init__(self, name=None, value=None): class AzureManagementGroup(Model): - """AzureManagementGroup. + """ + Azure Management Group :param display_name: Display name of azure management group :type display_name: str @@ -126,7 +123,8 @@ def __init__(self, display_name=None, id=None, name=None, tenant_id=None): class AzureManagementGroupQueryResult(Model): - """AzureManagementGroupQueryResult. + """ + Azure management group query result :param error_message: Error message in case of an exception :type error_message: str @@ -146,8 +144,7 @@ def __init__(self, error_message=None, value=None): class AzureSubscription(Model): - """AzureSubscription. - + """ :param display_name: :type display_name: str :param subscription_id: @@ -174,8 +171,7 @@ def __init__(self, display_name=None, subscription_id=None, subscription_tenant_ class AzureSubscriptionQueryResult(Model): - """AzureSubscriptionQueryResult. - + """ :param error_message: :type error_message: str :param value: @@ -194,8 +190,7 @@ def __init__(self, error_message=None, value=None): class ClientCertificate(Model): - """ClientCertificate. - + """ :param value: Gets or sets the value of client certificate. :type value: str """ @@ -210,8 +205,7 @@ def __init__(self, value=None): class DataSource(Model): - """DataSource. - + """ :param authentication_scheme: :type authentication_scheme: :class:`AuthenticationSchemeReference ` :param endpoint_url: @@ -246,7 +240,8 @@ def __init__(self, authentication_scheme=None, endpoint_url=None, headers=None, class DataSourceBindingBase(Model): - """DataSourceBindingBase. + """ + Represents binding of data source for the service endpoint request. :param callback_context_template: Pagination format supported by this data source(ContinuationToken/SkipTop). :type callback_context_template: str @@ -310,8 +305,7 @@ def __init__(self, callback_context_template=None, callback_required_template=No class DataSourceDetails(Model): - """DataSourceDetails. - + """ :param data_source_name: :type data_source_name: str :param data_source_url: @@ -346,8 +340,7 @@ def __init__(self, data_source_name=None, data_source_url=None, headers=None, pa class DependencyBinding(Model): - """DependencyBinding. - + """ :param key: :type key: str :param value: @@ -366,8 +359,7 @@ def __init__(self, key=None, value=None): class DependencyData(Model): - """DependencyData. - + """ :param input: :type input: str :param map: @@ -386,8 +378,7 @@ def __init__(self, input=None, map=None): class DependsOn(Model): - """DependsOn. - + """ :param input: :type input: str :param map: @@ -406,7 +397,8 @@ def __init__(self, input=None, map=None): class DeploymentGroupCreateParameter(Model): - """DeploymentGroupCreateParameter. + """ + Properties to create Deployment group. :param description: Description of the deployment group. :type description: str @@ -434,7 +426,8 @@ def __init__(self, description=None, name=None, pool=None, pool_id=None): class DeploymentGroupCreateParameterPoolProperty(Model): - """DeploymentGroupCreateParameterPoolProperty. + """ + Properties of Deployment pool to create Deployment group. :param id: Deployment pool identifier. :type id: int @@ -450,7 +443,8 @@ def __init__(self, id=None): class DeploymentGroupMetrics(Model): - """DeploymentGroupMetrics. + """ + Deployment group metrics. :param columns_header: List of deployment group properties. And types of metrics provided for those properties. :type columns_header: :class:`MetricsColumnsHeader ` @@ -474,7 +468,8 @@ def __init__(self, columns_header=None, deployment_group=None, rows=None): class DeploymentGroupReference(Model): - """DeploymentGroupReference. + """ + Deployment group reference. This is useful for referring a deployment group in another object. :param id: Deployment group identifier. :type id: int @@ -502,7 +497,8 @@ def __init__(self, id=None, name=None, pool=None, project=None): class DeploymentGroupUpdateParameter(Model): - """DeploymentGroupUpdateParameter. + """ + Deployment group update parameter. :param description: Description of the deployment group. :type description: str @@ -522,7 +518,8 @@ def __init__(self, description=None, name=None): class DeploymentMachine(Model): - """DeploymentMachine. + """ + Deployment target. :param agent: Deployment agent. :type agent: :class:`TaskAgent ` @@ -550,8 +547,7 @@ def __init__(self, agent=None, id=None, properties=None, tags=None): class DeploymentMachineGroupReference(Model): - """DeploymentMachineGroupReference. - + """ :param id: :type id: int :param name: @@ -578,7 +574,8 @@ def __init__(self, id=None, name=None, pool=None, project=None): class DeploymentPoolSummary(Model): - """DeploymentPoolSummary. + """ + Deployment pool summary. :param deployment_groups: List of deployment groups referring to the deployment pool. :type deployment_groups: list of :class:`DeploymentGroupReference ` @@ -610,7 +607,8 @@ def __init__(self, deployment_groups=None, offline_agents_count=None, online_age class DeploymentTargetUpdateParameter(Model): - """DeploymentTargetUpdateParameter. + """ + Deployment target update parameter. :param id: Identifier of the deployment target. :type id: int @@ -630,8 +628,7 @@ def __init__(self, id=None, tags=None): class EndpointAuthorization(Model): - """EndpointAuthorization. - + """ :param parameters: Gets or sets the parameters for the selected authorization scheme. :type parameters: dict :param scheme: Gets or sets the scheme used for service endpoint authentication. @@ -650,7 +647,8 @@ def __init__(self, parameters=None, scheme=None): class EndpointUrl(Model): - """EndpointUrl. + """ + Represents url of the service endpoint. :param depends_on: Gets or sets the dependency bindings. :type depends_on: :class:`DependsOn ` @@ -682,7 +680,8 @@ def __init__(self, depends_on=None, display_name=None, help_text=None, is_visibl class EnvironmentCreateParameter(Model): - """EnvironmentCreateParameter. + """ + Properties to create Environment. :param description: Description of the environment. :type description: str @@ -702,7 +701,8 @@ def __init__(self, description=None, name=None): class EnvironmentDeploymentExecutionRecord(Model): - """EnvironmentDeploymentExecutionRecord. + """ + EnvironmentDeploymentExecutionRecord. :param definition: Definition of the environment deployment execution owner :type definition: :class:`TaskOrchestrationOwner ` @@ -786,7 +786,8 @@ def __init__(self, definition=None, environment_id=None, finish_time=None, id=No class EnvironmentInstance(Model): - """EnvironmentInstance. + """ + Environment. :param created_by: Identity reference of the user who created the Environment. :type created_by: :class:`IdentityRef ` @@ -830,8 +831,7 @@ def __init__(self, created_by=None, created_on=None, description=None, id=None, class EnvironmentReference(Model): - """EnvironmentReference. - + """ :param id: :type id: int :param name: @@ -850,8 +850,7 @@ def __init__(self, id=None, name=None): class EnvironmentResource(Model): - """EnvironmentResource. - + """ :param created_by: :type created_by: :class:`IdentityRef ` :param created_on: @@ -894,7 +893,8 @@ def __init__(self, created_by=None, created_on=None, environment_reference=None, class EnvironmentResourceReference(Model): - """EnvironmentResourceReference. + """ + EnvironmentResourceReference. :param id: Id of the resource. :type id: int @@ -918,7 +918,8 @@ def __init__(self, id=None, name=None, type=None): class EnvironmentUpdateParameter(Model): - """EnvironmentUpdateParameter. + """ + Properties to update Environment. :param description: Description of the environment. :type description: str @@ -938,8 +939,7 @@ def __init__(self, description=None, name=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -966,8 +966,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class HelpLink(Model): - """HelpLink. - + """ :param text: :type text: str :param url: @@ -986,8 +985,7 @@ def __init__(self, text=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -1046,7 +1044,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class InputDescriptor(Model): - """InputDescriptor. + """ + Describes an input for subscriptions. :param dependency_input_ids: The ids of all inputs that the value of this input is dependent on. :type dependency_input_ids: list of str @@ -1114,7 +1113,8 @@ def __init__(self, dependency_input_ids=None, description=None, group_name=None, class InputValidation(Model): - """InputValidation. + """ + Describes what values are valid for a subscription input :param data_type: Gets or sets the data data type to validate. :type data_type: object @@ -1158,8 +1158,7 @@ def __init__(self, data_type=None, is_required=None, max_length=None, max_value= class InputValidationRequest(Model): - """InputValidationRequest. - + """ :param inputs: :type inputs: dict """ @@ -1174,7 +1173,8 @@ def __init__(self, inputs=None): class InputValue(Model): - """InputValue. + """ + Information about a single value for an input :param data: Any other data about this input :type data: dict @@ -1198,7 +1198,8 @@ def __init__(self, data=None, display_value=None, value=None): class InputValues(Model): - """InputValues. + """ + Information about the possible/allowed values for a given subscription input :param default_value: The default value to use for this input :type default_value: str @@ -1238,7 +1239,8 @@ def __init__(self, default_value=None, error=None, input_id=None, is_disabled=No class InputValuesError(Model): - """InputValuesError. + """ + Error information related to a subscription input value. :param message: The error message. :type message: str @@ -1254,8 +1256,7 @@ def __init__(self, message=None): class KubernetesResource(EnvironmentResource): - """KubernetesResource. - + """ :param created_by: :type created_by: :class:`IdentityRef ` :param created_on: @@ -1302,8 +1303,7 @@ def __init__(self, created_by=None, created_on=None, environment_reference=None, class KubernetesResourceCreateParameters(Model): - """KubernetesResourceCreateParameters. - + """ :param cluster_name: :type cluster_name: str :param name: @@ -1330,7 +1330,8 @@ def __init__(self, cluster_name=None, name=None, namespace=None, service_endpoin class MarketplacePurchasedLicense(Model): - """MarketplacePurchasedLicense. + """ + Represents a purchase of resource units in a secondary marketplace. :param marketplace_name: The Marketplace display name. :type marketplace_name: str @@ -1354,7 +1355,8 @@ def __init__(self, marketplace_name=None, purchaser_name=None, purchase_unit_cou class MetricsColumnMetaData(Model): - """MetricsColumnMetaData. + """ + Meta data for a metrics column. :param column_name: Name. :type column_name: str @@ -1374,7 +1376,8 @@ def __init__(self, column_name=None, column_value_type=None): class MetricsColumnsHeader(Model): - """MetricsColumnsHeader. + """ + Metrics columns header :param dimensions: Properties of deployment group for which metrics are provided. E.g. 1: LastJobStatus E.g. 2: TargetState :type dimensions: list of :class:`MetricsColumnMetaData ` @@ -1394,7 +1397,8 @@ def __init__(self, dimensions=None, metrics=None): class MetricsRow(Model): - """MetricsRow. + """ + Metrics row. :param dimensions: The values of the properties mentioned as 'Dimensions' in column header. E.g. 1: For a property 'LastJobStatus' - metrics will be provided for 'passed', 'failed', etc. E.g. 2: For a property 'TargetState' - metrics will be provided for 'online', 'offline' targets. :type dimensions: list of str @@ -1414,7 +1418,8 @@ def __init__(self, dimensions=None, metrics=None): class PackageMetadata(Model): - """PackageMetadata. + """ + Represents a downloadable package. :param created_on: The date the package was created :type created_on: datetime @@ -1458,8 +1463,7 @@ def __init__(self, created_on=None, download_url=None, filename=None, hash_value class PackageVersion(Model): - """PackageVersion. - + """ :param major: :type major: int :param minor: @@ -1482,8 +1486,7 @@ def __init__(self, major=None, minor=None, patch=None): class ProjectReference(Model): - """ProjectReference. - + """ :param id: :type id: str :param name: @@ -1502,8 +1505,7 @@ def __init__(self, id=None, name=None): class PublishTaskGroupMetadata(Model): - """PublishTaskGroupMetadata. - + """ :param comment: :type comment: str :param parent_definition_revision: @@ -1534,7 +1536,8 @@ def __init__(self, comment=None, parent_definition_revision=None, preview=None, class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -1550,8 +1553,7 @@ def __init__(self, links=None): class ResourceLimit(Model): - """ResourceLimit. - + """ :param failed_to_reach_all_providers: :type failed_to_reach_all_providers: bool :param host_id: @@ -1594,8 +1596,7 @@ def __init__(self, failed_to_reach_all_providers=None, host_id=None, is_hosted=N class ResourceUsage(Model): - """ResourceUsage. - + """ :param resource_limit: :type resource_limit: :class:`ResourceLimit ` :param running_requests: @@ -1622,8 +1623,7 @@ def __init__(self, resource_limit=None, running_requests=None, used_count=None, class ResultTransformationDetails(Model): - """ResultTransformationDetails. - + """ :param result_template: :type result_template: str """ @@ -1638,8 +1638,7 @@ def __init__(self, result_template=None): class SecureFile(Model): - """SecureFile. - + """ :param created_by: :type created_by: :class:`IdentityRef ` :param created_on: @@ -1682,7 +1681,8 @@ def __init__(self, created_by=None, created_on=None, id=None, modified_by=None, class ServiceEndpoint(Model): - """ServiceEndpoint. + """ + Represents an endpoint which may be used by an orchestration job. :param administrators_group: Gets or sets the identity reference for the administrators group of the service endpoint. :type administrators_group: :class:`IdentityRef ` @@ -1754,8 +1754,7 @@ def __init__(self, administrators_group=None, authorization=None, created_by=Non class ServiceEndpointAuthenticationScheme(Model): - """ServiceEndpointAuthenticationScheme. - + """ :param authorization_headers: Gets or sets the authorization headers of service endpoint authentication scheme. :type authorization_headers: list of :class:`AuthorizationHeader ` :param client_certificates: Gets or sets the certificates of service endpoint authentication scheme. @@ -1786,8 +1785,7 @@ def __init__(self, authorization_headers=None, client_certificates=None, display class ServiceEndpointDetails(Model): - """ServiceEndpointDetails. - + """ :param authorization: :type authorization: :class:`EndpointAuthorization ` :param data: @@ -1814,7 +1812,8 @@ def __init__(self, authorization=None, data=None, type=None, url=None): class ServiceEndpointExecutionData(Model): - """ServiceEndpointExecutionData. + """ + Represents service endpoint execution data. :param definition: Gets the definition of service endpoint execution owner. :type definition: :class:`TaskOrchestrationOwner ` @@ -1854,8 +1853,7 @@ def __init__(self, definition=None, finish_time=None, id=None, owner=None, plan_ class ServiceEndpointExecutionRecord(Model): - """ServiceEndpointExecutionRecord. - + """ :param data: Gets the execution data of service endpoint execution. :type data: :class:`ServiceEndpointExecutionData ` :param endpoint_id: Gets the Id of service endpoint. @@ -1874,8 +1872,7 @@ def __init__(self, data=None, endpoint_id=None): class ServiceEndpointExecutionRecordsInput(Model): - """ServiceEndpointExecutionRecordsInput. - + """ :param data: :type data: :class:`ServiceEndpointExecutionData ` :param endpoint_ids: @@ -1894,8 +1891,7 @@ def __init__(self, data=None, endpoint_ids=None): class ServiceEndpointRequest(Model): - """ServiceEndpointRequest. - + """ :param data_source_details: :type data_source_details: :class:`DataSourceDetails ` :param result_transformation_details: @@ -1918,8 +1914,7 @@ def __init__(self, data_source_details=None, result_transformation_details=None, class ServiceEndpointRequestResult(Model): - """ServiceEndpointRequestResult. - + """ :param error_message: :type error_message: str :param result: @@ -1942,7 +1937,8 @@ def __init__(self, error_message=None, result=None, status_code=None): class ServiceEndpointType(Model): - """ServiceEndpointType. + """ + Represents type of the service endpoint. :param authentication_schemes: Authentication scheme of service endpoint type. :type authentication_schemes: list of :class:`ServiceEndpointAuthenticationScheme ` @@ -2006,7 +2002,8 @@ def __init__(self, authentication_schemes=None, data_sources=None, dependency_da class TaskAgentAuthorization(Model): - """TaskAgentAuthorization. + """ + Provides data necessary for authorizing the agent using OAuth 2.0 authentication flows. :param authorization_url: Endpoint used to obtain access tokens from the configured token service. :type authorization_url: str @@ -2030,8 +2027,7 @@ def __init__(self, authorization_url=None, client_id=None, public_key=None): class TaskAgentCloud(Model): - """TaskAgentCloud. - + """ :param acquire_agent_endpoint: Gets or sets a AcquireAgentEndpoint using which a request can be made to acquire new agent :type acquire_agent_endpoint: str :param acquisition_timeout: @@ -2094,8 +2090,7 @@ def __init__(self, acquire_agent_endpoint=None, acquisition_timeout=None, agent_ class TaskAgentCloudRequest(Model): - """TaskAgentCloudRequest. - + """ :param agent: :type agent: :class:`TaskAgentReference ` :param agent_cloud_id: @@ -2146,8 +2141,7 @@ def __init__(self, agent=None, agent_cloud_id=None, agent_connected_time=None, a class TaskAgentCloudType(Model): - """TaskAgentCloudType. - + """ :param display_name: Gets or sets the display name of agnet cloud type. :type display_name: str :param input_descriptors: Gets or sets the input descriptors @@ -2170,8 +2164,7 @@ def __init__(self, display_name=None, input_descriptors=None, name=None): class TaskAgentDelaySource(Model): - """TaskAgentDelaySource. - + """ :param delays: :type delays: list of object :param task_agent: @@ -2190,7 +2183,8 @@ def __init__(self, delays=None, task_agent=None): class TaskAgentJobRequest(Model): - """TaskAgentJobRequest. + """ + A job request for an agent. :param agent_delays: :type agent_delays: list of :class:`TaskAgentDelaySource ` @@ -2322,7 +2316,8 @@ def __init__(self, agent_delays=None, agent_specification=None, assign_time=None class TaskAgentMessage(Model): - """TaskAgentMessage. + """ + Provides a contract for receiving messages from the task orchestrator. :param body: Gets or sets the body of the message. If the IV property is provided the body will need to be decrypted using the TaskAgentSession.EncryptionKey value in addition to the IV. :type body: str @@ -2350,8 +2345,7 @@ def __init__(self, body=None, iV=None, message_id=None, message_type=None): class TaskAgentPoolMaintenanceDefinition(Model): - """TaskAgentPoolMaintenanceDefinition. - + """ :param enabled: Enable maintenance :type enabled: bool :param id: Id @@ -2394,8 +2388,7 @@ def __init__(self, enabled=None, id=None, job_timeout_in_minutes=None, max_concu class TaskAgentPoolMaintenanceJob(Model): - """TaskAgentPoolMaintenanceJob. - + """ :param definition_id: The maintenance definition for the maintenance job :type definition_id: int :param error_count: The total error counts during the maintenance job @@ -2462,8 +2455,7 @@ def __init__(self, definition_id=None, error_count=None, finish_time=None, job_i class TaskAgentPoolMaintenanceJobTargetAgent(Model): - """TaskAgentPoolMaintenanceJobTargetAgent. - + """ :param agent: :type agent: :class:`TaskAgentReference ` :param job_id: @@ -2490,8 +2482,7 @@ def __init__(self, agent=None, job_id=None, result=None, status=None): class TaskAgentPoolMaintenanceOptions(Model): - """TaskAgentPoolMaintenanceOptions. - + """ :param working_directory_expiration_in_days: time to consider a System.DefaultWorkingDirectory is stale :type working_directory_expiration_in_days: int """ @@ -2506,8 +2497,7 @@ def __init__(self, working_directory_expiration_in_days=None): class TaskAgentPoolMaintenanceRetentionPolicy(Model): - """TaskAgentPoolMaintenanceRetentionPolicy. - + """ :param number_of_history_records_to_keep: Number of records to keep for maintenance job executed with this definition. :type number_of_history_records_to_keep: int """ @@ -2522,8 +2512,7 @@ def __init__(self, number_of_history_records_to_keep=None): class TaskAgentPoolMaintenanceSchedule(Model): - """TaskAgentPoolMaintenanceSchedule. - + """ :param days_to_build: Days for a build (flags enum for days of the week) :type days_to_build: object :param schedule_job_id: The Job Id of the Scheduled job that will queue the pool maintenance job. @@ -2554,8 +2543,7 @@ def __init__(self, days_to_build=None, schedule_job_id=None, start_hours=None, s class TaskAgentPoolReference(Model): - """TaskAgentPoolReference. - + """ :param id: :type id: int :param is_hosted: Gets or sets a value indicating whether or not this pool is managed by the service. @@ -2594,7 +2582,8 @@ def __init__(self, id=None, is_hosted=None, is_legacy=None, name=None, pool_type class TaskAgentPublicKey(Model): - """TaskAgentPublicKey. + """ + Represents the public key portion of an RSA asymmetric key. :param exponent: Gets or sets the exponent for the public key. :type exponent: str @@ -2614,7 +2603,8 @@ def __init__(self, exponent=None, modulus=None): class TaskAgentQueue(Model): - """TaskAgentQueue. + """ + An agent queue. :param id: ID of the queue :type id: int @@ -2642,7 +2632,8 @@ def __init__(self, id=None, name=None, pool=None, project_id=None): class TaskAgentReference(Model): - """TaskAgentReference. + """ + A reference to an agent. :param _links: :type _links: :class:`ReferenceLinks ` @@ -2690,7 +2681,8 @@ def __init__(self, _links=None, access_point=None, enabled=None, id=None, name=N class TaskAgentSession(Model): - """TaskAgentSession. + """ + Represents a session for performing message exchanges from an agent. :param agent: Gets or sets the agent which is the target of the session. :type agent: :class:`TaskAgentReference ` @@ -2722,7 +2714,8 @@ def __init__(self, agent=None, encryption_key=None, owner_name=None, session_id= class TaskAgentSessionKey(Model): - """TaskAgentSessionKey. + """ + Represents a symmetric key used for message-level encryption for communication sent to an agent. :param encrypted: Gets or sets a value indicating whether or not the key value is encrypted. If this value is true, the Value property should be decrypted using the RSA key exchanged with the server during registration. :type encrypted: bool @@ -2742,7 +2735,8 @@ def __init__(self, encrypted=None, value=None): class TaskAgentUpdate(Model): - """TaskAgentUpdate. + """ + Details about an agent update. :param current_state: Current state of this agent update. :type current_state: str @@ -2778,8 +2772,7 @@ def __init__(self, current_state=None, reason=None, requested_by=None, request_t class TaskAgentUpdateReason(Model): - """TaskAgentUpdateReason. - + """ :param code: :type code: object """ @@ -2794,8 +2787,7 @@ def __init__(self, code=None): class TaskDefinition(Model): - """TaskDefinition. - + """ :param agent_execution: :type agent_execution: :class:`TaskExecution ` :param author: @@ -2966,8 +2958,7 @@ def __init__(self, agent_execution=None, author=None, category=None, contents_up class TaskDefinitionEndpoint(Model): - """TaskDefinitionEndpoint. - + """ :param connection_id: An ID that identifies a service connection to be used for authenticating endpoint requests. :type connection_id: str :param key_selector: An Json based keyselector to filter response returned by fetching the endpoint Url.A Json based keyselector must be prefixed with "jsonpath:". KeySelector can be used to specify the filter to get the keys for the values specified with Selector. The following keyselector defines an Json for extracting nodes named 'ServiceName'. endpoint.KeySelector = "jsonpath://ServiceName"; @@ -3002,8 +2993,7 @@ def __init__(self, connection_id=None, key_selector=None, scope=None, selector=N class TaskDefinitionReference(Model): - """TaskDefinitionReference. - + """ :param definition_type: Gets or sets the definition type. Values can be 'task' or 'metaTask'. :type definition_type: str :param id: Gets or sets the unique identifier of task. @@ -3026,8 +3016,7 @@ def __init__(self, definition_type=None, id=None, version_spec=None): class TaskExecution(Model): - """TaskExecution. - + """ :param exec_task: The utility task to run. Specifying this means that this task definition is simply a meta task to call another task. This is useful for tasks that call utility tasks like powershell and commandline :type exec_task: :class:`TaskReference ` :param platform_instructions: If a task is going to run code, then this provides the type/script etc... information by platform. For example, it might look like. net45: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } net20: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } java: { jar: "powershelltask.tasks.automation.teamfoundation.microsoft.com", } node: { script: "powershellhost.js", } @@ -3046,8 +3035,7 @@ def __init__(self, exec_task=None, platform_instructions=None): class TaskGroup(TaskDefinition): - """TaskGroup. - + """ :param agent_execution: :type agent_execution: :class:`TaskExecution ` :param author: @@ -3218,8 +3206,7 @@ def __init__(self, agent_execution=None, author=None, category=None, contents_up class TaskGroupCreateParameter(Model): - """TaskGroupCreateParameter. - + """ :param author: Sets author name of the task group. :type author: str :param category: Sets category of the task group. @@ -3278,8 +3265,7 @@ def __init__(self, author=None, category=None, description=None, friendly_name=N class TaskGroupDefinition(Model): - """TaskGroupDefinition. - + """ :param display_name: :type display_name: str :param is_expanded: @@ -3310,8 +3296,7 @@ def __init__(self, display_name=None, is_expanded=None, name=None, tags=None, vi class TaskGroupRevision(Model): - """TaskGroupRevision. - + """ :param changed_by: :type changed_by: :class:`IdentityRef ` :param changed_date: @@ -3354,7 +3339,8 @@ def __init__(self, changed_by=None, changed_date=None, change_type=None, comment class TaskGroupStep(Model): - """TaskGroupStep. + """ + Represents tasks in the task group. :param always_run: Gets or sets as 'true' to run the task always, 'false' otherwise. :type always_run: bool @@ -3402,8 +3388,7 @@ def __init__(self, always_run=None, condition=None, continue_on_error=None, disp class TaskGroupUpdateParameter(Model): - """TaskGroupUpdateParameter. - + """ :param author: Sets author name of the task group. :type author: str :param category: Sets category of the task group. @@ -3474,8 +3459,7 @@ def __init__(self, author=None, category=None, comment=None, description=None, f class TaskHubLicenseDetails(Model): - """TaskHubLicenseDetails. - + """ :param enterprise_users_count: :type enterprise_users_count: int :param failed_to_reach_all_providers: @@ -3546,8 +3530,7 @@ def __init__(self, enterprise_users_count=None, failed_to_reach_all_providers=No class TaskInputDefinitionBase(Model): - """TaskInputDefinitionBase. - + """ :param aliases: :type aliases: list of str :param default_value: @@ -3606,8 +3589,7 @@ def __init__(self, aliases=None, default_value=None, group_name=None, help_mark_ class TaskInputValidation(Model): - """TaskInputValidation. - + """ :param expression: Conditional expression :type expression: str :param message: Message explaining how user can correct if validation fails @@ -3626,8 +3608,7 @@ def __init__(self, expression=None, message=None): class TaskOrchestrationOwner(Model): - """TaskOrchestrationOwner. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param id: @@ -3650,8 +3631,7 @@ def __init__(self, _links=None, id=None, name=None): class TaskOutputVariable(Model): - """TaskOutputVariable. - + """ :param description: :type description: str :param name: @@ -3670,8 +3650,7 @@ def __init__(self, description=None, name=None): class TaskPackageMetadata(Model): - """TaskPackageMetadata. - + """ :param type: Gets the name of the package. :type type: str :param url: Gets the url of the package. @@ -3694,8 +3673,7 @@ def __init__(self, type=None, url=None, version=None): class TaskReference(Model): - """TaskReference. - + """ :param id: :type id: str :param inputs: @@ -3722,8 +3700,7 @@ def __init__(self, id=None, inputs=None, name=None, version=None): class TaskSourceDefinitionBase(Model): - """TaskSourceDefinitionBase. - + """ :param auth_key: :type auth_key: str :param endpoint: @@ -3754,8 +3731,7 @@ def __init__(self, auth_key=None, endpoint=None, key_selector=None, selector=Non class TaskVersion(Model): - """TaskVersion. - + """ :param is_test: :type is_test: bool :param major: @@ -3782,8 +3758,7 @@ def __init__(self, is_test=None, major=None, minor=None, patch=None): class ValidationItem(Model): - """ValidationItem. - + """ :param is_valid: Tells whether the current input is valid or not :type is_valid: bool :param reason: Reason for input validation failure @@ -3810,7 +3785,8 @@ def __init__(self, is_valid=None, reason=None, type=None, value=None): class VariableGroup(Model): - """VariableGroup. + """ + A variable group is a collection of related variables. :param created_by: Gets or sets the identity who created the variable group. :type created_by: :class:`IdentityRef ` @@ -3866,8 +3842,7 @@ def __init__(self, created_by=None, created_on=None, description=None, id=None, class VariableGroupParameters(Model): - """VariableGroupParameters. - + """ :param description: Sets description of the variable group. :type description: str :param name: Sets name of the variable group. @@ -3898,7 +3873,8 @@ def __init__(self, description=None, name=None, provider_data=None, type=None, v class VariableGroupProviderData(Model): - """VariableGroupProviderData. + """ + Defines provider data of the variable group. """ @@ -3910,8 +3886,7 @@ def __init__(self): class VariableValue(Model): - """VariableValue. - + """ :param is_secret: :type is_secret: bool :param value: @@ -3930,8 +3905,7 @@ def __init__(self, is_secret=None, value=None): class VirtualMachine(Model): - """VirtualMachine. - + """ :param agent: :type agent: :class:`TaskAgent ` :param id: @@ -3954,8 +3928,7 @@ def __init__(self, agent=None, id=None, tags=None): class VirtualMachineGroup(EnvironmentResource): - """VirtualMachineGroup. - + """ :param created_by: :type created_by: :class:`IdentityRef ` :param created_on: @@ -3994,8 +3967,7 @@ def __init__(self, created_by=None, created_on=None, environment_reference=None, class VirtualMachineGroupCreateParameters(Model): - """VirtualMachineGroupCreateParameters. - + """ :param name: :type name: str """ @@ -4010,8 +3982,7 @@ def __init__(self, name=None): class DataSourceBinding(DataSourceBindingBase): - """DataSourceBinding. - + """ :param callback_context_template: Pagination format supported by this data source(ContinuationToken/SkipTop). :type callback_context_template: str :param callback_required_template: Subsequent calls needed? @@ -4061,7 +4032,8 @@ def __init__(self, callback_context_template=None, callback_required_template=No class DeploymentGroup(DeploymentGroupReference): - """DeploymentGroup. + """ + Deployment group. :param id: Deployment group identifier. :type id: int @@ -4101,8 +4073,7 @@ def __init__(self, id=None, name=None, pool=None, project=None, description=None class DeploymentMachineGroup(DeploymentMachineGroupReference): - """DeploymentMachineGroup. - + """ :param id: :type id: int :param name: @@ -4133,7 +4104,8 @@ def __init__(self, id=None, name=None, pool=None, project=None, machines=None, s class TaskAgent(TaskAgentReference): - """TaskAgent. + """ + A task agent. :param _links: :type _links: :class:`ReferenceLinks ` @@ -4216,7 +4188,8 @@ def __init__(self, _links=None, access_point=None, enabled=None, id=None, name=N class TaskAgentPool(TaskAgentPoolReference): - """TaskAgentPool. + """ + An organization-level grouping of agents. :param id: :type id: int @@ -4281,8 +4254,7 @@ def __init__(self, id=None, is_hosted=None, is_legacy=None, name=None, pool_type class TaskInputDefinition(TaskInputDefinitionBase): - """TaskInputDefinition. - + """ :param aliases: :type aliases: list of str :param default_value: @@ -4329,8 +4301,7 @@ def __init__(self, aliases=None, default_value=None, group_name=None, help_mark_ class TaskSourceDefinition(TaskSourceDefinitionBase): - """TaskSourceDefinition. - + """ :param auth_key: :type auth_key: str :param endpoint: diff --git a/azure-devops/azure/devops/v5_1/test/models.py b/azure-devops/azure/devops/v5_1/test/models.py index fe20ae87..f13d2145 100644 --- a/azure-devops/azure/devops/v5_1/test/models.py +++ b/azure-devops/azure/devops/v5_1/test/models.py @@ -10,8 +10,7 @@ class AggregatedDataForResultTrend(Model): - """AggregatedDataForResultTrend. - + """ :param duration: This is tests execution duration. :type duration: object :param results_by_outcome: @@ -42,8 +41,7 @@ def __init__(self, duration=None, results_by_outcome=None, run_summary_by_state= class AggregatedResultsAnalysis(Model): - """AggregatedResultsAnalysis. - + """ :param duration: :type duration: object :param not_reported_results_by_outcome: @@ -86,8 +84,7 @@ def __init__(self, duration=None, not_reported_results_by_outcome=None, previous class AggregatedResultsByOutcome(Model): - """AggregatedResultsByOutcome. - + """ :param count: :type count: int :param duration: @@ -122,8 +119,7 @@ def __init__(self, count=None, duration=None, group_by_field=None, group_by_valu class AggregatedResultsDifference(Model): - """AggregatedResultsDifference. - + """ :param increase_in_duration: :type increase_in_duration: object :param increase_in_failures: @@ -154,8 +150,7 @@ def __init__(self, increase_in_duration=None, increase_in_failures=None, increas class AggregatedRunsByOutcome(Model): - """AggregatedRunsByOutcome. - + """ :param outcome: :type outcome: object :param runs_count: @@ -174,8 +169,7 @@ def __init__(self, outcome=None, runs_count=None): class AggregatedRunsByState(Model): - """AggregatedRunsByState. - + """ :param results_by_outcome: :type results_by_outcome: dict :param runs_count: @@ -198,7 +192,8 @@ def __init__(self, results_by_outcome=None, runs_count=None, state=None): class BuildConfiguration(Model): - """BuildConfiguration. + """ + BuildConfiguration Details. :param branch_name: Branch name for which build is generated. :type branch_name: str @@ -270,7 +265,8 @@ def __init__(self, branch_name=None, build_definition_id=None, build_system=None class BuildCoverage(Model): - """BuildCoverage. + """ + Build Coverage Detail :param code_coverage_file_url: Code Coverage File Url :type code_coverage_file_url: str @@ -302,7 +298,8 @@ def __init__(self, code_coverage_file_url=None, configuration=None, last_error=N class BuildReference(Model): - """BuildReference. + """ + Reference to a build. :param branch_name: Branch name. :type branch_name: str @@ -342,7 +339,8 @@ def __init__(self, branch_name=None, build_system=None, definition_id=None, id=N class CloneOperationInformation(Model): - """CloneOperationInformation. + """ + Detail About Clone Operation. :param clone_statistics: Clone Statistics :type clone_statistics: :class:`CloneStatistics ` @@ -410,7 +408,8 @@ def __init__(self, clone_statistics=None, completion_date=None, creation_date=No class CloneOptions(Model): - """CloneOptions. + """ + Clone options for cloning the test suite. :param clone_requirements: If set to true requirements will be cloned :type clone_requirements: bool @@ -446,7 +445,8 @@ def __init__(self, clone_requirements=None, copy_all_suites=None, copy_ancestor_ class CloneStatistics(Model): - """CloneStatistics. + """ + Clone Statistics Details. :param cloned_requirements_count: Number of Requirments cloned so far. :type cloned_requirements_count: int @@ -478,7 +478,8 @@ def __init__(self, cloned_requirements_count=None, cloned_shared_steps_count=Non class CodeCoverageData(Model): - """CodeCoverageData. + """ + Represents the build configuration (platform, flavor) and coverage data for the build :param build_flavor: Flavor of build for which data is retrieved/published :type build_flavor: str @@ -502,7 +503,8 @@ def __init__(self, build_flavor=None, build_platform=None, coverage_stats=None): class CodeCoverageStatistics(Model): - """CodeCoverageStatistics. + """ + Represents the code coverage statistics for a particular coverage label (modules, statements, blocks, etc.) :param covered: Covered units :type covered: int @@ -538,7 +540,8 @@ def __init__(self, covered=None, delta=None, is_delta_available=None, label=None class CodeCoverageSummary(Model): - """CodeCoverageSummary. + """ + Represents the code coverage summary results Used to publish or retrieve code coverage summary against a build :param build: Uri of build for which data is retrieved/published :type build: :class:`ShallowReference ` @@ -566,8 +569,7 @@ def __init__(self, build=None, coverage_data=None, delta_build=None, status=None class CoverageStatistics(Model): - """CoverageStatistics. - + """ :param blocks_covered: :type blocks_covered: int :param blocks_not_covered: @@ -598,7 +600,8 @@ def __init__(self, blocks_covered=None, blocks_not_covered=None, lines_covered=N class CustomTestField(Model): - """CustomTestField. + """ + A custom field information. Allowed Key : Value pairs - ( AttemptId: IntVaue , IsTestResultFlaky: bool) :param field_name: Field Name. :type field_name: str @@ -618,8 +621,7 @@ def __init__(self, field_name=None, value=None): class CustomTestFieldDefinition(Model): - """CustomTestFieldDefinition. - + """ :param field_id: :type field_id: int :param field_name: @@ -646,7 +648,8 @@ def __init__(self, field_id=None, field_name=None, field_type=None, scope=None): class DtlEnvironmentDetails(Model): - """DtlEnvironmentDetails. + """ + This is a temporary class to provide the details for the test run environment. :param csm_content: :type csm_content: str @@ -670,7 +673,8 @@ def __init__(self, csm_content=None, csm_parameters=None, subscription_name=None class FailingSince(Model): - """FailingSince. + """ + Failing since information of a test result. :param build: Build reference since failing. :type build: :class:`BuildReference ` @@ -694,8 +698,7 @@ def __init__(self, build=None, date=None, release=None): class FieldDetailsForTestResults(Model): - """FieldDetailsForTestResults. - + """ :param field_name: Group by field name :type field_name: str :param groups_for_field: Group by field values @@ -714,8 +717,7 @@ def __init__(self, field_name=None, groups_for_field=None): class FunctionCoverage(Model): - """FunctionCoverage. - + """ :param class_: :type class_: str :param name: @@ -746,8 +748,7 @@ def __init__(self, class_=None, name=None, namespace=None, source_file=None, sta class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -774,8 +775,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -834,7 +834,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class JobReference(Model): - """JobReference. + """ + Job in pipeline. This is related to matrixing in YAML. :param attempt: Attempt number of the job :type attempt: int @@ -854,7 +855,8 @@ def __init__(self, attempt=None, job_name=None): class LastResultDetails(Model): - """LastResultDetails. + """ + Last result details of test point. :param date_completed: CompletedDate of LastResult. :type date_completed: datetime @@ -878,8 +880,7 @@ def __init__(self, date_completed=None, duration=None, run_by=None): class LinkedWorkItemsQuery(Model): - """LinkedWorkItemsQuery. - + """ :param automated_test_names: :type automated_test_names: list of str :param plan_id: @@ -914,8 +915,7 @@ def __init__(self, automated_test_names=None, plan_id=None, point_ids=None, suit class LinkedWorkItemsQueryResult(Model): - """LinkedWorkItemsQueryResult. - + """ :param automated_test_name: :type automated_test_name: str :param plan_id: @@ -950,8 +950,7 @@ def __init__(self, automated_test_name=None, plan_id=None, point_id=None, suite_ class ModuleCoverage(Model): - """ModuleCoverage. - + """ :param block_count: :type block_count: int :param block_data: @@ -994,7 +993,8 @@ def __init__(self, block_count=None, block_data=None, file_url=None, functions=N class NameValuePair(Model): - """NameValuePair. + """ + Name value pair :param name: Name :type name: str @@ -1014,7 +1014,8 @@ def __init__(self, name=None, value=None): class PhaseReference(Model): - """PhaseReference. + """ + Phase in pipeline :param attempt: Attempt number of the pahse :type attempt: int @@ -1034,7 +1035,8 @@ def __init__(self, attempt=None, phase_name=None): class PipelineReference(Model): - """PipelineReference. + """ + Pipeline reference :param job_reference: Reference of the job :type job_reference: :class:`JobReference ` @@ -1062,7 +1064,8 @@ def __init__(self, job_reference=None, phase_reference=None, pipeline_id=None, s class PlanUpdateModel(Model): - """PlanUpdateModel. + """ + A model class used for creating and updating test plans. :param area: Area path to which the test plan belongs. This should be set to area path of the team that works on this test plan. :type area: :class:`ShallowReference ` @@ -1146,7 +1149,8 @@ def __init__(self, area=None, automated_test_environment=None, automated_test_se class PointAssignment(Model): - """PointAssignment. + """ + Adding test cases to a suite creates one of more test points based on the default configurations and testers assigned to the test suite. PointAssignment is the list of test points that were created for each of the test cases that were added to the test suite. :param configuration: Configuration that was assigned to the test case. :type configuration: :class:`ShallowReference ` @@ -1166,7 +1170,8 @@ def __init__(self, configuration=None, tester=None): class PointsFilter(Model): - """PointsFilter. + """ + Filter class for test point. :param configuration_names: List of Configurations for filtering. :type configuration_names: list of str @@ -1190,7 +1195,8 @@ def __init__(self, configuration_names=None, testcase_ids=None, testers=None): class PointUpdateModel(Model): - """PointUpdateModel. + """ + Model to update test point. :param outcome: Outcome to update. :type outcome: str @@ -1214,7 +1220,8 @@ def __init__(self, outcome=None, reset_to_active=None, tester=None): class PropertyBag(Model): - """PropertyBag. + """ + The class to represent a Generic store for test session data. :param bag: Generic store for test session data :type bag: dict @@ -1230,8 +1237,7 @@ def __init__(self, bag=None): class QueryModel(Model): - """QueryModel. - + """ :param query: :type query: str """ @@ -1246,7 +1252,8 @@ def __init__(self, query=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -1262,7 +1269,8 @@ def __init__(self, links=None): class ReleaseEnvironmentDefinitionReference(Model): - """ReleaseEnvironmentDefinitionReference. + """ + Reference to release environment resource. :param definition_id: ID of the release definition that contains the release environment definition. :type definition_id: int @@ -1282,7 +1290,8 @@ def __init__(self, definition_id=None, environment_definition_id=None): class ReleaseReference(Model): - """ReleaseReference. + """ + Reference to a release. :param attempt: Number of Release Attempt. :type attempt: int @@ -1334,7 +1343,8 @@ def __init__(self, attempt=None, creation_date=None, definition_id=None, environ class ResultRetentionSettings(Model): - """ResultRetentionSettings. + """ + Test result retention settings :param automated_results_retention_duration: Automated test result retention duration in days :type automated_results_retention_duration: int @@ -1362,8 +1372,7 @@ def __init__(self, automated_results_retention_duration=None, last_updated_by=No class ResultsFilter(Model): - """ResultsFilter. - + """ :param automated_test_name: :type automated_test_name: str :param branch: @@ -1422,7 +1431,8 @@ def __init__(self, automated_test_name=None, branch=None, executed_in=None, grou class RunCreateModel(Model): - """RunCreateModel. + """ + Test run create details. :param automated: true if test run is automated, false otherwise. By default it will be false. :type automated: bool @@ -1578,7 +1588,8 @@ def __init__(self, automated=None, build=None, build_drop_location=None, build_f class RunFilter(Model): - """RunFilter. + """ + This class is used to provide the filters used for discovery :param source_filter: filter for the test case sources (test containers) :type source_filter: str @@ -1598,7 +1609,8 @@ def __init__(self, source_filter=None, test_case_filter=None): class RunStatistic(Model): - """RunStatistic. + """ + Test run statistics per outcome. :param count: Test result count fo the given outcome. :type count: int @@ -1626,7 +1638,8 @@ def __init__(self, count=None, outcome=None, resolution_state=None, state=None): class RunSummaryModel(Model): - """RunSummaryModel. + """ + Run summary for each output type of test. :param duration: Total time taken in milliseconds. :type duration: long @@ -1650,8 +1663,7 @@ def __init__(self, duration=None, result_count=None, test_outcome=None): class RunUpdateModel(Model): - """RunUpdateModel. - + """ :param build: An abstracted reference to the build that it belongs. :type build: :class:`ShallowReference ` :param build_drop_location: Drop location of the build used for test run. @@ -1766,7 +1778,8 @@ def __init__(self, build=None, build_drop_location=None, build_flavor=None, buil class ShallowReference(Model): - """ShallowReference. + """ + An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. :param id: ID of the resource :type id: str @@ -1790,8 +1803,7 @@ def __init__(self, id=None, name=None, url=None): class ShallowTestCaseResult(Model): - """ShallowTestCaseResult. - + """ :param automated_test_name: :type automated_test_name: str :param automated_test_storage: @@ -1850,7 +1862,8 @@ def __init__(self, automated_test_name=None, automated_test_storage=None, durati class SharedStepModel(Model): - """SharedStepModel. + """ + Reference to shared step workitem. :param id: WorkItem shared step ID. :type id: int @@ -1870,7 +1883,8 @@ def __init__(self, id=None, revision=None): class StageReference(Model): - """StageReference. + """ + Stage in pipeline :param attempt: Attempt number of stage :type attempt: int @@ -1890,7 +1904,8 @@ def __init__(self, attempt=None, stage_name=None): class SuiteCreateModel(Model): - """SuiteCreateModel. + """ + Suite create model :param name: Name of test suite. :type name: str @@ -1918,7 +1933,8 @@ def __init__(self, name=None, query_string=None, requirement_ids=None, suite_typ class SuiteEntry(Model): - """SuiteEntry. + """ + A suite entry defines properties for a test suite. :param child_suite_id: Id of child suite in the test suite. :type child_suite_id: int @@ -1946,7 +1962,8 @@ def __init__(self, child_suite_id=None, sequence_number=None, suite_id=None, tes class SuiteEntryUpdateModel(Model): - """SuiteEntryUpdateModel. + """ + A model to define sequence of test suite entries in a test suite. :param child_suite_id: Id of the child suite in the test suite. :type child_suite_id: int @@ -1970,7 +1987,8 @@ def __init__(self, child_suite_id=None, sequence_number=None, test_case_id=None) class SuiteTestCase(Model): - """SuiteTestCase. + """ + Test case for the suite. :param point_assignments: Point Assignment for test suite's test case. :type point_assignments: list of :class:`PointAssignment ` @@ -1990,7 +2008,8 @@ def __init__(self, point_assignments=None, test_case=None): class SuiteTestCaseUpdateModel(Model): - """SuiteTestCaseUpdateModel. + """ + Test suite update model. :param configurations: Shallow reference of configurations for the test cases in the suite. :type configurations: list of :class:`ShallowReference ` @@ -2006,7 +2025,8 @@ def __init__(self, configurations=None): class SuiteUpdateModel(Model): - """SuiteUpdateModel. + """ + Test suite update model. :param default_configurations: Shallow reference of default configurations for the suite. :type default_configurations: list of :class:`ShallowReference ` @@ -2042,7 +2062,8 @@ def __init__(self, default_configurations=None, default_testers=None, inherit_de class TeamContext(Model): - """TeamContext. + """ + The Team Context for an operation. :param project: The team project Id or name. Ignored if ProjectId is set. :type project: str @@ -2070,7 +2091,8 @@ def __init__(self, project=None, project_id=None, team=None, team_id=None): class TeamProjectReference(Model): - """TeamProjectReference. + """ + Represents a shallow reference to a TeamProject. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -2122,8 +2144,7 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class TestAttachment(Model): - """TestAttachment. - + """ :param attachment_type: Attachment type. :type attachment_type: object :param comment: Comment associated with attachment. @@ -2162,7 +2183,8 @@ def __init__(self, attachment_type=None, comment=None, created_date=None, file_n class TestAttachmentReference(Model): - """TestAttachmentReference. + """ + Reference to test attachment. :param id: ID of the attachment. :type id: int @@ -2182,7 +2204,8 @@ def __init__(self, id=None, url=None): class TestAttachmentRequestModel(Model): - """TestAttachmentRequestModel. + """ + Test attachment request model :param attachment_type: Attachment type By Default it will be GeneralAttachment. It can be one of the following type. { GeneralAttachment, AfnStrip, BugFilingData, CodeCoverage, IntermediateCollectorData, RunConfig, TestImpactDetails, TmiTestRunDeploymentFiles, TmiTestRunReverseDeploymentFiles, TmiTestResultDetail, TmiTestRunSummary } :type attachment_type: str @@ -2210,7 +2233,8 @@ def __init__(self, attachment_type=None, comment=None, file_name=None, stream=No class TestCaseResult(Model): - """TestCaseResult. + """ + Represents a test result. :param afn_strip_id: Test attachment ID of action recording. :type afn_strip_id: int @@ -2418,7 +2442,8 @@ def __init__(self, afn_strip_id=None, area=None, associated_bugs=None, automated class TestCaseResultAttachmentModel(Model): - """TestCaseResultAttachmentModel. + """ + Test attachment information in a test iteration. :param action_path: Path identifier test step in test case workitem. :type action_path: str @@ -2454,7 +2479,8 @@ def __init__(self, action_path=None, id=None, iteration_id=None, name=None, size class TestCaseResultIdentifier(Model): - """TestCaseResultIdentifier. + """ + Reference to a test result. :param test_result_id: Test result ID. :type test_result_id: int @@ -2474,8 +2500,7 @@ def __init__(self, test_result_id=None, test_run_id=None): class TestCaseResultUpdateModel(Model): - """TestCaseResultUpdateModel. - + """ :param associated_work_items: :type associated_work_items: list of int :param automated_test_type_id: @@ -2558,7 +2583,8 @@ def __init__(self, associated_work_items=None, automated_test_type_id=None, comm class TestConfiguration(Model): - """TestConfiguration. + """ + Test configuration :param area: Area of the configuration :type area: :class:`ShallowReference ` @@ -2618,7 +2644,8 @@ def __init__(self, area=None, description=None, id=None, is_default=None, last_u class TestEnvironment(Model): - """TestEnvironment. + """ + Test environment Detail. :param environment_id: Test Environment Id. :type environment_id: str @@ -2638,8 +2665,7 @@ def __init__(self, environment_id=None, environment_name=None): class TestFailureDetails(Model): - """TestFailureDetails. - + """ :param count: :type count: int :param test_results: @@ -2658,8 +2684,7 @@ def __init__(self, count=None, test_results=None): class TestFailuresAnalysis(Model): - """TestFailuresAnalysis. - + """ :param existing_failures: :type existing_failures: :class:`TestFailureDetails ` :param fixed_tests: @@ -2686,7 +2711,8 @@ def __init__(self, existing_failures=None, fixed_tests=None, new_failures=None, class TestFlakyIdentifier(Model): - """TestFlakyIdentifier. + """ + Test Flaky Identifier :param branch_name: Branch Name where Flakiness has to be Marked/Unmarked :type branch_name: str @@ -2706,7 +2732,8 @@ def __init__(self, branch_name=None, is_flaky=None): class TestHistoryQuery(Model): - """TestHistoryQuery. + """ + Filter to get TestCase result history. :param automated_test_name: Automated test name of the TestCase. :type automated_test_name: str @@ -2758,7 +2785,8 @@ def __init__(self, automated_test_name=None, branch=None, build_definition_id=No class TestIterationDetailsModel(Model): - """TestIterationDetailsModel. + """ + Represents a test iteration result. :param action_results: Test step results in an iteration. :type action_results: list of :class:`TestActionResultModel ` @@ -2814,7 +2842,8 @@ def __init__(self, action_results=None, attachments=None, comment=None, complete class TestMessageLogDetails(Model): - """TestMessageLogDetails. + """ + An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. :param date_created: Date when the resource is created :type date_created: datetime @@ -2838,8 +2867,7 @@ def __init__(self, date_created=None, entry_id=None, message=None): class TestMethod(Model): - """TestMethod. - + """ :param container: :type container: str :param name: @@ -2858,7 +2886,8 @@ def __init__(self, container=None, name=None): class TestOperationReference(Model): - """TestOperationReference. + """ + Class representing a reference to an operation. :param id: :type id: str @@ -2882,7 +2911,8 @@ def __init__(self, id=None, status=None, url=None): class TestOutcomeSettings(Model): - """TestOutcomeSettings. + """ + Test outcome settings :param sync_outcome_across_suites: Value to configure how test outcomes for the same tests across suites are shown :type sync_outcome_across_suites: bool @@ -2898,7 +2928,8 @@ def __init__(self, sync_outcome_across_suites=None): class TestPlan(Model): - """TestPlan. + """ + The test plan resource. :param area: Area of the test plan. :type area: :class:`ShallowReference ` @@ -3010,8 +3041,7 @@ def __init__(self, area=None, automated_test_environment=None, automated_test_se class TestPlanCloneRequest(Model): - """TestPlanCloneRequest. - + """ :param destination_test_plan: :type destination_test_plan: :class:`TestPlan ` :param options: @@ -3034,7 +3064,8 @@ def __init__(self, destination_test_plan=None, options=None, suite_ids=None): class TestPoint(Model): - """TestPoint. + """ + Test point. :param assigned_to: AssignedTo. Type IdentityRef. :type assigned_to: :class:`IdentityRef ` @@ -3138,7 +3169,8 @@ def __init__(self, assigned_to=None, automated=None, comment=None, configuration class TestPointsQuery(Model): - """TestPointsQuery. + """ + Test point query class. :param order_by: Order by results. :type order_by: str @@ -3166,7 +3198,8 @@ def __init__(self, order_by=None, points=None, points_filter=None, wit_fields=No class TestResolutionState(Model): - """TestResolutionState. + """ + Test Resolution State Details. :param id: Test Resolution state Id. :type id: int @@ -3190,8 +3223,7 @@ def __init__(self, id=None, name=None, project=None): class TestResultCreateModel(Model): - """TestResultCreateModel. - + """ :param area: :type area: :class:`ShallowReference ` :param associated_work_items: @@ -3306,8 +3338,7 @@ def __init__(self, area=None, associated_work_items=None, automated_test_id=None class TestResultDocument(Model): - """TestResultDocument. - + """ :param operation_reference: :type operation_reference: :class:`TestOperationReference ` :param payload: @@ -3326,8 +3357,7 @@ def __init__(self, operation_reference=None, payload=None): class TestResultHistory(Model): - """TestResultHistory. - + """ :param group_by_field: :type group_by_field: str :param results_for_group: @@ -3346,8 +3376,7 @@ def __init__(self, group_by_field=None, results_for_group=None): class TestResultHistoryDetailsForGroup(Model): - """TestResultHistoryDetailsForGroup. - + """ :param group_by_value: :type group_by_value: object :param latest_result: @@ -3366,7 +3395,8 @@ def __init__(self, group_by_value=None, latest_result=None): class TestResultHistoryForGroup(Model): - """TestResultHistoryForGroup. + """ + List of test results filtered on the basis of GroupByValue :param display_name: Display name of the group. :type display_name: str @@ -3390,7 +3420,8 @@ def __init__(self, display_name=None, group_by_value=None, results=None): class TestResultMetaData(Model): - """TestResultMetaData. + """ + Represents a Meta Data of a test result. :param automated_test_name: AutomatedTestName of test result. :type automated_test_name: str @@ -3430,8 +3461,7 @@ def __init__(self, automated_test_name=None, automated_test_storage=None, flaky_ class TestResultModelBase(Model): - """TestResultModelBase. - + """ :param comment: Comment in result. :type comment: str :param completed_date: Time when execution completed. @@ -3466,7 +3496,8 @@ def __init__(self, comment=None, completed_date=None, duration_in_ms=None, error class TestResultParameterModel(Model): - """TestResultParameterModel. + """ + Test parameter information in a test iteration. :param action_path: Test step path where parameter is referenced. :type action_path: str @@ -3502,8 +3533,7 @@ def __init__(self, action_path=None, iteration_id=None, parameter_name=None, ste class TestResultPayload(Model): - """TestResultPayload. - + """ :param comment: :type comment: str :param name: @@ -3526,8 +3556,7 @@ def __init__(self, comment=None, name=None, stream=None): class TestResultsContext(Model): - """TestResultsContext. - + """ :param build: :type build: :class:`BuildReference ` :param context_type: @@ -3550,8 +3579,7 @@ def __init__(self, build=None, context_type=None, release=None): class TestResultsDetails(Model): - """TestResultsDetails. - + """ :param group_by_field: :type group_by_field: str :param results_for_group: @@ -3570,8 +3598,7 @@ def __init__(self, group_by_field=None, results_for_group=None): class TestResultsDetailsForGroup(Model): - """TestResultsDetailsForGroup. - + """ :param group_by_value: :type group_by_value: object :param results: @@ -3598,8 +3625,7 @@ def __init__(self, group_by_value=None, results=None, results_count_by_outcome=N class TestResultsGroupsForBuild(Model): - """TestResultsGroupsForBuild. - + """ :param build_id: BuildId for which groupby result is fetched. :type build_id: int :param fields: The group by results @@ -3618,8 +3644,7 @@ def __init__(self, build_id=None, fields=None): class TestResultsGroupsForRelease(Model): - """TestResultsGroupsForRelease. - + """ :param fields: The group by results :type fields: list of :class:`FieldDetailsForTestResults ` :param release_env_id: Release Environment Id for which groupby result is fetched. @@ -3642,8 +3667,7 @@ def __init__(self, fields=None, release_env_id=None, release_id=None): class TestResultsQuery(Model): - """TestResultsQuery. - + """ :param fields: :type fields: list of str :param results: @@ -3666,8 +3690,7 @@ def __init__(self, fields=None, results=None, results_filter=None): class TestResultSummary(Model): - """TestResultSummary. - + """ :param aggregated_results_analysis: :type aggregated_results_analysis: :class:`AggregatedResultsAnalysis ` :param no_config_runs_count: @@ -3702,8 +3725,7 @@ def __init__(self, aggregated_results_analysis=None, no_config_runs_count=None, class TestResultTrendFilter(Model): - """TestResultTrendFilter. - + """ :param branch_names: :type branch_names: list of str :param build_count: @@ -3746,7 +3768,8 @@ def __init__(self, branch_names=None, build_count=None, definition_ids=None, env class TestRun(Model): - """TestRun. + """ + Test run details. :param build: Build associated with this test run. :type build: :class:`ShallowReference ` @@ -3938,7 +3961,8 @@ def __init__(self, build=None, build_configuration=None, comment=None, completed class TestRunCoverage(Model): - """TestRunCoverage. + """ + Test Run Code Coverage Details :param last_error: Last Error :type last_error: str @@ -3966,7 +3990,8 @@ def __init__(self, last_error=None, modules=None, state=None, test_run=None): class TestRunStatistic(Model): - """TestRunStatistic. + """ + Test run statistics. :param run: :type run: :class:`ShallowReference ` @@ -3986,7 +4011,8 @@ def __init__(self, run=None, run_statistics=None): class TestSession(Model): - """TestSession. + """ + Test Session :param area: Area path of the test session :type area: :class:`ShallowReference ` @@ -4058,7 +4084,8 @@ def __init__(self, area=None, comment=None, end_date=None, id=None, last_updated class TestSettings(Model): - """TestSettings. + """ + Represents the test settings of the run. Used to create test settings and fetch test settings :param area_path: Area path required to create test settings :type area_path: str @@ -4098,7 +4125,8 @@ def __init__(self, area_path=None, description=None, is_public=None, machine_rol class TestSubResult(Model): - """TestSubResult. + """ + Represents a sub result of a test result. :param comment: Comment in sub result. :type comment: str @@ -4186,7 +4214,8 @@ def __init__(self, comment=None, completed_date=None, computer_name=None, config class TestSuite(Model): - """TestSuite. + """ + Test suite :param area_uri: Area uri of the test suite. :type area_uri: str @@ -4294,7 +4323,8 @@ def __init__(self, area_uri=None, children=None, default_configurations=None, de class TestSuiteCloneRequest(Model): - """TestSuiteCloneRequest. + """ + Test suite clone request :param clone_options: Clone options for cloning the test suite. :type clone_options: :class:`CloneOptions ` @@ -4318,8 +4348,7 @@ def __init__(self, clone_options=None, destination_suite_id=None, destination_su class TestSummaryForWorkItem(Model): - """TestSummaryForWorkItem. - + """ :param summary: :type summary: :class:`AggregatedDataForResultTrend ` :param work_item: @@ -4338,7 +4367,8 @@ def __init__(self, summary=None, work_item=None): class TestTag(Model): - """TestTag. + """ + Tag attached to a run or result. :param name: Name of the tag, alphanumeric value less than 30 chars :type name: str @@ -4354,8 +4384,7 @@ def __init__(self, name=None): class TestToWorkItemLinks(Model): - """TestToWorkItemLinks. - + """ :param test: :type test: :class:`TestMethod ` :param work_items: @@ -4374,8 +4403,7 @@ def __init__(self, test=None, work_items=None): class TestVariable(Model): - """TestVariable. - + """ :param description: Description of the test variable :type description: str :param id: Id of the test variable @@ -4414,7 +4442,8 @@ def __init__(self, description=None, id=None, name=None, project=None, revision= class WorkItemReference(Model): - """WorkItemReference. + """ + WorkItem reference Details. :param id: WorkItem Id. :type id: str @@ -4446,8 +4475,7 @@ def __init__(self, id=None, name=None, type=None, url=None, web_url=None): class WorkItemToTestLinks(Model): - """WorkItemToTestLinks. - + """ :param executed_in: :type executed_in: object :param tests: @@ -4470,7 +4498,8 @@ def __init__(self, executed_in=None, tests=None, work_item=None): class TestActionResultModel(TestResultModelBase): - """TestActionResultModel. + """ + Represents a test step result. :param comment: Comment in result. :type comment: str diff --git a/azure-devops/azure/devops/v5_1/test_plan/models.py b/azure-devops/azure/devops/v5_1/test_plan/models.py index 57bab740..bed31f78 100644 --- a/azure-devops/azure/devops/v5_1/test_plan/models.py +++ b/azure-devops/azure/devops/v5_1/test_plan/models.py @@ -10,7 +10,8 @@ class BuildDefinitionReference(Model): - """BuildDefinitionReference. + """ + The build definition reference resource :param id: ID of the build definition :type id: int @@ -30,7 +31,8 @@ def __init__(self, id=None, name=None): class CloneOperationCommonResponse(Model): - """CloneOperationCommonResponse. + """ + Common Response for clone operation :param clone_statistics: Various statistics related to the clone operation :type clone_statistics: :class:`CloneStatistics ` @@ -70,7 +72,8 @@ def __init__(self, clone_statistics=None, completion_date=None, creation_date=No class CloneOptions(Model): - """CloneOptions. + """ + Clone options for cloning the test suite. :param clone_requirements: If set to true requirements will be cloned :type clone_requirements: bool @@ -106,7 +109,8 @@ def __init__(self, clone_requirements=None, copy_all_suites=None, copy_ancestor_ class CloneStatistics(Model): - """CloneStatistics. + """ + Clone Statistics Details. :param cloned_requirements_count: Number of Requirments cloned so far. :type cloned_requirements_count: int @@ -138,7 +142,8 @@ def __init__(self, cloned_requirements_count=None, cloned_shared_steps_count=Non class CloneTestPlanOperationInformation(Model): - """CloneTestPlanOperationInformation. + """ + Response for Test Plan clone operation :param clone_operation_response: Various information related to the clone :type clone_operation_response: :class:`CloneOperationCommonResponse ` @@ -166,7 +171,8 @@ def __init__(self, clone_operation_response=None, clone_options=None, destinatio class CloneTestPlanParams(Model): - """CloneTestPlanParams. + """ + Parameters for Test Plan clone operation :param clone_options: Test Plan Clone create parameters :type clone_options: :class:`CloneOptions ` @@ -190,7 +196,8 @@ def __init__(self, clone_options=None, destination_test_plan=None, source_test_p class CloneTestSuiteOperationInformation(Model): - """CloneTestSuiteOperationInformation. + """ + Response for Test Suite clone operation :param cloned_test_suite: Information of newly cloned Test Suite :type cloned_test_suite: :class:`TestSuiteReferenceWithProject ` @@ -222,7 +229,8 @@ def __init__(self, cloned_test_suite=None, clone_operation_response=None, clone_ class CloneTestSuiteParams(Model): - """CloneTestSuiteParams. + """ + Parameters for Test Suite clone operation :param clone_options: Test Plan Clone create parameters :type clone_options: :class:`CloneOptions ` @@ -246,7 +254,8 @@ def __init__(self, clone_options=None, destination_test_suite=None, source_test_ class Configuration(Model): - """Configuration. + """ + Configuration of the Test Point :param configuration_id: Id of the Configuration Assigned to the Test Point :type configuration_id: int @@ -262,7 +271,8 @@ def __init__(self, configuration_id=None): class DestinationTestSuiteInfo(Model): - """DestinationTestSuiteInfo. + """ + Destination Test Suite information for Test Suite clone operation :param id: Destination Suite Id :type id: int @@ -282,8 +292,7 @@ def __init__(self, id=None, project=None): class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -310,8 +319,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -370,7 +378,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class LastResultDetails(Model): - """LastResultDetails. + """ + Last result details of test point. :param date_completed: CompletedDate of LastResult. :type date_completed: datetime @@ -394,7 +403,8 @@ def __init__(self, date_completed=None, duration=None, run_by=None): class NameValuePair(Model): - """NameValuePair. + """ + Name value pair :param name: Name :type name: str @@ -414,7 +424,8 @@ def __init__(self, name=None, value=None): class PointAssignment(Configuration): - """PointAssignment. + """ + Assignments for the Test Point :param configuration_id: Id of the Configuration Assigned to the Test Point :type configuration_id: int @@ -441,7 +452,8 @@ def __init__(self, configuration_id=None, configuration_name=None, id=None, test class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -457,7 +469,8 @@ def __init__(self, links=None): class ReleaseEnvironmentDefinitionReference(Model): - """ReleaseEnvironmentDefinitionReference. + """ + Reference to release environment resource. :param definition_id: ID of the release definition that contains the release environment definition. :type definition_id: int @@ -477,7 +490,8 @@ def __init__(self, definition_id=None, environment_definition_id=None): class Results(Model): - """Results. + """ + Results class for Test Point :param outcome: Outcome of the Test Point :type outcome: object @@ -493,7 +507,8 @@ def __init__(self, outcome=None): class SourceTestPlanInfo(Model): - """SourceTestPlanInfo. + """ + Source Test Plan information for Test Plan clone operation :param id: ID of the source Test Plan :type id: int @@ -513,7 +528,8 @@ def __init__(self, id=None, suite_ids=None): class SourceTestSuiteInfo(Model): - """SourceTestSuiteInfo. + """ + Source Test Suite information for Test Suite clone operation :param id: Id of the Source Test Suite :type id: int @@ -529,7 +545,8 @@ def __init__(self, id=None): class SuiteEntryUpdateParams(Model): - """SuiteEntryUpdateParams. + """ + A suite entry defines properties for a test suite. :param id: Id of the suite entry in the test suite: either a test case id or child suite id. :type id: int @@ -553,7 +570,8 @@ def __init__(self, id=None, sequence_number=None, suite_entry_type=None): class SuiteTestCaseCreateUpdateParameters(Model): - """SuiteTestCaseCreateUpdateParameters. + """ + Create and Update Suite Test Case Parameters :param point_assignments: Configurations Ids :type point_assignments: list of :class:`Configuration ` @@ -573,7 +591,8 @@ def __init__(self, point_assignments=None, work_item=None): class TeamProjectReference(Model): - """TeamProjectReference. + """ + Represents a shallow reference to a TeamProject. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -625,7 +644,8 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class TestCase(Model): - """TestCase. + """ + Test Case Class :param links: Reference links :type links: :class:`ReferenceLinks ` @@ -665,7 +685,8 @@ def __init__(self, links=None, order=None, point_assignments=None, project=None, class TestCaseReference(Model): - """TestCaseReference. + """ + Test Case Reference :param assigned_to: Identity to whom the test case is assigned :type assigned_to: :class:`IdentityRef ` @@ -693,7 +714,8 @@ def __init__(self, assigned_to=None, id=None, name=None, state=None): class TestConfigurationCreateUpdateParameters(Model): - """TestConfigurationCreateUpdateParameters. + """ + Test Configuration Create or Update Parameters :param description: Description of the configuration :type description: str @@ -725,7 +747,8 @@ def __init__(self, description=None, is_default=None, name=None, state=None, val class TestConfigurationReference(Model): - """TestConfigurationReference. + """ + Test Configuration Reference :param id: Id of the configuration :type id: int @@ -745,7 +768,8 @@ def __init__(self, id=None, name=None): class TestEnvironment(Model): - """TestEnvironment. + """ + Test environment Detail. :param environment_id: Test Environment Id. :type environment_id: str @@ -765,7 +789,8 @@ def __init__(self, environment_id=None, environment_name=None): class TestOutcomeSettings(Model): - """TestOutcomeSettings. + """ + Test outcome settings :param sync_outcome_across_suites: Value to configure how test outcomes for the same tests across suites are shown :type sync_outcome_across_suites: bool @@ -781,7 +806,8 @@ def __init__(self, sync_outcome_across_suites=None): class TestPlanCreateParams(Model): - """TestPlanCreateParams. + """ + The test plan cerate parameters. :param area_path: Area of the test plan. :type area_path: str @@ -857,7 +883,8 @@ def __init__(self, area_path=None, automated_test_environment=None, automated_te class TestPlanReference(Model): - """TestPlanReference. + """ + The test plan reference resource. :param id: ID of the test plan. :type id: int @@ -877,7 +904,8 @@ def __init__(self, id=None, name=None): class TestPlansHubRefreshData(Model): - """TestPlansHubRefreshData. + """ + This data model is used in TestPlansHubRefreshDataProvider and populates the data required for initial page load :param is_advanced_extension_enabled: :type is_advanced_extension_enabled: bool @@ -937,7 +965,8 @@ def __init__(self, is_advanced_extension_enabled=None, selected_suite_id=None, s class TestPlanUpdateParams(TestPlanCreateParams): - """TestPlanUpdateParams. + """ + The test plan update parameters. :param area_path: Area of the test plan. :type area_path: str @@ -1001,7 +1030,8 @@ def __init__(self, area_path=None, automated_test_environment=None, automated_te class TestPoint(Model): - """TestPoint. + """ + Test Point Class :param comment: Comment associated to the Test Point :type comment: str @@ -1073,7 +1103,8 @@ def __init__(self, comment=None, configuration=None, id=None, is_active=None, is class TestPointCount(Model): - """TestPointCount. + """ + Test Point Count :param count: Test Point Count :type count: int @@ -1097,7 +1128,8 @@ def __init__(self, count=None, test_plan_id=None, test_suite_id=None): class TestPointResults(Model): - """TestPointResults. + """ + Test Point Results :param failure_type: Failure Type for the Test Point :type failure_type: object @@ -1145,7 +1177,8 @@ def __init__(self, failure_type=None, last_resolution_state=None, last_result_de class TestPointUpdateParams(Model): - """TestPointUpdateParams. + """ + Test Point Update Parameters :param id: Id of Test Point to be updated :type id: int @@ -1173,7 +1206,8 @@ def __init__(self, id=None, is_active=None, results=None, tester=None): class TestSettings(Model): - """TestSettings. + """ + Represents the test settings of the run. Used to create test settings and fetch test settings :param area_path: Area path required to create test settings :type area_path: str @@ -1213,7 +1247,8 @@ def __init__(self, area_path=None, description=None, is_public=None, machine_rol class TestSuiteCreateUpdateCommonParams(Model): - """TestSuiteCreateUpdateCommonParams. + """ + Test Suite Create/Update Common Parameters :param default_configurations: Test suite default configurations. :type default_configurations: list of :class:`TestConfigurationReference ` @@ -1249,7 +1284,8 @@ def __init__(self, default_configurations=None, default_testers=None, inherit_de class TestSuiteReference(Model): - """TestSuiteReference. + """ + The test suite reference resource. :param id: ID of the test suite. :type id: int @@ -1269,7 +1305,8 @@ def __init__(self, id=None, name=None): class TestSuiteReferenceWithProject(TestSuiteReference): - """TestSuiteReferenceWithProject. + """ + Test Suite Reference with Project :param id: ID of the test suite. :type id: int @@ -1291,7 +1328,8 @@ def __init__(self, id=None, name=None, project=None): class TestSuiteUpdateParams(TestSuiteCreateUpdateCommonParams): - """TestSuiteUpdateParams. + """ + Test Suite Update Parameters :param default_configurations: Test suite default configurations. :type default_configurations: list of :class:`TestConfigurationReference ` @@ -1325,7 +1363,8 @@ def __init__(self, default_configurations=None, default_testers=None, inherit_de class TestVariableCreateUpdateParameters(Model): - """TestVariableCreateUpdateParameters. + """ + Test Variable Create or Update Parameters :param description: Description of the test variable :type description: str @@ -1349,7 +1388,8 @@ def __init__(self, description=None, name=None, values=None): class WorkItem(Model): - """WorkItem. + """ + Work Item :param id: Id of the Work Item :type id: int @@ -1365,7 +1405,8 @@ def __init__(self, id=None): class WorkItemDetails(Model): - """WorkItemDetails. + """ + Work Item Class :param id: Work Item Id :type id: int @@ -1389,7 +1430,8 @@ def __init__(self, id=None, name=None, work_item_fields=None): class DestinationTestPlanCloneParams(TestPlanCreateParams): - """DestinationTestPlanCloneParams. + """ + Destination Test Plan create parameters :param area_path: Area of the test plan. :type area_path: str @@ -1453,7 +1495,8 @@ def __init__(self, area_path=None, automated_test_environment=None, automated_te class SourceTestplanResponse(TestPlanReference): - """SourceTestplanResponse. + """ + Source Test Plan Response for Test Plan clone operation :param id: ID of the test plan. :type id: int @@ -1479,7 +1522,8 @@ def __init__(self, id=None, name=None, project=None, suite_ids=None): class SuiteEntry(SuiteEntryUpdateParams): - """SuiteEntry. + """ + A suite entry defines properties for a test suite. :param id: Id of the suite entry in the test suite: either a test case id or child suite id. :type id: int @@ -1504,7 +1548,8 @@ def __init__(self, id=None, sequence_number=None, suite_entry_type=None, suite_i class TestConfiguration(TestConfigurationCreateUpdateParameters): - """TestConfiguration. + """ + Test configuration :param description: Description of the configuration :type description: str @@ -1539,7 +1584,8 @@ def __init__(self, description=None, is_default=None, name=None, state=None, val class TestPlan(TestPlanUpdateParams): - """TestPlan. + """ + The test plan resource. :param area_path: Area of the test plan. :type area_path: str @@ -1630,7 +1676,8 @@ def __init__(self, area_path=None, automated_test_environment=None, automated_te class TestPlanDetailedReference(TestPlanReference): - """TestPlanDetailedReference. + """ + The test plan detailed reference resource. Contains additional workitem realted information :param id: ID of the test plan. :type id: int @@ -1668,7 +1715,8 @@ def __init__(self, id=None, name=None, area_path=None, end_date=None, iteration= class TestSuiteCreateParams(TestSuiteCreateUpdateCommonParams): - """TestSuiteCreateParams. + """ + Test suite Create Parameters :param default_configurations: Test suite default configurations. :type default_configurations: list of :class:`TestConfigurationReference ` @@ -1706,7 +1754,8 @@ def __init__(self, default_configurations=None, default_testers=None, inherit_de class TestVariable(TestVariableCreateUpdateParameters): - """TestVariable. + """ + Test Variable :param description: Description of the test variable :type description: str @@ -1735,7 +1784,8 @@ def __init__(self, description=None, name=None, values=None, id=None, project=No class TestSuite(TestSuiteCreateParams): - """TestSuite. + """ + Test suite :param default_configurations: Test suite default configurations. :type default_configurations: list of :class:`TestConfigurationReference ` diff --git a/azure-devops/azure/devops/v5_1/test_results/models.py b/azure-devops/azure/devops/v5_1/test_results/models.py index f0fc9a4f..fb91fb24 100644 --- a/azure-devops/azure/devops/v5_1/test_results/models.py +++ b/azure-devops/azure/devops/v5_1/test_results/models.py @@ -10,8 +10,7 @@ class AggregatedDataForResultTrend(Model): - """AggregatedDataForResultTrend. - + """ :param duration: This is tests execution duration. :type duration: object :param results_by_outcome: @@ -42,8 +41,7 @@ def __init__(self, duration=None, results_by_outcome=None, run_summary_by_state= class AggregatedResultsAnalysis(Model): - """AggregatedResultsAnalysis. - + """ :param duration: :type duration: object :param not_reported_results_by_outcome: @@ -86,8 +84,7 @@ def __init__(self, duration=None, not_reported_results_by_outcome=None, previous class AggregatedResultsByOutcome(Model): - """AggregatedResultsByOutcome. - + """ :param count: :type count: int :param duration: @@ -122,8 +119,7 @@ def __init__(self, count=None, duration=None, group_by_field=None, group_by_valu class AggregatedResultsDifference(Model): - """AggregatedResultsDifference. - + """ :param increase_in_duration: :type increase_in_duration: object :param increase_in_failures: @@ -154,8 +150,7 @@ def __init__(self, increase_in_duration=None, increase_in_failures=None, increas class AggregatedRunsByOutcome(Model): - """AggregatedRunsByOutcome. - + """ :param outcome: :type outcome: object :param runs_count: @@ -174,8 +169,7 @@ def __init__(self, outcome=None, runs_count=None): class AggregatedRunsByState(Model): - """AggregatedRunsByState. - + """ :param results_by_outcome: :type results_by_outcome: dict :param runs_count: @@ -198,7 +192,8 @@ def __init__(self, results_by_outcome=None, runs_count=None, state=None): class BuildConfiguration(Model): - """BuildConfiguration. + """ + BuildConfiguration Details. :param branch_name: Branch name for which build is generated. :type branch_name: str @@ -270,7 +265,8 @@ def __init__(self, branch_name=None, build_definition_id=None, build_system=None class BuildCoverage(Model): - """BuildCoverage. + """ + Build Coverage Detail :param code_coverage_file_url: Code Coverage File Url :type code_coverage_file_url: str @@ -302,7 +298,8 @@ def __init__(self, code_coverage_file_url=None, configuration=None, last_error=N class BuildReference(Model): - """BuildReference. + """ + Reference to a build. :param branch_name: Branch name. :type branch_name: str @@ -342,7 +339,8 @@ def __init__(self, branch_name=None, build_system=None, definition_id=None, id=N class CodeCoverageData(Model): - """CodeCoverageData. + """ + Represents the build configuration (platform, flavor) and coverage data for the build :param build_flavor: Flavor of build for which data is retrieved/published :type build_flavor: str @@ -366,7 +364,8 @@ def __init__(self, build_flavor=None, build_platform=None, coverage_stats=None): class CodeCoverageStatistics(Model): - """CodeCoverageStatistics. + """ + Represents the code coverage statistics for a particular coverage label (modules, statements, blocks, etc.) :param covered: Covered units :type covered: int @@ -402,7 +401,8 @@ def __init__(self, covered=None, delta=None, is_delta_available=None, label=None class CodeCoverageSummary(Model): - """CodeCoverageSummary. + """ + Represents the code coverage summary results Used to publish or retrieve code coverage summary against a build :param build: Uri of build for which data is retrieved/published :type build: :class:`ShallowReference ` @@ -430,8 +430,7 @@ def __init__(self, build=None, coverage_data=None, delta_build=None, status=None class CoverageStatistics(Model): - """CoverageStatistics. - + """ :param blocks_covered: :type blocks_covered: int :param blocks_not_covered: @@ -462,7 +461,8 @@ def __init__(self, blocks_covered=None, blocks_not_covered=None, lines_covered=N class CustomTestField(Model): - """CustomTestField. + """ + A custom field information. Allowed Key : Value pairs - ( AttemptId: IntVaue , IsTestResultFlaky: bool) :param field_name: Field Name. :type field_name: str @@ -482,7 +482,8 @@ def __init__(self, field_name=None, value=None): class DtlEnvironmentDetails(Model): - """DtlEnvironmentDetails. + """ + This is a temporary class to provide the details for the test run environment. :param csm_content: :type csm_content: str @@ -506,7 +507,8 @@ def __init__(self, csm_content=None, csm_parameters=None, subscription_name=None class FailingSince(Model): - """FailingSince. + """ + Failing since information of a test result. :param build: Build reference since failing. :type build: :class:`BuildReference ` @@ -530,8 +532,7 @@ def __init__(self, build=None, date=None, release=None): class FieldDetailsForTestResults(Model): - """FieldDetailsForTestResults. - + """ :param field_name: Group by field name :type field_name: str :param groups_for_field: Group by field values @@ -550,8 +551,7 @@ def __init__(self, field_name=None, groups_for_field=None): class FileCoverageRequest(Model): - """FileCoverageRequest. - + """ :param file_path: :type file_path: str :param pull_request_base_iteration_id: @@ -582,8 +582,7 @@ def __init__(self, file_path=None, pull_request_base_iteration_id=None, pull_req class FlakyDetection(Model): - """FlakyDetection. - + """ :param flaky_detection_pipelines: FlakyDetectionPipelines defines Pipelines for Detection. :type flaky_detection_pipelines: :class:`FlakyDetectionPipelines ` :param flaky_detection_type: FlakyDetectionType defines Detection type i.e. 1. System or 2. Manual. @@ -602,8 +601,7 @@ def __init__(self, flaky_detection_pipelines=None, flaky_detection_type=None): class FlakyDetectionPipelines(Model): - """FlakyDetectionPipelines. - + """ :param allowed_pipelines: AllowedPipelines - List All Pipelines allowed for detection. :type allowed_pipelines: list of int :param is_all_pipelines_allowed: IsAllPipelinesAllowed if users configure all system's pipelines. @@ -622,8 +620,7 @@ def __init__(self, allowed_pipelines=None, is_all_pipelines_allowed=None): class FlakySettings(Model): - """FlakySettings. - + """ :param flaky_detection: FlakyDetection defines types of detection. :type flaky_detection: :class:`FlakyDetection ` :param flaky_in_summary_report: FlakyInSummaryReport defines flaky data should show in summary report or not. @@ -646,8 +643,7 @@ def __init__(self, flaky_detection=None, flaky_in_summary_report=None, manual_ma class FunctionCoverage(Model): - """FunctionCoverage. - + """ :param class_: :type class_: str :param name: @@ -678,7 +674,8 @@ def __init__(self, class_=None, name=None, namespace=None, source_file=None, sta class JobReference(Model): - """JobReference. + """ + Job in pipeline. This is related to matrixing in YAML. :param attempt: Attempt number of the job :type attempt: int @@ -698,8 +695,7 @@ def __init__(self, attempt=None, job_name=None): class ModuleCoverage(Model): - """ModuleCoverage. - + """ :param block_count: :type block_count: int :param block_data: @@ -742,7 +738,8 @@ def __init__(self, block_count=None, block_data=None, file_url=None, functions=N class PhaseReference(Model): - """PhaseReference. + """ + Phase in pipeline :param attempt: Attempt number of the pahse :type attempt: int @@ -762,7 +759,8 @@ def __init__(self, attempt=None, phase_name=None): class PipelineReference(Model): - """PipelineReference. + """ + Pipeline reference :param job_reference: Reference of the job :type job_reference: :class:`JobReference ` @@ -790,8 +788,7 @@ def __init__(self, job_reference=None, phase_reference=None, pipeline_id=None, s class QueryModel(Model): - """QueryModel. - + """ :param query: :type query: str """ @@ -806,7 +803,8 @@ def __init__(self, query=None): class ReleaseReference(Model): - """ReleaseReference. + """ + Reference to a release. :param attempt: Number of Release Attempt. :type attempt: int @@ -858,8 +856,7 @@ def __init__(self, attempt=None, creation_date=None, definition_id=None, environ class ResultsFilter(Model): - """ResultsFilter. - + """ :param automated_test_name: :type automated_test_name: str :param branch: @@ -918,7 +915,8 @@ def __init__(self, automated_test_name=None, branch=None, executed_in=None, grou class RunCreateModel(Model): - """RunCreateModel. + """ + Test run create details. :param automated: true if test run is automated, false otherwise. By default it will be false. :type automated: bool @@ -1074,7 +1072,8 @@ def __init__(self, automated=None, build=None, build_drop_location=None, build_f class RunFilter(Model): - """RunFilter. + """ + This class is used to provide the filters used for discovery :param source_filter: filter for the test case sources (test containers) :type source_filter: str @@ -1094,7 +1093,8 @@ def __init__(self, source_filter=None, test_case_filter=None): class RunStatistic(Model): - """RunStatistic. + """ + Test run statistics per outcome. :param count: Test result count fo the given outcome. :type count: int @@ -1122,7 +1122,8 @@ def __init__(self, count=None, outcome=None, resolution_state=None, state=None): class RunSummaryModel(Model): - """RunSummaryModel. + """ + Run summary for each output type of test. :param duration: Total time taken in milliseconds. :type duration: long @@ -1146,8 +1147,7 @@ def __init__(self, duration=None, result_count=None, test_outcome=None): class RunUpdateModel(Model): - """RunUpdateModel. - + """ :param build: An abstracted reference to the build that it belongs. :type build: :class:`ShallowReference ` :param build_drop_location: Drop location of the build used for test run. @@ -1262,7 +1262,8 @@ def __init__(self, build=None, build_drop_location=None, build_flavor=None, buil class ShallowReference(Model): - """ShallowReference. + """ + An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. :param id: ID of the resource :type id: str @@ -1286,8 +1287,7 @@ def __init__(self, id=None, name=None, url=None): class ShallowTestCaseResult(Model): - """ShallowTestCaseResult. - + """ :param automated_test_name: :type automated_test_name: str :param automated_test_storage: @@ -1346,7 +1346,8 @@ def __init__(self, automated_test_name=None, automated_test_storage=None, durati class SharedStepModel(Model): - """SharedStepModel. + """ + Reference to shared step workitem. :param id: WorkItem shared step ID. :type id: int @@ -1366,7 +1367,8 @@ def __init__(self, id=None, revision=None): class StageReference(Model): - """StageReference. + """ + Stage in pipeline :param attempt: Attempt number of stage :type attempt: int @@ -1386,8 +1388,7 @@ def __init__(self, attempt=None, stage_name=None): class TestAttachment(Model): - """TestAttachment. - + """ :param attachment_type: Attachment type. :type attachment_type: object :param comment: Comment associated with attachment. @@ -1426,7 +1427,8 @@ def __init__(self, attachment_type=None, comment=None, created_date=None, file_n class TestAttachmentReference(Model): - """TestAttachmentReference. + """ + Reference to test attachment. :param id: ID of the attachment. :type id: int @@ -1446,7 +1448,8 @@ def __init__(self, id=None, url=None): class TestAttachmentRequestModel(Model): - """TestAttachmentRequestModel. + """ + Test attachment request model :param attachment_type: Attachment type By Default it will be GeneralAttachment. It can be one of the following type. { GeneralAttachment, AfnStrip, BugFilingData, CodeCoverage, IntermediateCollectorData, RunConfig, TestImpactDetails, TmiTestRunDeploymentFiles, TmiTestRunReverseDeploymentFiles, TmiTestResultDetail, TmiTestRunSummary } :type attachment_type: str @@ -1474,7 +1477,8 @@ def __init__(self, attachment_type=None, comment=None, file_name=None, stream=No class TestCaseResult(Model): - """TestCaseResult. + """ + Represents a test result. :param afn_strip_id: Test attachment ID of action recording. :type afn_strip_id: int @@ -1682,7 +1686,8 @@ def __init__(self, afn_strip_id=None, area=None, associated_bugs=None, automated class TestCaseResultAttachmentModel(Model): - """TestCaseResultAttachmentModel. + """ + Test attachment information in a test iteration. :param action_path: Path identifier test step in test case workitem. :type action_path: str @@ -1718,7 +1723,8 @@ def __init__(self, action_path=None, id=None, iteration_id=None, name=None, size class TestCaseResultIdentifier(Model): - """TestCaseResultIdentifier. + """ + Reference to a test result. :param test_result_id: Test result ID. :type test_result_id: int @@ -1738,7 +1744,8 @@ def __init__(self, test_result_id=None, test_run_id=None): class TestEnvironment(Model): - """TestEnvironment. + """ + Test environment Detail. :param environment_id: Test Environment Id. :type environment_id: str @@ -1758,8 +1765,7 @@ def __init__(self, environment_id=None, environment_name=None): class TestFailureDetails(Model): - """TestFailureDetails. - + """ :param count: :type count: int :param test_results: @@ -1778,8 +1784,7 @@ def __init__(self, count=None, test_results=None): class TestFailuresAnalysis(Model): - """TestFailuresAnalysis. - + """ :param existing_failures: :type existing_failures: :class:`TestFailureDetails ` :param fixed_tests: @@ -1806,7 +1811,8 @@ def __init__(self, existing_failures=None, fixed_tests=None, new_failures=None, class TestFlakyIdentifier(Model): - """TestFlakyIdentifier. + """ + Test Flaky Identifier :param branch_name: Branch Name where Flakiness has to be Marked/Unmarked :type branch_name: str @@ -1826,7 +1832,8 @@ def __init__(self, branch_name=None, is_flaky=None): class TestHistoryQuery(Model): - """TestHistoryQuery. + """ + Filter to get TestCase result history. :param automated_test_name: Automated test name of the TestCase. :type automated_test_name: str @@ -1878,7 +1885,8 @@ def __init__(self, automated_test_name=None, branch=None, build_definition_id=No class TestIterationDetailsModel(Model): - """TestIterationDetailsModel. + """ + Represents a test iteration result. :param action_results: Test step results in an iteration. :type action_results: list of :class:`TestActionResultModel ` @@ -1934,7 +1942,8 @@ def __init__(self, action_results=None, attachments=None, comment=None, complete class TestLog(Model): - """TestLog. + """ + Represents Test Log Result object. :param log_reference: Test Log Context run, build :type log_reference: :class:`TestLogReference ` @@ -1962,8 +1971,7 @@ def __init__(self, log_reference=None, meta_data=None, modified_on=None, size=No class TestLogReference(Model): - """TestLogReference. - + """ :param build_id: BuildId for test log, if context is build :type build_id: int :param file_path: FileName for log file @@ -2010,7 +2018,8 @@ def __init__(self, build_id=None, file_path=None, release_env_id=None, release_i class TestLogStoreEndpointDetails(Model): - """TestLogStoreEndpointDetails. + """ + Represents Test Log store endpoint details. :param endpoint_sASUri: Test log store connection Uri. :type endpoint_sASUri: str @@ -2034,7 +2043,8 @@ def __init__(self, endpoint_sASUri=None, endpoint_type=None, status=None): class TestMessageLogDetails(Model): - """TestMessageLogDetails. + """ + An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links. :param date_created: Date when the resource is created :type date_created: datetime @@ -2058,8 +2068,7 @@ def __init__(self, date_created=None, entry_id=None, message=None): class TestMethod(Model): - """TestMethod. - + """ :param container: :type container: str :param name: @@ -2078,7 +2087,8 @@ def __init__(self, container=None, name=None): class TestOperationReference(Model): - """TestOperationReference. + """ + Class representing a reference to an operation. :param id: :type id: str @@ -2102,7 +2112,8 @@ def __init__(self, id=None, status=None, url=None): class TestResolutionState(Model): - """TestResolutionState. + """ + Test Resolution State Details. :param id: Test Resolution state Id. :type id: int @@ -2126,8 +2137,7 @@ def __init__(self, id=None, name=None, project=None): class TestResultDocument(Model): - """TestResultDocument. - + """ :param operation_reference: :type operation_reference: :class:`TestOperationReference ` :param payload: @@ -2146,8 +2156,7 @@ def __init__(self, operation_reference=None, payload=None): class TestResultHistory(Model): - """TestResultHistory. - + """ :param group_by_field: :type group_by_field: str :param results_for_group: @@ -2166,8 +2175,7 @@ def __init__(self, group_by_field=None, results_for_group=None): class TestResultHistoryDetailsForGroup(Model): - """TestResultHistoryDetailsForGroup. - + """ :param group_by_value: :type group_by_value: object :param latest_result: @@ -2186,7 +2194,8 @@ def __init__(self, group_by_value=None, latest_result=None): class TestResultHistoryForGroup(Model): - """TestResultHistoryForGroup. + """ + List of test results filtered on the basis of GroupByValue :param display_name: Display name of the group. :type display_name: str @@ -2210,7 +2219,8 @@ def __init__(self, display_name=None, group_by_value=None, results=None): class TestResultMetaData(Model): - """TestResultMetaData. + """ + Represents a Meta Data of a test result. :param automated_test_name: AutomatedTestName of test result. :type automated_test_name: str @@ -2250,7 +2260,8 @@ def __init__(self, automated_test_name=None, automated_test_storage=None, flaky_ class TestResultMetaDataUpdateInput(Model): - """TestResultMetaDataUpdateInput. + """ + Represents a TestResultMetaData Input :param flaky_identifiers: List of Flaky Identifiers :type flaky_identifiers: list of :class:`TestFlakyIdentifier ` @@ -2266,8 +2277,7 @@ def __init__(self, flaky_identifiers=None): class TestResultModelBase(Model): - """TestResultModelBase. - + """ :param comment: Comment in result. :type comment: str :param completed_date: Time when execution completed. @@ -2302,7 +2312,8 @@ def __init__(self, comment=None, completed_date=None, duration_in_ms=None, error class TestResultParameterModel(Model): - """TestResultParameterModel. + """ + Test parameter information in a test iteration. :param action_path: Test step path where parameter is referenced. :type action_path: str @@ -2338,8 +2349,7 @@ def __init__(self, action_path=None, iteration_id=None, parameter_name=None, ste class TestResultPayload(Model): - """TestResultPayload. - + """ :param comment: :type comment: str :param name: @@ -2362,8 +2372,7 @@ def __init__(self, comment=None, name=None, stream=None): class TestResultsContext(Model): - """TestResultsContext. - + """ :param build: :type build: :class:`BuildReference ` :param context_type: @@ -2386,8 +2395,7 @@ def __init__(self, build=None, context_type=None, release=None): class TestResultsDetails(Model): - """TestResultsDetails. - + """ :param group_by_field: :type group_by_field: str :param results_for_group: @@ -2406,8 +2414,7 @@ def __init__(self, group_by_field=None, results_for_group=None): class TestResultsDetailsForGroup(Model): - """TestResultsDetailsForGroup. - + """ :param group_by_value: :type group_by_value: object :param results: @@ -2434,8 +2441,7 @@ def __init__(self, group_by_value=None, results=None, results_count_by_outcome=N class TestResultsQuery(Model): - """TestResultsQuery. - + """ :param fields: :type fields: list of str :param results: @@ -2458,8 +2464,7 @@ def __init__(self, fields=None, results=None, results_filter=None): class TestResultsSettings(Model): - """TestResultsSettings. - + """ :param flaky_settings: IsRequired and EmitDefaultValue are passed as false as if users doesn't pass anything, should not come for serialisation and deserialisation. :type flaky_settings: :class:`FlakySettings ` """ @@ -2474,8 +2479,7 @@ def __init__(self, flaky_settings=None): class TestResultSummary(Model): - """TestResultSummary. - + """ :param aggregated_results_analysis: :type aggregated_results_analysis: :class:`AggregatedResultsAnalysis ` :param no_config_runs_count: @@ -2510,8 +2514,7 @@ def __init__(self, aggregated_results_analysis=None, no_config_runs_count=None, class TestResultsUpdateSettings(Model): - """TestResultsUpdateSettings. - + """ :param flaky_settings: FlakySettings defines Flaky Setttings Data. :type flaky_settings: :class:`FlakySettings ` """ @@ -2526,8 +2529,7 @@ def __init__(self, flaky_settings=None): class TestResultTrendFilter(Model): - """TestResultTrendFilter. - + """ :param branch_names: :type branch_names: list of str :param build_count: @@ -2570,7 +2572,8 @@ def __init__(self, branch_names=None, build_count=None, definition_ids=None, env class TestRun(Model): - """TestRun. + """ + Test run details. :param build: Build associated with this test run. :type build: :class:`ShallowReference ` @@ -2762,7 +2765,8 @@ def __init__(self, build=None, build_configuration=None, comment=None, completed class TestRunCoverage(Model): - """TestRunCoverage. + """ + Test Run Code Coverage Details :param last_error: Last Error :type last_error: str @@ -2790,7 +2794,8 @@ def __init__(self, last_error=None, modules=None, state=None, test_run=None): class TestRunStatistic(Model): - """TestRunStatistic. + """ + Test run statistics. :param run: :type run: :class:`ShallowReference ` @@ -2810,7 +2815,8 @@ def __init__(self, run=None, run_statistics=None): class TestSettings(Model): - """TestSettings. + """ + Represents the test settings of the run. Used to create test settings and fetch test settings :param area_path: Area path required to create test settings :type area_path: str @@ -2850,7 +2856,8 @@ def __init__(self, area_path=None, description=None, is_public=None, machine_rol class TestSubResult(Model): - """TestSubResult. + """ + Represents a sub result of a test result. :param comment: Comment in sub result. :type comment: str @@ -2938,8 +2945,7 @@ def __init__(self, comment=None, completed_date=None, computer_name=None, config class TestSummaryForWorkItem(Model): - """TestSummaryForWorkItem. - + """ :param summary: :type summary: :class:`AggregatedDataForResultTrend ` :param work_item: @@ -2958,7 +2964,8 @@ def __init__(self, summary=None, work_item=None): class TestTag(Model): - """TestTag. + """ + Tag attached to a run or result. :param name: Name of the tag, alphanumeric value less than 30 chars :type name: str @@ -2974,7 +2981,8 @@ def __init__(self, name=None): class TestTagSummary(Model): - """TestTagSummary. + """ + Test tag summary for build or release grouped by test run. :param tags_group_by_test_artifact: Dictionary which contains tags associated with a test run. :type tags_group_by_test_artifact: dict @@ -2990,7 +2998,8 @@ def __init__(self, tags_group_by_test_artifact=None): class TestTagsUpdateModel(Model): - """TestTagsUpdateModel. + """ + Tags to update to a run or result. :param tags: :type tags: list of { key: OperationType; value: [TestTag] } @@ -3006,8 +3015,7 @@ def __init__(self, tags=None): class TestToWorkItemLinks(Model): - """TestToWorkItemLinks. - + """ :param test: :type test: :class:`TestMethod ` :param work_items: @@ -3026,7 +3034,8 @@ def __init__(self, test=None, work_items=None): class WorkItemReference(Model): - """WorkItemReference. + """ + WorkItem reference Details. :param id: WorkItem Id. :type id: str @@ -3058,8 +3067,7 @@ def __init__(self, id=None, name=None, type=None, url=None, web_url=None): class WorkItemToTestLinks(Model): - """WorkItemToTestLinks. - + """ :param executed_in: :type executed_in: object :param tests: @@ -3082,7 +3090,8 @@ def __init__(self, executed_in=None, tests=None, work_item=None): class TestActionResultModel(TestResultModelBase): - """TestActionResultModel. + """ + Represents a test step result. :param comment: Comment in result. :type comment: str diff --git a/azure-devops/azure/devops/v5_1/tfvc/models.py b/azure-devops/azure/devops/v5_1/tfvc/models.py index ff971aa8..a33a9349 100644 --- a/azure-devops/azure/devops/v5_1/tfvc/models.py +++ b/azure-devops/azure/devops/v5_1/tfvc/models.py @@ -10,8 +10,7 @@ class AssociatedWorkItem(Model): - """AssociatedWorkItem. - + """ :param assigned_to: :type assigned_to: str :param id: Id of associated the work item. @@ -50,8 +49,7 @@ def __init__(self, assigned_to=None, id=None, state=None, title=None, url=None, class Change(Model): - """Change. - + """ :param change_type: The type of change that was made to the item. :type change_type: object :param item: Current version. @@ -82,8 +80,7 @@ def __init__(self, change_type=None, item=None, new_content=None, source_server_ class CheckinNote(Model): - """CheckinNote. - + """ :param name: :type name: str :param value: @@ -102,8 +99,7 @@ def __init__(self, name=None, value=None): class FileContentMetadata(Model): - """FileContentMetadata. - + """ :param content_type: :type content_type: str :param encoding: @@ -142,8 +138,7 @@ def __init__(self, content_type=None, encoding=None, extension=None, file_name=N class GitRepository(Model): - """GitRepository. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param default_branch: @@ -206,8 +201,7 @@ def __init__(self, _links=None, default_branch=None, id=None, is_fork=None, name class GitRepositoryRef(Model): - """GitRepositoryRef. - + """ :param collection: Team Project Collection where this Fork resides :type collection: :class:`TeamProjectCollectionReference ` :param id: @@ -250,8 +244,7 @@ def __init__(self, collection=None, id=None, is_fork=None, name=None, project=No class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -278,8 +271,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -338,8 +330,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class ItemContent(Model): - """ItemContent. - + """ :param content: :type content: str :param content_type: @@ -358,8 +349,7 @@ def __init__(self, content=None, content_type=None): class ItemModel(Model): - """ItemModel. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param content: @@ -398,7 +388,8 @@ def __init__(self, _links=None, content=None, content_metadata=None, is_folder=N class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -414,7 +405,8 @@ def __init__(self, links=None): class TeamProjectCollectionReference(Model): - """TeamProjectCollectionReference. + """ + Reference object for a TeamProjectCollection. :param id: Collection Id. :type id: str @@ -438,7 +430,8 @@ def __init__(self, id=None, name=None, url=None): class TeamProjectReference(Model): - """TeamProjectReference. + """ + Represents a shallow reference to a TeamProject. :param abbreviation: Project abbreviation. :type abbreviation: str @@ -490,8 +483,7 @@ def __init__(self, abbreviation=None, default_team_image_url=None, description=N class TfvcBranchMapping(Model): - """TfvcBranchMapping. - + """ :param depth: Depth of the branch. :type depth: str :param server_item: Server item for the branch. @@ -514,8 +506,7 @@ def __init__(self, depth=None, server_item=None, type=None): class TfvcChange(Change): - """TfvcChange. - + """ :param merge_sources: List of merge sources in case of rename or branch creation. :type merge_sources: list of :class:`TfvcMergeSource ` :param pending_version: Version at which a (shelved) change was pended against @@ -534,8 +525,7 @@ def __init__(self, merge_sources=None, pending_version=None): class TfvcChangesetRef(Model): - """TfvcChangesetRef. - + """ :param _links: A collection of REST reference links. :type _links: :class:`ReferenceLinks ` :param author: Alias or display name of user @@ -578,7 +568,8 @@ def __init__(self, _links=None, author=None, changeset_id=None, checked_in_by=No class TfvcChangesetSearchCriteria(Model): - """TfvcChangesetSearchCriteria. + """ + Criteria used in a search for change lists :param author: Alias or display name of user who made the changes :type author: str @@ -626,8 +617,7 @@ def __init__(self, author=None, follow_renames=None, from_date=None, from_id=Non class TfvcChangesetsRequestData(Model): - """TfvcChangesetsRequestData. - + """ :param changeset_ids: List of changeset Ids. :type changeset_ids: list of int :param comment_length: Length of the comment. @@ -650,8 +640,7 @@ def __init__(self, changeset_ids=None, comment_length=None, include_links=None): class TfvcItem(ItemModel): - """TfvcItem. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param content: @@ -715,7 +704,8 @@ def __init__(self, _links=None, content=None, content_metadata=None, is_folder=N class TfvcItemDescriptor(Model): - """TfvcItemDescriptor. + """ + Item path and Version descriptor properties :param path: :type path: str @@ -747,8 +737,7 @@ def __init__(self, path=None, recursion_level=None, version=None, version_option class TfvcItemRequestData(Model): - """TfvcItemRequestData. - + """ :param include_content_metadata: If true, include metadata about the file type :type include_content_metadata: bool :param include_links: Whether to include the _links field on the shallow references @@ -771,8 +760,7 @@ def __init__(self, include_content_metadata=None, include_links=None, item_descr class TfvcLabelRef(Model): - """TfvcLabelRef. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param description: @@ -815,8 +803,7 @@ def __init__(self, _links=None, description=None, id=None, label_scope=None, mod class TfvcLabelRequestData(Model): - """TfvcLabelRequestData. - + """ :param include_links: Whether to include the _links field on the shallow references :type include_links: bool :param item_label_filter: @@ -851,8 +838,7 @@ def __init__(self, include_links=None, item_label_filter=None, label_scope=None, class TfvcMappingFilter(Model): - """TfvcMappingFilter. - + """ :param exclude: :type exclude: bool :param server_path: @@ -871,8 +857,7 @@ def __init__(self, exclude=None, server_path=None): class TfvcMergeSource(Model): - """TfvcMergeSource. - + """ :param is_rename: Indicates if this a rename source. If false, it is a merge source. :type is_rename: bool :param server_item: The server item of the merge source @@ -899,8 +884,7 @@ def __init__(self, is_rename=None, server_item=None, version_from=None, version_ class TfvcPolicyFailureInfo(Model): - """TfvcPolicyFailureInfo. - + """ :param message: :type message: str :param policy_name: @@ -919,8 +903,7 @@ def __init__(self, message=None, policy_name=None): class TfvcPolicyOverrideInfo(Model): - """TfvcPolicyOverrideInfo. - + """ :param comment: :type comment: str :param policy_failures: @@ -939,8 +922,7 @@ def __init__(self, comment=None, policy_failures=None): class TfvcShallowBranchRef(Model): - """TfvcShallowBranchRef. - + """ :param path: Path for the branch. :type path: str """ @@ -955,7 +937,8 @@ def __init__(self, path=None): class TfvcShelvesetRef(Model): - """TfvcShelvesetRef. + """ + This is the shallow shelveset class :param _links: :type _links: :class:`ReferenceLinks ` @@ -999,8 +982,7 @@ def __init__(self, _links=None, comment=None, comment_truncated=None, created_da class TfvcShelvesetRequestData(Model): - """TfvcShelvesetRequestData. - + """ :param include_details: Whether to include policyOverride and notes Only applies when requesting a single deep shelveset :type include_details: bool :param include_links: Whether to include the _links field on the shallow references. Does not apply when requesting a single deep shelveset object. Links will always be included in the deep shelveset. @@ -1039,8 +1021,7 @@ def __init__(self, include_details=None, include_links=None, include_work_items= class TfvcStatistics(Model): - """TfvcStatistics. - + """ :param changeset_id: Id of the last changeset the stats are based on. :type changeset_id: int :param file_count_total: Count of files at the requested scope. @@ -1059,8 +1040,7 @@ def __init__(self, changeset_id=None, file_count_total=None): class TfvcVersionDescriptor(Model): - """TfvcVersionDescriptor. - + """ :param version: :type version: str :param version_option: @@ -1083,8 +1063,7 @@ def __init__(self, version=None, version_option=None, version_type=None): class VersionControlProjectInfo(Model): - """VersionControlProjectInfo. - + """ :param default_source_control_type: :type default_source_control_type: object :param project: @@ -1111,8 +1090,7 @@ def __init__(self, default_source_control_type=None, project=None, supports_git= class VstsInfo(Model): - """VstsInfo. - + """ :param collection: :type collection: :class:`TeamProjectCollectionReference ` :param repository: @@ -1135,8 +1113,7 @@ def __init__(self, collection=None, repository=None, server_url=None): class TfvcBranchRef(TfvcShallowBranchRef): - """TfvcBranchRef. - + """ :param path: Path for the branch. :type path: str :param _links: A collection of REST reference links. @@ -1174,8 +1151,7 @@ def __init__(self, path=None, _links=None, created_date=None, description=None, class TfvcChangeset(TfvcChangesetRef): - """TfvcChangeset. - + """ :param _links: A collection of REST reference links. :type _links: :class:`ReferenceLinks ` :param author: Alias or display name of user @@ -1242,8 +1218,7 @@ def __init__(self, _links=None, author=None, changeset_id=None, checked_in_by=No class TfvcLabel(TfvcLabelRef): - """TfvcLabel. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param description: @@ -1282,7 +1257,8 @@ def __init__(self, _links=None, description=None, id=None, label_scope=None, mod class TfvcShelveset(TfvcShelvesetRef): - """TfvcShelveset. + """ + This is the deep shelveset class :param _links: :type _links: :class:`ReferenceLinks ` @@ -1334,8 +1310,7 @@ def __init__(self, _links=None, comment=None, comment_truncated=None, created_da class TfvcBranch(TfvcBranchRef): - """TfvcBranch. - + """ :param path: Path for the branch. :type path: str :param _links: A collection of REST reference links. diff --git a/azure-devops/azure/devops/v5_1/universal/models.py b/azure-devops/azure/devops/v5_1/universal/models.py index efa3bfe9..3dd0cebd 100644 --- a/azure-devops/azure/devops/v5_1/universal/models.py +++ b/azure-devops/azure/devops/v5_1/universal/models.py @@ -10,7 +10,8 @@ class BatchOperationData(Model): - """BatchOperationData. + """ + Do not attempt to use this type to create a new BatchOperationData. This type does not contain sufficient fields to create a new batch operation data. """ @@ -22,7 +23,8 @@ def __init__(self): class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -50,7 +52,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class MinimalPackageDetails(Model): - """MinimalPackageDetails. + """ + Minimal package details required to identify a package within a protocol. :param id: Package name. :type id: str @@ -70,7 +73,8 @@ def __init__(self, id=None, version=None): class Package(Model): - """Package. + """ + Package version metadata for a Universal package :param _links: Related REST links. :type _links: :class:`ReferenceLinks ` @@ -106,8 +110,7 @@ def __init__(self, _links=None, deleted_date=None, id=None, name=None, permanent class PackageVersionDetails(Model): - """PackageVersionDetails. - + """ :param views: The view to which the package version will be added :type views: :class:`JsonPatchOperation ` """ @@ -122,7 +125,8 @@ def __init__(self, views=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -138,7 +142,8 @@ def __init__(self, links=None): class UPackPackagesBatchRequest(Model): - """UPackPackagesBatchRequest. + """ + A batch of operations to apply to package versions. :param data: Data required to perform the operation. This is optional based on the type of the operation. Use BatchPromoteData if performing a promote operation. :type data: :class:`BatchOperationData ` @@ -162,7 +167,8 @@ def __init__(self, data=None, operation=None, packages=None): class UPackPackageVersionDeletionState(Model): - """UPackPackageVersionDeletionState. + """ + Deletion state of a Universal package. :param deleted_date: UTC date the package was deleted. :type deleted_date: datetime @@ -186,8 +192,7 @@ def __init__(self, deleted_date=None, name=None, version=None): class UPackRecycleBinPackageVersionDetails(Model): - """UPackRecycleBinPackageVersionDetails. - + """ :param deleted: Setting to false will undo earlier deletion and restore the package to feed. :type deleted: bool """ diff --git a/azure-devops/azure/devops/v5_1/upack_packaging/models.py b/azure-devops/azure/devops/v5_1/upack_packaging/models.py index 1f20052f..3f426b79 100644 --- a/azure-devops/azure/devops/v5_1/upack_packaging/models.py +++ b/azure-devops/azure/devops/v5_1/upack_packaging/models.py @@ -10,8 +10,7 @@ class UPackLimitedPackageMetadata(Model): - """UPackLimitedPackageMetadata. - + """ :param version: :type version: str """ @@ -26,8 +25,7 @@ def __init__(self, version=None): class UPackLimitedPackageMetadataListResponse(Model): - """UPackLimitedPackageMetadataListResponse. - + """ :param count: :type count: int :param value: @@ -46,8 +44,7 @@ def __init__(self, count=None, value=None): class UPackPackageMetadata(Model): - """UPackPackageMetadata. - + """ :param description: :type description: str :param manifest_id: @@ -74,8 +71,7 @@ def __init__(self, description=None, manifest_id=None, super_root_id=None, versi class UPackPackagePushMetadata(UPackPackageMetadata): - """UPackPackagePushMetadata. - + """ :param description: :type description: str :param manifest_id: @@ -102,7 +98,8 @@ def __init__(self, description=None, manifest_id=None, super_root_id=None, versi class UPackPackageVersionDeletionState(Model): - """UPackPackageVersionDeletionState. + """ + Deletion state of a Universal package. :param deleted_date: UTC date the package was deleted. :type deleted_date: datetime diff --git a/azure-devops/azure/devops/v5_1/wiki/models.py b/azure-devops/azure/devops/v5_1/wiki/models.py index e65298b8..2fed7ef8 100644 --- a/azure-devops/azure/devops/v5_1/wiki/models.py +++ b/azure-devops/azure/devops/v5_1/wiki/models.py @@ -10,8 +10,7 @@ class GitRepository(Model): - """GitRepository. - + """ :param _links: :type _links: ReferenceLinks :param default_branch: @@ -74,8 +73,7 @@ def __init__(self, _links=None, default_branch=None, id=None, is_fork=None, name class GitRepositoryRef(Model): - """GitRepositoryRef. - + """ :param collection: Team Project Collection where this Fork resides :type collection: TeamProjectCollectionReference :param id: @@ -118,8 +116,7 @@ def __init__(self, collection=None, id=None, is_fork=None, name=None, project=No class GitVersionDescriptor(Model): - """GitVersionDescriptor. - + """ :param version: Version string identifier (name of tag/branch, SHA1 of commit) :type version: str :param version_options: Version options - Specify additional modifiers to version (e.g Previous) @@ -142,7 +139,8 @@ def __init__(self, version=None, version_options=None, version_type=None): class WikiAttachment(Model): - """WikiAttachment. + """ + Defines properties for wiki attachment file. :param name: Name of the wiki attachment file. :type name: str @@ -162,7 +160,8 @@ def __init__(self, name=None, path=None): class WikiAttachmentResponse(Model): - """WikiAttachmentResponse. + """ + Response contract for the Wiki Attachments API :param attachment: Defines properties for wiki attachment file. :type attachment: :class:`WikiAttachment ` @@ -182,7 +181,8 @@ def __init__(self, attachment=None, eTag=None): class WikiCreateBaseParameters(Model): - """WikiCreateBaseParameters. + """ + Base wiki creation parameters. :param mapped_path: Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type. :type mapped_path: str @@ -214,7 +214,8 @@ def __init__(self, mapped_path=None, name=None, project_id=None, repository_id=N class WikiCreateParametersV2(WikiCreateBaseParameters): - """WikiCreateParametersV2. + """ + Wiki creation parameters. :param mapped_path: Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type. :type mapped_path: str @@ -245,7 +246,8 @@ def __init__(self, mapped_path=None, name=None, project_id=None, repository_id=N class WikiPageCreateOrUpdateParameters(Model): - """WikiPageCreateOrUpdateParameters. + """ + Contract encapsulating parameters for the page create or update operations. :param content: Content of the wiki page. :type content: str @@ -261,7 +263,8 @@ def __init__(self, content=None): class WikiPageMoveParameters(Model): - """WikiPageMoveParameters. + """ + Contract encapsulating parameters for the page move operation. :param new_order: New order of the wiki page. :type new_order: int @@ -285,7 +288,8 @@ def __init__(self, new_order=None, new_path=None, path=None): class WikiPageMoveResponse(Model): - """WikiPageMoveResponse. + """ + Response contract for the Wiki Page Move API. :param eTag: Contains the list of ETag values from the response header of the page move API call. The first item in the list contains the version of the wiki page subject to page move. :type eTag: list of str @@ -305,7 +309,8 @@ def __init__(self, eTag=None, page_move=None): class WikiPageResponse(Model): - """WikiPageResponse. + """ + Response contract for the Wiki Pages PUT, PATCH and DELETE APIs. :param eTag: Contains the list of ETag values from the response header of the pages API call. The first item in the list contains the version of the wiki page. :type eTag: list of str @@ -325,7 +330,8 @@ def __init__(self, eTag=None, page=None): class WikiPageViewStats(Model): - """WikiPageViewStats. + """ + Defines properties for wiki page view stats. :param count: Wiki page view count. :type count: int @@ -349,7 +355,8 @@ def __init__(self, count=None, last_viewed_time=None, path=None): class WikiUpdateParameters(Model): - """WikiUpdateParameters. + """ + Wiki update parameters. :param name: Name for wiki. :type name: str @@ -369,7 +376,8 @@ def __init__(self, name=None, versions=None): class WikiV2(WikiCreateBaseParameters): - """WikiV2. + """ + Defines a wiki resource. :param mapped_path: Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type. :type mapped_path: str @@ -416,7 +424,8 @@ def __init__(self, mapped_path=None, name=None, project_id=None, repository_id=N class WikiPage(WikiPageCreateOrUpdateParameters): - """WikiPage. + """ + Defines a page in a wiki. :param content: Content of the wiki page. :type content: str @@ -467,7 +476,8 @@ def __init__(self, content=None, git_item_path=None, id=None, is_non_conformant= class WikiPageMove(WikiPageMoveParameters): - """WikiPageMove. + """ + Request contract for Wiki Page Move. :param new_order: New order of the wiki page. :type new_order: int diff --git a/azure-devops/azure/devops/v5_1/work/models.py b/azure-devops/azure/devops/v5_1/work/models.py index 164fe64e..5c4f64be 100644 --- a/azure-devops/azure/devops/v5_1/work/models.py +++ b/azure-devops/azure/devops/v5_1/work/models.py @@ -10,8 +10,7 @@ class Activity(Model): - """Activity. - + """ :param capacity_per_day: :type capacity_per_day: int :param name: @@ -30,8 +29,7 @@ def __init__(self, capacity_per_day=None, name=None): class BacklogColumn(Model): - """BacklogColumn. - + """ :param column_field_reference: :type column_field_reference: :class:`WorkItemFieldReference ` :param width: @@ -50,8 +48,7 @@ def __init__(self, column_field_reference=None, width=None): class BacklogConfiguration(Model): - """BacklogConfiguration. - + """ :param backlog_fields: Behavior/type field mapping :type backlog_fields: :class:`BacklogFields ` :param bugs_behavior: Bugs behavior @@ -98,8 +95,7 @@ def __init__(self, backlog_fields=None, bugs_behavior=None, hidden_backlogs=None class BacklogFields(Model): - """BacklogFields. - + """ :param type_fields: Field Type (e.g. Order, Activity) to Field Reference Name map :type type_fields: dict """ @@ -114,7 +110,8 @@ def __init__(self, type_fields=None): class BacklogLevel(Model): - """BacklogLevel. + """ + Contract representing a backlog level :param category_reference_name: Reference name of the corresponding WIT category :type category_reference_name: str @@ -142,8 +139,7 @@ def __init__(self, category_reference_name=None, plural_name=None, work_item_sta class BacklogLevelConfiguration(Model): - """BacklogLevelConfiguration. - + """ :param add_panel_fields: List of fields to include in Add Panel :type add_panel_fields: list of :class:`WorkItemFieldReference ` :param color: Color for the backlog level @@ -198,7 +194,8 @@ def __init__(self, add_panel_fields=None, color=None, column_fields=None, defaul class BacklogLevelWorkItems(Model): - """BacklogLevelWorkItems. + """ + Represents work items in a backlog level :param work_items: A list of work items within a backlog level :type work_items: list of :class:`WorkItemLink ` @@ -214,7 +211,8 @@ def __init__(self, work_items=None): class BoardBadge(Model): - """BoardBadge. + """ + Represents a board badge. :param board_id: The ID of the board represented by this badge. :type board_id: str @@ -234,8 +232,7 @@ def __init__(self, board_id=None, image_url=None): class BoardCardRuleSettings(Model): - """BoardCardRuleSettings. - + """ :param _links: :type _links: :class:`ReferenceLinks ` :param rules: @@ -258,8 +255,7 @@ def __init__(self, _links=None, rules=None, url=None): class BoardCardSettings(Model): - """BoardCardSettings. - + """ :param cards: :type cards: dict """ @@ -274,8 +270,7 @@ def __init__(self, cards=None): class BoardChartReference(Model): - """BoardChartReference. - + """ :param name: Name of the resource :type name: str :param url: Full http link to the resource @@ -294,8 +289,7 @@ def __init__(self, name=None, url=None): class BoardColumn(Model): - """BoardColumn. - + """ :param column_type: :type column_type: object :param description: @@ -334,8 +328,7 @@ def __init__(self, column_type=None, description=None, id=None, is_split=None, i class BoardFields(Model): - """BoardFields. - + """ :param column_field: :type column_field: :class:`FieldReference ` :param done_field: @@ -358,8 +351,7 @@ def __init__(self, column_field=None, done_field=None, row_field=None): class BoardReference(Model): - """BoardReference. - + """ :param id: Id of the resource :type id: str :param name: Name of the resource @@ -382,8 +374,7 @@ def __init__(self, id=None, name=None, url=None): class BoardRow(Model): - """BoardRow. - + """ :param id: :type id: str :param name: @@ -402,8 +393,7 @@ def __init__(self, id=None, name=None): class BoardSuggestedValue(Model): - """BoardSuggestedValue. - + """ :param name: :type name: str """ @@ -418,8 +408,7 @@ def __init__(self, name=None): class BoardUserSettings(Model): - """BoardUserSettings. - + """ :param auto_refresh_state: :type auto_refresh_state: bool """ @@ -434,7 +423,8 @@ def __init__(self, auto_refresh_state=None): class CapacityPatch(Model): - """CapacityPatch. + """ + Expected data from PATCH :param activities: :type activities: list of :class:`Activity ` @@ -454,7 +444,8 @@ def __init__(self, activities=None, days_off=None): class CategoryConfiguration(Model): - """CategoryConfiguration. + """ + Details about a given backlog category :param name: Name :type name: str @@ -478,8 +469,7 @@ def __init__(self, name=None, reference_name=None, work_item_types=None): class CreatePlan(Model): - """CreatePlan. - + """ :param description: Description of the plan :type description: str :param name: Name of the plan to create. @@ -506,8 +496,7 @@ def __init__(self, description=None, name=None, properties=None, type=None): class DateRange(Model): - """DateRange. - + """ :param end: End of the date range. :type end: datetime :param start: Start of the date range. @@ -526,7 +515,8 @@ def __init__(self, end=None, start=None): class FieldReference(Model): - """FieldReference. + """ + An abstracted reference to a field :param reference_name: fieldRefName for the field :type reference_name: str @@ -546,8 +536,7 @@ def __init__(self, reference_name=None, url=None): class FilterClause(Model): - """FilterClause. - + """ :param field_name: :type field_name: str :param index: @@ -578,8 +567,7 @@ def __init__(self, field_name=None, index=None, logical_operator=None, operator= class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -606,8 +594,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -666,7 +653,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class Link(Model): - """Link. + """ + Link description. :param attributes: Collection of link attributes. :type attributes: dict @@ -690,8 +678,7 @@ def __init__(self, attributes=None, rel=None, url=None): class Member(Model): - """Member. - + """ :param display_name: :type display_name: str :param id: @@ -722,8 +709,7 @@ def __init__(self, display_name=None, id=None, image_url=None, unique_name=None, class ParentChildWIMap(Model): - """ParentChildWIMap. - + """ :param child_work_item_ids: :type child_work_item_ids: list of int :param id: @@ -746,7 +732,8 @@ def __init__(self, child_work_item_ids=None, id=None, title=None): class Plan(Model): - """Plan. + """ + Data contract for the plan definition :param created_by_identity: Identity that created this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4. :type created_by_identity: :class:`IdentityRef ` @@ -806,7 +793,8 @@ def __init__(self, created_by_identity=None, created_date=None, description=None class PlanViewData(Model): - """PlanViewData. + """ + Base class for plan view data contracts. Anything common goes here. :param id: :type id: str @@ -826,7 +814,8 @@ def __init__(self, id=None, revision=None): class PredefinedQuery(Model): - """PredefinedQuery. + """ + Represents a single pre-defined query. :param has_more: Whether or not the query returned the complete set of data or if the data was truncated. :type has_more: bool @@ -862,7 +851,8 @@ def __init__(self, has_more=None, id=None, name=None, results=None, url=None, we class ProcessConfiguration(Model): - """ProcessConfiguration. + """ + Process Configurations for the project :param bug_work_items: Details about bug work items :type bug_work_items: :class:`CategoryConfiguration ` @@ -898,7 +888,8 @@ def __init__(self, bug_work_items=None, portfolio_backlogs=None, requirement_bac class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -914,7 +905,8 @@ def __init__(self, links=None): class ReorderOperation(Model): - """ReorderOperation. + """ + Represents a reorder request for one or more work items. :param ids: IDs of the work items to be reordered. Must be valid WorkItem Ids. :type ids: list of int @@ -946,7 +938,8 @@ def __init__(self, ids=None, iteration_path=None, next_id=None, parent_id=None, class ReorderResult(Model): - """ReorderResult. + """ + Represents a reorder result for a work item. :param id: The ID of the work item that was reordered. :type id: int @@ -966,8 +959,7 @@ def __init__(self, id=None, order=None): class Rule(Model): - """Rule. - + """ :param clauses: :type clauses: list of :class:`FilterClause ` :param filter: @@ -998,7 +990,8 @@ def __init__(self, clauses=None, filter=None, is_enabled=None, name=None, settin class TeamContext(Model): - """TeamContext. + """ + The Team Context for an operation. :param project: The team project Id or name. Ignored if ProjectId is set. :type project: str @@ -1026,7 +1019,8 @@ def __init__(self, project=None, project_id=None, team=None, team_id=None): class TeamFieldValue(Model): - """TeamFieldValue. + """ + Represents a single TeamFieldValue :param include_children: :type include_children: bool @@ -1046,7 +1040,8 @@ def __init__(self, include_children=None, value=None): class TeamFieldValuesPatch(Model): - """TeamFieldValuesPatch. + """ + Expected data from PATCH :param default_value: :type default_value: str @@ -1066,8 +1061,7 @@ def __init__(self, default_value=None, values=None): class TeamIterationAttributes(Model): - """TeamIterationAttributes. - + """ :param finish_date: Finish date of the iteration. Date-only, correct unadjusted at midnight in UTC. :type finish_date: datetime :param start_date: Start date of the iteration. Date-only, correct unadjusted at midnight in UTC. @@ -1090,7 +1084,8 @@ def __init__(self, finish_date=None, start_date=None, time_frame=None): class TeamSettingsDataContractBase(Model): - """TeamSettingsDataContractBase. + """ + Base class for TeamSettings data contracts. Anything common goes here. :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` @@ -1110,8 +1105,7 @@ def __init__(self, _links=None, url=None): class TeamSettingsDaysOff(TeamSettingsDataContractBase): - """TeamSettingsDaysOff. - + """ :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` :param url: Full http link to the resource @@ -1132,8 +1126,7 @@ def __init__(self, _links=None, url=None, days_off=None): class TeamSettingsDaysOffPatch(Model): - """TeamSettingsDaysOffPatch. - + """ :param days_off: :type days_off: list of :class:`DateRange ` """ @@ -1148,7 +1141,8 @@ def __init__(self, days_off=None): class TeamSettingsIteration(TeamSettingsDataContractBase): - """TeamSettingsIteration. + """ + Represents a shallow ref for a single iteration. :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` @@ -1182,7 +1176,8 @@ def __init__(self, _links=None, url=None, attributes=None, id=None, name=None, p class TeamSettingsPatch(Model): - """TeamSettingsPatch. + """ + Data contract for what we expect to receive when PATCH :param backlog_iteration: :type backlog_iteration: str @@ -1218,8 +1213,7 @@ def __init__(self, backlog_iteration=None, backlog_visibilities=None, bugs_behav class TimelineCriteriaStatus(Model): - """TimelineCriteriaStatus. - + """ :param message: :type message: str :param type: @@ -1238,8 +1232,7 @@ def __init__(self, message=None, type=None): class TimelineIterationStatus(Model): - """TimelineIterationStatus. - + """ :param message: :type message: str :param type: @@ -1258,8 +1251,7 @@ def __init__(self, message=None, type=None): class TimelineTeamData(Model): - """TimelineTeamData. - + """ :param backlog: Backlog matching the mapped backlog associated with this team. :type backlog: :class:`BacklogLevel ` :param field_reference_names: The field reference names of the work item data @@ -1326,8 +1318,7 @@ def __init__(self, backlog=None, field_reference_names=None, id=None, is_expande class TimelineTeamIteration(Model): - """TimelineTeamIteration. - + """ :param css_node_id: The iteration CSS Node Id :type css_node_id: str :param finish_date: The end date of the iteration @@ -1370,8 +1361,7 @@ def __init__(self, css_node_id=None, finish_date=None, name=None, partially_page class TimelineTeamStatus(Model): - """TimelineTeamStatus. - + """ :param message: :type message: str :param type: @@ -1390,8 +1380,7 @@ def __init__(self, message=None, type=None): class UpdatePlan(Model): - """UpdatePlan. - + """ :param description: Description of the plan :type description: str :param name: Name of the plan to create. @@ -1422,7 +1411,8 @@ def __init__(self, description=None, name=None, properties=None, revision=None, class WorkItemColor(Model): - """WorkItemColor. + """ + Work item color and icon. :param icon: :type icon: str @@ -1446,7 +1436,8 @@ def __init__(self, icon=None, primary_color=None, work_item_type_name=None): class WorkItemFieldReference(Model): - """WorkItemFieldReference. + """ + Reference to a field in a work item :param name: The friendly name of the field. :type name: str @@ -1470,7 +1461,8 @@ def __init__(self, name=None, reference_name=None, url=None): class WorkItemLink(Model): - """WorkItemLink. + """ + A link between two work items. :param rel: The type of link. :type rel: str @@ -1494,7 +1486,8 @@ def __init__(self, rel=None, source=None, target=None): class WorkItemReference(Model): - """WorkItemReference. + """ + Contains reference to a work item. :param id: Work item ID. :type id: int @@ -1514,8 +1507,7 @@ def __init__(self, id=None, url=None): class WorkItemRelation(Link): - """WorkItemRelation. - + """ :param attributes: Collection of link attributes. :type attributes: dict :param rel: Relation type. @@ -1535,7 +1527,8 @@ def __init__(self, attributes=None, rel=None, url=None): class WorkItemTrackingResourceReference(Model): - """WorkItemTrackingResourceReference. + """ + Base class for work item tracking resource references. :param url: :type url: str @@ -1551,7 +1544,8 @@ def __init__(self, url=None): class WorkItemTypeReference(WorkItemTrackingResourceReference): - """WorkItemTypeReference. + """ + Reference to a work item type. :param url: :type url: str @@ -1570,8 +1564,7 @@ def __init__(self, url=None, name=None): class WorkItemTypeStateInfo(Model): - """WorkItemTypeStateInfo. - + """ :param states: State name to state category map :type states: dict :param work_item_type_name: Work Item type name @@ -1590,8 +1583,7 @@ def __init__(self, states=None, work_item_type_name=None): class Board(BoardReference): - """Board. - + """ :param id: Id of the resource :type id: str :param name: Name of the resource @@ -1643,8 +1635,7 @@ def __init__(self, id=None, name=None, url=None, _links=None, allowed_mappings=N class BoardChart(BoardChartReference): - """BoardChart. - + """ :param name: Name of the resource :type name: str :param url: Full http link to the resource @@ -1669,8 +1660,7 @@ def __init__(self, name=None, url=None, _links=None, settings=None): class CapacityContractBase(TeamSettingsDataContractBase): - """CapacityContractBase. - + """ :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` :param url: Full http link to the resource @@ -1695,7 +1685,8 @@ def __init__(self, _links=None, url=None, activities=None, days_off=None): class DeliveryViewData(PlanViewData): - """DeliveryViewData. + """ + Data contract for Data of Delivery View :param id: :type id: str @@ -1737,7 +1728,8 @@ def __init__(self, id=None, revision=None, child_id_to_parent_id_map=None, crite class IterationWorkItems(TeamSettingsDataContractBase): - """IterationWorkItems. + """ + Represents work items in an iteration backlog :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` @@ -1759,7 +1751,8 @@ def __init__(self, _links=None, url=None, work_item_relations=None): class TeamFieldValues(TeamSettingsDataContractBase): - """TeamFieldValues. + """ + Essentially a collection of team field values :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` @@ -1789,7 +1782,8 @@ def __init__(self, _links=None, url=None, default_value=None, field=None, values class TeamMemberCapacity(CapacityContractBase): - """TeamMemberCapacity. + """ + Represents capacity for a specific team member :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` @@ -1817,7 +1811,8 @@ def __init__(self, _links=None, url=None, activities=None, days_off=None, team_m class TeamMemberCapacityIdentityRef(CapacityContractBase): - """TeamMemberCapacityIdentityRef. + """ + Represents capacity for a specific team member :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` @@ -1845,7 +1840,8 @@ def __init__(self, _links=None, url=None, activities=None, days_off=None, team_m class TeamSetting(TeamSettingsDataContractBase): - """TeamSetting. + """ + Data contract for TeamSettings :param _links: Collection of links relevant to resource :type _links: :class:`ReferenceLinks ` @@ -1887,7 +1883,8 @@ def __init__(self, _links=None, url=None, backlog_iteration=None, backlog_visibi class WorkItemCommentVersionRef(WorkItemTrackingResourceReference): - """WorkItemCommentVersionRef. + """ + Represents the reference to a specific version of a comment on a Work Item. :param url: :type url: str @@ -1922,7 +1919,8 @@ def __init__(self, url=None, comment_id=None, created_in_revision=None, is_delet class WorkItemTrackingResource(WorkItemTrackingResourceReference): - """WorkItemTrackingResource. + """ + Base class for WIT REST resources. :param url: :type url: str @@ -1941,7 +1939,8 @@ def __init__(self, url=None, _links=None): class WorkItem(WorkItemTrackingResource): - """WorkItem. + """ + Describes a work item. :param url: :type url: str diff --git a/azure-devops/azure/devops/v5_1/work_item_tracking/models.py b/azure-devops/azure/devops/v5_1/work_item_tracking/models.py index 082b8cb2..cb7def62 100644 --- a/azure-devops/azure/devops/v5_1/work_item_tracking/models.py +++ b/azure-devops/azure/devops/v5_1/work_item_tracking/models.py @@ -10,8 +10,7 @@ class AccountMyWorkResult(Model): - """AccountMyWorkResult. - + """ :param query_size_limit_exceeded: True, when length of WorkItemDetails is same as the limit :type query_size_limit_exceeded: bool :param work_item_details: WorkItem Details @@ -30,7 +29,8 @@ def __init__(self, query_size_limit_exceeded=None, work_item_details=None): class AccountRecentActivityWorkItemModelBase(Model): - """AccountRecentActivityWorkItemModelBase. + """ + Represents Work Item Recent Activity :param activity_date: Date of the last Activity by the user :type activity_date: datetime @@ -78,7 +78,8 @@ def __init__(self, activity_date=None, activity_type=None, changed_date=None, id class AccountRecentMentionWorkItemModel(Model): - """AccountRecentMentionWorkItemModel. + """ + Represents Recent Mention Work Item :param assigned_to: Assigned To :type assigned_to: str @@ -118,8 +119,7 @@ def __init__(self, assigned_to=None, id=None, mentioned_date_field=None, state=N class AccountWorkWorkItemModel(Model): - """AccountWorkWorkItemModel. - + """ :param assigned_to: :type assigned_to: str :param changed_date: @@ -158,7 +158,8 @@ def __init__(self, assigned_to=None, changed_date=None, id=None, state=None, tea class ArtifactUriQuery(Model): - """ArtifactUriQuery. + """ + Contains criteria for querying work items based on artifact URI. :param artifact_uris: List of artifact URIs to use for querying work items. :type artifact_uris: list of str @@ -174,7 +175,8 @@ def __init__(self, artifact_uris=None): class ArtifactUriQueryResult(Model): - """ArtifactUriQueryResult. + """ + Defines result of artifact URI query on work items. Contains mapping of work item IDs to artifact URI. :param artifact_uris_query_result: A Dictionary that maps a list of work item references to the given list of artifact URI. :type artifact_uris_query_result: dict @@ -190,8 +192,7 @@ def __init__(self, artifact_uris_query_result=None): class AttachmentReference(Model): - """AttachmentReference. - + """ :param id: :type id: str :param url: @@ -210,7 +211,8 @@ def __init__(self, id=None, url=None): class CommentCreate(Model): - """CommentCreate. + """ + Represents a request to create a work item comment. :param text: The text of the comment. :type text: str @@ -226,7 +228,8 @@ def __init__(self, text=None): class CommentUpdate(Model): - """CommentUpdate. + """ + Represents a request to update a work item comment. :param text: The updated text of the comment. :type text: str @@ -242,7 +245,8 @@ def __init__(self, text=None): class FieldsToEvaluate(Model): - """FieldsToEvaluate. + """ + Describes a set fields for rule evaluation. :param fields: List of fields to evaluate. :type fields: list of str @@ -270,8 +274,7 @@ def __init__(self, fields=None, field_updates=None, field_values=None, rules_fro class GraphSubjectBase(Model): - """GraphSubjectBase. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -298,8 +301,7 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None): class IdentityRef(GraphSubjectBase): - """IdentityRef. - + """ :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` :param descriptor: The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. @@ -358,7 +360,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class IdentityReference(IdentityRef): - """IdentityReference. + """ + Describes a reference to an identity. :param _links: This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. :type _links: :class:`ReferenceLinks ` @@ -414,7 +417,8 @@ def __init__(self, _links=None, descriptor=None, display_name=None, url=None, di class JsonPatchOperation(Model): - """JsonPatchOperation. + """ + The JSON model for a JSON Patch operation :param from_: The path to copy from for the Move/Copy operation. :type from_: str @@ -442,7 +446,8 @@ def __init__(self, from_=None, op=None, path=None, value=None): class Link(Model): - """Link. + """ + Link description. :param attributes: Collection of link attributes. :type attributes: dict @@ -466,7 +471,8 @@ def __init__(self, attributes=None, rel=None, url=None): class ProjectWorkItemStateColors(Model): - """ProjectWorkItemStateColors. + """ + Project work item type state colors :param project_name: Project name :type project_name: str @@ -486,7 +492,8 @@ def __init__(self, project_name=None, work_item_type_state_colors=None): class ProvisioningResult(Model): - """ProvisioningResult. + """ + Result of an update work item type XML update operation. :param provisioning_import_events: Details about of the provisioning import events. :type provisioning_import_events: list of str @@ -502,7 +509,8 @@ def __init__(self, provisioning_import_events=None): class QueryBatchGetRequest(Model): - """QueryBatchGetRequest. + """ + Describes a request to get a list of queries :param expand: The expand parameters for queries. Possible options are { None, Wiql, Clauses, All, Minimal } :type expand: object @@ -526,8 +534,7 @@ def __init__(self, expand=None, error_policy=None, ids=None): class QueryHierarchyItemsResult(Model): - """QueryHierarchyItemsResult. - + """ :param count: The count of items. :type count: int :param has_more: Indicates if the max return limit was hit but there are still more items @@ -550,7 +557,8 @@ def __init__(self, count=None, has_more=None, value=None): class ReferenceLinks(Model): - """ReferenceLinks. + """ + The class to represent a collection of REST reference links. :param links: The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. :type links: dict @@ -566,7 +574,8 @@ def __init__(self, links=None): class ReportingWorkItemRevisionsFilter(Model): - """ReportingWorkItemRevisionsFilter. + """ + The class reprensents the reporting work item revision filer. :param fields: A list of fields to return in work item revisions. Omit this parameter to get all reportable fields. :type fields: list of str @@ -602,7 +611,8 @@ def __init__(self, fields=None, include_deleted=None, include_identity_ref=None, class StreamedBatch(Model): - """StreamedBatch. + """ + The class describes reporting work item revision batch. :param continuation_token: ContinuationToken acts as a waterMark. Used while quering large results. :type continuation_token: str @@ -630,7 +640,8 @@ def __init__(self, continuation_token=None, is_last_batch=None, next_link=None, class TeamContext(Model): - """TeamContext. + """ + The Team Context for an operation. :param project: The team project Id or name. Ignored if ProjectId is set. :type project: str @@ -658,7 +669,8 @@ def __init__(self, project=None, project_id=None, team=None, team_id=None): class Wiql(Model): - """Wiql. + """ + A WIQL query :param query: The text of the WIQL query :type query: str @@ -674,7 +686,8 @@ def __init__(self, query=None): class WorkArtifactLink(Model): - """WorkArtifactLink. + """ + A work artifact link describes an outbound artifact link type. :param artifact_type: Target artifact type. :type artifact_type: str @@ -698,7 +711,8 @@ def __init__(self, artifact_type=None, link_type=None, tool_type=None): class WorkItemBatchGetRequest(Model): - """WorkItemBatchGetRequest. + """ + Describes a request to get a set of work items :param expand: The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All } :type expand: object @@ -730,7 +744,8 @@ def __init__(self, expand=None, as_of=None, error_policy=None, fields=None, ids= class WorkItemDeleteReference(Model): - """WorkItemDeleteReference. + """ + Reference to a deleted work item. :param code: The HTTP status code for work item operation in a batch request. :type code: int @@ -778,7 +793,8 @@ def __init__(self, code=None, deleted_by=None, deleted_date=None, id=None, messa class WorkItemDeleteShallowReference(Model): - """WorkItemDeleteShallowReference. + """ + Shallow Reference to a deleted work item. :param id: Work item ID. :type id: int @@ -798,7 +814,8 @@ def __init__(self, id=None, url=None): class WorkItemDeleteUpdate(Model): - """WorkItemDeleteUpdate. + """ + Describes an update request for a deleted work item. :param is_deleted: Sets a value indicating whether this work item is deleted. :type is_deleted: bool @@ -814,7 +831,8 @@ def __init__(self, is_deleted=None): class WorkItemFieldOperation(Model): - """WorkItemFieldOperation. + """ + Describes a work item field operation. :param name: Friendly name of the operation. :type name: str @@ -834,7 +852,8 @@ def __init__(self, name=None, reference_name=None): class WorkItemFieldReference(Model): - """WorkItemFieldReference. + """ + Reference to a field in a work item :param name: The friendly name of the field. :type name: str @@ -858,7 +877,8 @@ def __init__(self, name=None, reference_name=None, url=None): class WorkItemFieldUpdate(Model): - """WorkItemFieldUpdate. + """ + Describes an update to a work item field. :param new_value: The new value of the field. :type new_value: object @@ -878,7 +898,8 @@ def __init__(self, new_value=None, old_value=None): class WorkItemIcon(Model): - """WorkItemIcon. + """ + Reference to a work item icon. :param id: The identifier of the icon. :type id: str @@ -898,7 +919,8 @@ def __init__(self, id=None, url=None): class WorkItemLink(Model): - """WorkItemLink. + """ + A link between two work items. :param rel: The type of link. :type rel: str @@ -922,7 +944,8 @@ def __init__(self, rel=None, source=None, target=None): class WorkItemNextStateOnTransition(Model): - """WorkItemNextStateOnTransition. + """ + Describes the next state for a work item. :param error_code: Error code if there is no next state transition possible. :type error_code: str @@ -950,7 +973,8 @@ def __init__(self, error_code=None, id=None, message=None, state_on_transition=N class WorkItemQueryClause(Model): - """WorkItemQueryClause. + """ + Represents a clause in a work item query. This shows the structure of a work item query. :param clauses: Child clauses if the current clause is a logical operator :type clauses: list of :class:`WorkItemQueryClause ` @@ -990,7 +1014,8 @@ def __init__(self, clauses=None, field=None, field_value=None, is_field_value=No class WorkItemQueryResult(Model): - """WorkItemQueryResult. + """ + The result of a work item query. :param as_of: The date the query was run in the context of. :type as_of: datetime @@ -1030,7 +1055,8 @@ def __init__(self, as_of=None, columns=None, query_result_type=None, query_type= class WorkItemQuerySortColumn(Model): - """WorkItemQuerySortColumn. + """ + A sort column. :param descending: The direction to sort by. :type descending: bool @@ -1050,7 +1076,8 @@ def __init__(self, descending=None, field=None): class WorkItemReference(Model): - """WorkItemReference. + """ + Contains reference to a work item. :param id: Work item ID. :type id: int @@ -1070,8 +1097,7 @@ def __init__(self, id=None, url=None): class WorkItemRelation(Link): - """WorkItemRelation. - + """ :param attributes: Collection of link attributes. :type attributes: dict :param rel: Relation type. @@ -1091,7 +1117,8 @@ def __init__(self, attributes=None, rel=None, url=None): class WorkItemRelationUpdates(Model): - """WorkItemRelationUpdates. + """ + Descrives updates to a work item's relations. :param added: List of newly added relations. :type added: list of :class:`WorkItemRelation ` @@ -1115,7 +1142,8 @@ def __init__(self, added=None, removed=None, updated=None): class WorkItemStateColor(Model): - """WorkItemStateColor. + """ + Work item type state name, color and state category :param category: Category of state :type category: str @@ -1139,7 +1167,8 @@ def __init__(self, category=None, color=None, name=None): class WorkItemStateTransition(Model): - """WorkItemStateTransition. + """ + Describes a state transition in a work item. :param actions: Gets a list of actions needed to transition to that state. :type actions: list of str @@ -1159,7 +1188,8 @@ def __init__(self, actions=None, to=None): class WorkItemTrackingResourceReference(Model): - """WorkItemTrackingResourceReference. + """ + Base class for work item tracking resource references. :param url: :type url: str @@ -1175,7 +1205,8 @@ def __init__(self, url=None): class WorkItemTypeColor(Model): - """WorkItemTypeColor. + """ + Describes a work item type's colors. :param primary_color: Gets or sets the color of the primary. :type primary_color: str @@ -1199,7 +1230,8 @@ def __init__(self, primary_color=None, secondary_color=None, work_item_type_name class WorkItemTypeColorAndIcon(Model): - """WorkItemTypeColorAndIcon. + """ + Describes work item type nam, its icon and color. :param color: The color of the work item type in hex format. :type color: str @@ -1223,7 +1255,8 @@ def __init__(self, color=None, icon=None, work_item_type_name=None): class WorkItemTypeFieldInstanceBase(WorkItemFieldReference): - """WorkItemTypeFieldInstanceBase. + """ + Base field instance for workItemType fields. :param name: The friendly name of the field. :type name: str @@ -1256,7 +1289,8 @@ def __init__(self, name=None, reference_name=None, url=None, always_required=Non class WorkItemTypeFieldWithReferences(WorkItemTypeFieldInstanceBase): - """WorkItemTypeFieldWithReferences. + """ + Field Instance of a workItemype with detailed references. :param name: The friendly name of the field. :type name: str @@ -1294,7 +1328,8 @@ def __init__(self, name=None, reference_name=None, url=None, always_required=Non class WorkItemTypeReference(WorkItemTrackingResourceReference): - """WorkItemTypeReference. + """ + Reference to a work item type. :param url: :type url: str @@ -1313,7 +1348,8 @@ def __init__(self, url=None, name=None): class WorkItemTypeStateColors(Model): - """WorkItemTypeStateColors. + """ + State colors for a work item type :param state_colors: Work item type state colors :type state_colors: list of :class:`WorkItemStateColor ` @@ -1333,7 +1369,8 @@ def __init__(self, state_colors=None, work_item_type_name=None): class WorkItemTypeTemplate(Model): - """WorkItemTypeTemplate. + """ + Describes a work item type template. :param template: XML template in string format. :type template: str @@ -1349,7 +1386,8 @@ def __init__(self, template=None): class WorkItemTypeTemplateUpdateModel(Model): - """WorkItemTypeTemplateUpdateModel. + """ + Describes a update work item type template request body. :param action_type: Describes the type of the action for the update request. :type action_type: object @@ -1377,7 +1415,8 @@ def __init__(self, action_type=None, methodology=None, template=None, template_t class AccountRecentActivityWorkItemModel(AccountRecentActivityWorkItemModelBase): - """AccountRecentActivityWorkItemModel. + """ + Represents Work Item Recent Activity :param activity_date: Date of the last Activity by the user :type activity_date: datetime @@ -1420,7 +1459,8 @@ def __init__(self, activity_date=None, activity_type=None, changed_date=None, id class AccountRecentActivityWorkItemModel2(AccountRecentActivityWorkItemModelBase): - """AccountRecentActivityWorkItemModel2. + """ + Represents Work Item Recent Activity :param activity_date: Date of the last Activity by the user :type activity_date: datetime @@ -1463,8 +1503,7 @@ def __init__(self, activity_date=None, activity_type=None, changed_date=None, id class ReportingWorkItemLinksBatch(StreamedBatch): - """ReportingWorkItemLinksBatch. - + """ """ _attribute_map = { @@ -1475,8 +1514,7 @@ def __init__(self): class ReportingWorkItemRevisionsBatch(StreamedBatch): - """ReportingWorkItemRevisionsBatch. - + """ """ _attribute_map = { @@ -1487,7 +1525,8 @@ def __init__(self): class WorkItemCommentVersionRef(WorkItemTrackingResourceReference): - """WorkItemCommentVersionRef. + """ + Represents the reference to a specific version of a comment on a Work Item. :param url: :type url: str @@ -1522,7 +1561,8 @@ def __init__(self, url=None, comment_id=None, created_in_revision=None, is_delet class WorkItemDelete(WorkItemDeleteReference): - """WorkItemDelete. + """ + Full deleted work item object. Includes the work item itself. :param code: The HTTP status code for work item operation in a batch request. :type code: int @@ -1565,7 +1605,8 @@ def __init__(self, code=None, deleted_by=None, deleted_date=None, id=None, messa class WorkItemTrackingResource(WorkItemTrackingResourceReference): - """WorkItemTrackingResource. + """ + Base class for WIT REST resources. :param url: :type url: str @@ -1584,7 +1625,8 @@ def __init__(self, url=None, _links=None): class WorkItemType(WorkItemTrackingResource): - """WorkItemType. + """ + Describes a work item type. :param url: :type url: str @@ -1646,7 +1688,8 @@ def __init__(self, url=None, _links=None, color=None, description=None, field_in class WorkItemTypeCategory(WorkItemTrackingResource): - """WorkItemTypeCategory. + """ + Describes a work item type category. :param url: :type url: str @@ -1680,7 +1723,8 @@ def __init__(self, url=None, _links=None, default_work_item_type=None, name=None class WorkItemTypeFieldInstance(WorkItemTypeFieldInstanceBase): - """WorkItemTypeFieldInstance. + """ + Field instance of a work item type. :param name: The friendly name of the field. :type name: str @@ -1718,7 +1762,8 @@ def __init__(self, name=None, reference_name=None, url=None, always_required=Non class WorkItemUpdate(WorkItemTrackingResource): - """WorkItemUpdate. + """ + Describes an update to a work item. :param url: :type url: str @@ -1764,7 +1809,8 @@ def __init__(self, url=None, _links=None, fields=None, id=None, relations=None, class Comment(WorkItemTrackingResource): - """Comment. + """ + Comment on a Work Item. :param url: :type url: str @@ -1834,7 +1880,8 @@ def __init__(self, url=None, _links=None, created_by=None, created_date=None, cr class CommentList(WorkItemTrackingResource): - """CommentList. + """ + Represents a list of work item comments. :param url: :type url: str @@ -1872,8 +1919,7 @@ def __init__(self, url=None, _links=None, comments=None, continuation_token=None class CommentMention(WorkItemTrackingResource): - """CommentMention. - + """ :param url: :type url: str :param _links: Link references to related REST resources. @@ -1906,7 +1952,8 @@ def __init__(self, url=None, _links=None, artifact_id=None, artifact_type=None, class CommentReaction(WorkItemTrackingResource): - """CommentReaction. + """ + Contains information about work item comment reaction for a particular reaction type. :param url: :type url: str @@ -1940,7 +1987,8 @@ def __init__(self, url=None, _links=None, comment_id=None, count=None, is_curren class CommentVersion(WorkItemTrackingResource): - """CommentVersion. + """ + Represents a specific version of a comment on a work item. :param url: :type url: str @@ -2002,7 +2050,8 @@ def __init__(self, url=None, _links=None, created_by=None, created_date=None, cr class FieldDependentRule(WorkItemTrackingResource): - """FieldDependentRule. + """ + Describes a list of dependent fields for a rule. :param url: :type url: str @@ -2024,7 +2073,8 @@ def __init__(self, url=None, _links=None, dependent_fields=None): class QueryHierarchyItem(WorkItemTrackingResource): - """QueryHierarchyItem. + """ + Represents an item in the work item query hierarchy. This can be either a query or a folder. :param url: :type url: str @@ -2142,7 +2192,8 @@ def __init__(self, url=None, _links=None, children=None, clauses=None, columns=N class WorkItem(WorkItemTrackingResource): - """WorkItem. + """ + Describes a work item. :param url: :type url: str @@ -2180,7 +2231,8 @@ def __init__(self, url=None, _links=None, comment_version_ref=None, fields=None, class WorkItemClassificationNode(WorkItemTrackingResource): - """WorkItemClassificationNode. + """ + Defines a classification node for work item tracking. :param url: :type url: str @@ -2230,7 +2282,8 @@ def __init__(self, url=None, _links=None, attributes=None, children=None, has_ch class WorkItemComment(WorkItemTrackingResource): - """WorkItemComment. + """ + Comment on Work Item :param url: :type url: str @@ -2264,7 +2317,8 @@ def __init__(self, url=None, _links=None, revised_by=None, revised_date=None, re class WorkItemComments(WorkItemTrackingResource): - """WorkItemComments. + """ + Collection of comments. :param url: :type url: str @@ -2298,7 +2352,8 @@ def __init__(self, url=None, _links=None, comments=None, count=None, from_revisi class WorkItemField(WorkItemTrackingResource): - """WorkItemField. + """ + Describes a field on a work item and it's properties specific to that work item type. :param url: :type url: str @@ -2368,8 +2423,7 @@ def __init__(self, url=None, _links=None, can_sort_by=None, description=None, is class WorkItemHistory(WorkItemTrackingResource): - """WorkItemHistory. - + """ :param url: :type url: str :param _links: Link references to related REST resources. @@ -2402,7 +2456,8 @@ def __init__(self, url=None, _links=None, rev=None, revised_by=None, revised_dat class WorkItemTemplateReference(WorkItemTrackingResource): - """WorkItemTemplateReference. + """ + Describes a shallow reference to a work item template. :param url: :type url: str @@ -2436,8 +2491,7 @@ def __init__(self, url=None, _links=None, description=None, id=None, name=None, class WorkItemTrackingReference(WorkItemTrackingResource): - """WorkItemTrackingReference. - + """ :param url: :type url: str :param _links: Link references to related REST resources. @@ -2462,7 +2516,8 @@ def __init__(self, url=None, _links=None, name=None, reference_name=None): class WorkItemRelationType(WorkItemTrackingReference): - """WorkItemRelationType. + """ + Represents the work item type relatiion type. :param url: :type url: str @@ -2490,7 +2545,8 @@ def __init__(self, url=None, _links=None, name=None, reference_name=None, attrib class WorkItemTemplate(WorkItemTemplateReference): - """WorkItemTemplate. + """ + Describes a work item template. :param url: :type url: str diff --git a/azure-devops/azure/devops/v5_1/work_item_tracking_process/models.py b/azure-devops/azure/devops/v5_1/work_item_tracking_process/models.py index f70eeb14..5aa140e6 100644 --- a/azure-devops/azure/devops/v5_1/work_item_tracking_process/models.py +++ b/azure-devops/azure/devops/v5_1/work_item_tracking_process/models.py @@ -10,7 +10,8 @@ class AddProcessWorkItemTypeFieldRequest(Model): - """AddProcessWorkItemTypeFieldRequest. + """ + Class that describes a request to add a field in a work item type. :param allow_groups: Allow setting field value to a group identity. Only applies to identity fields. :type allow_groups: bool @@ -42,7 +43,8 @@ def __init__(self, allow_groups=None, default_value=None, read_only=None, refere class Control(Model): - """Control. + """ + Represent a control in the form. :param contribution: Contribution for the control. :type contribution: :class:`WitContribution ` @@ -106,7 +108,8 @@ def __init__(self, contribution=None, control_type=None, height=None, id=None, i class CreateProcessModel(Model): - """CreateProcessModel. + """ + Describes a process being created. :param description: Description of the process :type description: str @@ -134,7 +137,8 @@ def __init__(self, description=None, name=None, parent_process_type_id=None, ref class CreateProcessRuleRequest(Model): - """CreateProcessRuleRequest. + """ + Request object/class for creating a rule on a work item type. :param actions: List of actions to take when the rule is triggered. :type actions: list of :class:`RuleAction ` @@ -162,7 +166,8 @@ def __init__(self, actions=None, conditions=None, is_disabled=None, name=None): class CreateProcessWorkItemTypeRequest(Model): - """CreateProcessWorkItemTypeRequest. + """ + Class for create work item type request :param color: Color hexadecimal code to represent the work item type :type color: str @@ -198,7 +203,8 @@ def __init__(self, color=None, description=None, icon=None, inherits_from=None, class Extension(Model): - """Extension. + """ + Represents the extensions part of the layout :param id: Id of the extension :type id: str @@ -214,8 +220,7 @@ def __init__(self, id=None): class FieldModel(Model): - """FieldModel. - + """ :param description: :type description: str :param id: @@ -250,8 +255,7 @@ def __init__(self, description=None, id=None, is_identity=None, name=None, type= class FieldRuleModel(Model): - """FieldRuleModel. - + """ :param actions: :type actions: list of :class:`RuleActionModel ` :param conditions: @@ -286,7 +290,8 @@ def __init__(self, actions=None, conditions=None, friendly_name=None, id=None, i class FormLayout(Model): - """FormLayout. + """ + Describes the layout of a work item type :param extensions: Gets and sets extensions list. :type extensions: list of :class:`Extension ` @@ -310,7 +315,8 @@ def __init__(self, extensions=None, pages=None, system_controls=None): class Group(Model): - """Group. + """ + Represent a group in the form that holds controls in it. :param contribution: Contribution for the group. :type contribution: :class:`WitContribution ` @@ -362,7 +368,8 @@ def __init__(self, contribution=None, controls=None, height=None, id=None, inher class HideStateModel(Model): - """HideStateModel. + """ + Class that describes the work item state is hidden. :param hidden: Returns 'true', if workitem state is hidden, 'false' otherwise. :type hidden: bool @@ -378,7 +385,8 @@ def __init__(self, hidden=None): class Page(Model): - """Page. + """ + Describes a page in the work item form layout :param contribution: Contribution for the page. :type contribution: :class:`WitContribution ` @@ -434,7 +442,8 @@ def __init__(self, contribution=None, id=None, inherited=None, is_contribution=N class PickListMetadata(Model): - """PickListMetadata. + """ + Metadata for picklist. :param id: ID of the picklist :type id: str @@ -466,7 +475,8 @@ def __init__(self, id=None, is_suggested=None, name=None, type=None, url=None): class ProcessBehavior(Model): - """ProcessBehavior. + """ + Process Behavior Model. :param color: Color. :type color: str @@ -514,7 +524,8 @@ def __init__(self, color=None, customization=None, description=None, fields=None class ProcessBehaviorCreateRequest(Model): - """ProcessBehaviorCreateRequest. + """ + Process Behavior Create Payload. :param color: Color. :type color: str @@ -542,7 +553,8 @@ def __init__(self, color=None, inherits=None, name=None, reference_name=None): class ProcessBehaviorField(Model): - """ProcessBehaviorField. + """ + Process Behavior Field. :param name: Name of the field. :type name: str @@ -566,7 +578,8 @@ def __init__(self, name=None, reference_name=None, url=None): class ProcessBehaviorReference(Model): - """ProcessBehaviorReference. + """ + Process behavior Reference. :param behavior_ref_name: Id of a Behavior. :type behavior_ref_name: str @@ -586,7 +599,8 @@ def __init__(self, behavior_ref_name=None, url=None): class ProcessBehaviorUpdateRequest(Model): - """ProcessBehaviorUpdateRequest. + """ + Process Behavior Replace Payload. :param color: Color. :type color: str @@ -606,7 +620,8 @@ def __init__(self, color=None, name=None): class ProcessInfo(Model): - """ProcessInfo. + """ + Process. :param customization_type: Indicates the type of customization on this process. System Process is default process. Inherited Process is modified process that was System process before. :type customization_type: object @@ -654,8 +669,7 @@ def __init__(self, customization_type=None, description=None, is_default=None, i class ProcessModel(Model): - """ProcessModel. - + """ :param description: Description of the process :type description: str :param name: Name of the process @@ -690,7 +704,8 @@ def __init__(self, description=None, name=None, projects=None, properties=None, class ProcessProperties(Model): - """ProcessProperties. + """ + Properties of the process. :param class_: Class of the process. :type class_: object @@ -722,7 +737,8 @@ def __init__(self, class_=None, is_default=None, is_enabled=None, parent_process class ProcessRule(CreateProcessRuleRequest): - """ProcessRule. + """ + Process Rule Response. :param actions: List of actions to take when the rule is triggered. :type actions: list of :class:`RuleAction ` @@ -758,7 +774,8 @@ def __init__(self, actions=None, conditions=None, is_disabled=None, name=None, c class ProcessWorkItemType(Model): - """ProcessWorkItemType. + """ + Class that describes a work item type object :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior ` @@ -818,7 +835,8 @@ def __init__(self, behaviors=None, color=None, customization=None, description=N class ProcessWorkItemTypeField(Model): - """ProcessWorkItemTypeField. + """ + Class that describes a field in a work item type and its properties. :param allow_groups: Allow setting field value to a group identity. Only applies to identity fields. :type allow_groups: bool @@ -870,7 +888,8 @@ def __init__(self, allow_groups=None, customization=None, default_value=None, de class ProjectReference(Model): - """ProjectReference. + """ + Defines the project reference class. :param description: Description of the project :type description: str @@ -898,7 +917,8 @@ def __init__(self, description=None, id=None, name=None, url=None): class RuleAction(Model): - """RuleAction. + """ + Action to take when the rule is triggered. :param action_type: Type of action to take when the rule is triggered. :type action_type: object @@ -922,7 +942,8 @@ def __init__(self, action_type=None, target_field=None, value=None): class RuleActionModel(Model): - """RuleActionModel. + """ + Action to take when the rule is triggered. :param action_type: :type action_type: str @@ -946,7 +967,8 @@ def __init__(self, action_type=None, target_field=None, value=None): class RuleCondition(Model): - """RuleCondition. + """ + Defines a condition on a field when the rule should be triggered. :param condition_type: Type of condition. $When. This condition limits the execution of its children to cases when another field has a particular value, i.e. when the Is value of the referenced field is equal to the given literal value. $WhenNot.This condition limits the execution of its children to cases when another field does not have a particular value, i.e.when the Is value of the referenced field is not equal to the given literal value. $WhenChanged.This condition limits the execution of its children to cases when another field has changed, i.e.when the Is value of the referenced field is not equal to the Was value of that field. $WhenNotChanged.This condition limits the execution of its children to cases when another field has not changed, i.e.when the Is value of the referenced field is equal to the Was value of that field. :type condition_type: object @@ -970,8 +992,7 @@ def __init__(self, condition_type=None, field=None, value=None): class RuleConditionModel(Model): - """RuleConditionModel. - + """ :param condition_type: :type condition_type: str :param field: @@ -994,7 +1015,8 @@ def __init__(self, condition_type=None, field=None, value=None): class Section(Model): - """Section. + """ + Defines a section of the work item form layout :param groups: List of child groups in this section :type groups: list of :class:`Group ` @@ -1018,7 +1040,8 @@ def __init__(self, groups=None, id=None, overridden=None): class UpdateProcessModel(Model): - """UpdateProcessModel. + """ + Describes a request to update a process :param description: New description of the process :type description: str @@ -1046,7 +1069,8 @@ def __init__(self, description=None, is_default=None, is_enabled=None, name=None class UpdateProcessRuleRequest(CreateProcessRuleRequest): - """UpdateProcessRuleRequest. + """ + Request class/object to update the rule. :param actions: List of actions to take when the rule is triggered. :type actions: list of :class:`RuleAction ` @@ -1074,7 +1098,8 @@ def __init__(self, actions=None, conditions=None, is_disabled=None, name=None, i class UpdateProcessWorkItemTypeFieldRequest(Model): - """UpdateProcessWorkItemTypeFieldRequest. + """ + Class to describe a request that updates a field's properties in a work item type. :param allow_groups: Allow setting field value to a group identity. Only applies to identity fields. :type allow_groups: bool @@ -1102,7 +1127,8 @@ def __init__(self, allow_groups=None, default_value=None, read_only=None, requir class UpdateProcessWorkItemTypeRequest(Model): - """UpdateProcessWorkItemTypeRequest. + """ + Class for update request on a work item type :param color: Color of the work item type :type color: str @@ -1130,7 +1156,8 @@ def __init__(self, color=None, description=None, icon=None, is_disabled=None): class WitContribution(Model): - """WitContribution. + """ + Properties of a work item form contribution :param contribution_id: The id for the contribution. :type contribution_id: str @@ -1158,8 +1185,7 @@ def __init__(self, contribution_id=None, height=None, inputs=None, show_on_delet class WorkItemBehavior(Model): - """WorkItemBehavior. - + """ :param abstract: :type abstract: bool :param color: @@ -1210,8 +1236,7 @@ def __init__(self, abstract=None, color=None, description=None, fields=None, id= class WorkItemBehaviorField(Model): - """WorkItemBehaviorField. - + """ :param behavior_field_id: :type behavior_field_id: str :param id: @@ -1234,7 +1259,8 @@ def __init__(self, behavior_field_id=None, id=None, url=None): class WorkItemBehaviorReference(Model): - """WorkItemBehaviorReference. + """ + Reference to the behavior of a work item type. :param id: The ID of the reference behavior. :type id: str @@ -1254,7 +1280,8 @@ def __init__(self, id=None, url=None): class WorkItemStateInputModel(Model): - """WorkItemStateInputModel. + """ + Class That represents a work item state input. :param color: Color of the state :type color: str @@ -1282,7 +1309,8 @@ def __init__(self, color=None, name=None, order=None, state_category=None): class WorkItemStateResultModel(Model): - """WorkItemStateResultModel. + """ + Class that represents a work item state result. :param color: Work item state color. :type color: str @@ -1326,7 +1354,8 @@ def __init__(self, color=None, customization_type=None, hidden=None, id=None, na class WorkItemTypeBehavior(Model): - """WorkItemTypeBehavior. + """ + Association between a work item type and it's behavior :param behavior: Reference to the behavior of a work item type :type behavior: :class:`WorkItemBehaviorReference ` @@ -1350,8 +1379,7 @@ def __init__(self, behavior=None, is_default=None, url=None): class WorkItemTypeModel(Model): - """WorkItemTypeModel. - + """ :param behaviors: :type behaviors: list of :class:`WorkItemTypeBehavior ` :param class_: @@ -1410,7 +1438,8 @@ def __init__(self, behaviors=None, class_=None, color=None, description=None, ic class PickList(PickListMetadata): - """PickList. + """ + Picklist. :param id: ID of the picklist :type id: str diff --git a/azure-devops/azure/devops/v5_1/work_item_tracking_process_template/models.py b/azure-devops/azure/devops/v5_1/work_item_tracking_process_template/models.py index aa39ae9c..f59bc802 100644 --- a/azure-devops/azure/devops/v5_1/work_item_tracking_process_template/models.py +++ b/azure-devops/azure/devops/v5_1/work_item_tracking_process_template/models.py @@ -10,7 +10,8 @@ class AdminBehavior(Model): - """AdminBehavior. + """ + Describes an admin behavior for a process. :param abstract: Is the behavior abstract (i.e. can not be associated with any work item type). :type abstract: bool @@ -62,7 +63,8 @@ def __init__(self, abstract=None, color=None, custom=None, description=None, fie class AdminBehaviorField(Model): - """AdminBehaviorField. + """ + Describes an admin behavior field. :param behavior_field_id: The behavior field identifier. :type behavior_field_id: str @@ -86,7 +88,8 @@ def __init__(self, behavior_field_id=None, id=None, name=None): class CheckTemplateExistenceResult(Model): - """CheckTemplateExistenceResult. + """ + Describes result of a check template existence request. :param does_template_exist: Indicates whether a template exists. :type does_template_exist: bool @@ -114,7 +117,8 @@ def __init__(self, does_template_exist=None, existing_template_name=None, existi class ProcessImportResult(Model): - """ProcessImportResult. + """ + Describes the result of a Process Import request. :param check_existence_result: Check template existence result. :type check_existence_result: :class:`CheckTemplateExistenceResult ` @@ -150,7 +154,8 @@ def __init__(self, check_existence_result=None, help_url=None, id=None, is_new=N class ProcessPromoteStatus(Model): - """ProcessPromoteStatus. + """ + Describes result of process operation promote. :param complete: Number of projects for which promote is complete. :type complete: int @@ -186,8 +191,7 @@ def __init__(self, complete=None, id=None, message=None, pending=None, remaining class ValidationIssue(Model): - """ValidationIssue. - + """ :param description: :type description: str :param file: