1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
|
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
# Generated file, DO NOT EDIT
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------------------------
from msrest.serialization import Model
class GitRepository(Model):
"""
:param _links:
:type _links: :class:`ReferenceLinks <azure.devops.v5_1.microsoft._team_foundation._source_control._web_api.models.ReferenceLinks>`
:param default_branch:
:type default_branch: str
:param id:
:type id: str
:param is_fork: True if the repository was created as a fork
:type is_fork: bool
:param name:
:type name: str
:param parent_repository:
:type parent_repository: :class:`GitRepositoryRef <azure.devops.v5_1.microsoft._team_foundation._source_control._web_api.models.GitRepositoryRef>`
:param project:
:type project: :class:`TeamProjectReference <azure.devops.v5_1.microsoft._team_foundation._source_control._web_api.models.TeamProjectReference>`
:param remote_url:
:type remote_url: str
:param size: Compressed size (bytes) of the repository.
:type size: long
:param ssh_url:
:type ssh_url: str
:param url:
:type url: str
:param valid_remote_urls:
:type valid_remote_urls: list of str
:param web_url:
:type web_url: str
"""
_attribute_map = {
'_links': {'key': '_links', 'type': 'ReferenceLinks'},
'default_branch': {'key': 'defaultBranch', 'type': 'str'},
'id': {'key': 'id', 'type': 'str'},
'is_fork': {'key': 'isFork', 'type': 'bool'},
'name': {'key': 'name', 'type': 'str'},
'parent_repository': {'key': 'parentRepository', 'type': 'GitRepositoryRef'},
'project': {'key': 'project', 'type': 'TeamProjectReference'},
'remote_url': {'key': 'remoteUrl', 'type': 'str'},
'size': {'key': 'size', 'type': 'long'},
'ssh_url': {'key': 'sshUrl', 'type': 'str'},
'url': {'key': 'url', 'type': 'str'},
'valid_remote_urls': {'key': 'validRemoteUrls', 'type': '[str]'},
'web_url': {'key': 'webUrl', 'type': 'str'}
}
def __init__(self, _links=None, default_branch=None, id=None, is_fork=None, name=None, parent_repository=None, project=None, remote_url=None, size=None, ssh_url=None, url=None, valid_remote_urls=None, web_url=None):
super(GitRepository, self).__init__()
self._links = _links
self.default_branch = default_branch
self.id = id
self.is_fork = is_fork
self.name = name
self.parent_repository = parent_repository
self.project = project
self.remote_url = remote_url
self.size = size
self.ssh_url = ssh_url
self.url = url
self.valid_remote_urls = valid_remote_urls
self.web_url = web_url
class GitRepositoryRef(Model):
"""
:param collection: Team Project Collection where this Fork resides
:type collection: :class:`TeamProjectCollectionReference <azure.devops.v5_1.microsoft._team_foundation._source_control._web_api.models.TeamProjectCollectionReference>`
:param id:
:type id: str
:param is_fork: True if the repository was created as a fork
:type is_fork: bool
:param name:
:type name: str
:param project:
:type project: :class:`TeamProjectReference <azure.devops.v5_1.microsoft._team_foundation._source_control._web_api.models.TeamProjectReference>`
:param remote_url:
:type remote_url: str
:param ssh_url:
:type ssh_url: str
:param url:
:type url: str
"""
_attribute_map = {
'collection': {'key': 'collection', 'type': 'TeamProjectCollectionReference'},
'id': {'key': 'id', 'type': 'str'},
'is_fork': {'key': 'isFork', 'type': 'bool'},
'name': {'key': 'name', 'type': 'str'},
'project': {'key': 'project', 'type': 'TeamProjectReference'},
'remote_url': {'key': 'remoteUrl', 'type': 'str'},
'ssh_url': {'key': 'sshUrl', 'type': 'str'},
'url': {'key': 'url', 'type': 'str'}
}
def __init__(self, collection=None, id=None, is_fork=None, name=None, project=None, remote_url=None, ssh_url=None, url=None):
super(GitRepositoryRef, self).__init__()
self.collection = collection
self.id = id
self.is_fork = is_fork
self.name = name
self.project = project
self.remote_url = remote_url
self.ssh_url = ssh_url
self.url = url
class GitVersionDescriptor(Model):
"""
: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)
:type version_options: object
:param version_type: Version type (branch, tag, or commit). Determines how Id is interpreted
:type version_type: object
"""
_attribute_map = {
'version': {'key': 'version', 'type': 'str'},
'version_options': {'key': 'versionOptions', 'type': 'object'},
'version_type': {'key': 'versionType', 'type': 'object'}
}
def __init__(self, version=None, version_options=None, version_type=None):
super(GitVersionDescriptor, self).__init__()
self.version = version
self.version_options = version_options
self.version_type = version_type
class ReferenceLinks(Model):
"""
:param links:
:type links: dict
"""
_attribute_map = {
'links': {'key': 'links', 'type': '{object}'}
}
def __init__(self, links=None):
super(ReferenceLinks, self).__init__()
self.links = links
class TeamProjectCollectionReference(Model):
"""
:param id:
:type id: str
:param name:
:type name: str
:param url:
:type url: str
"""
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'url': {'key': 'url', 'type': 'str'}
}
def __init__(self, id=None, name=None, url=None):
super(TeamProjectCollectionReference, self).__init__()
self.id = id
self.name = name
self.url = url
class TeamProjectReference(Model):
"""
:param abbreviation:
:type abbreviation: str
:param default_team_image_url:
:type default_team_image_url: str
:param description:
:type description: str
:param id:
:type id: str
:param last_update_time:
:type last_update_time: datetime
:param name:
:type name: str
:param revision:
:type revision: long
:param state:
:type state: object
:param url:
:type url: str
:param visibility:
:type visibility: object
"""
_attribute_map = {
'abbreviation': {'key': 'abbreviation', 'type': 'str'},
'default_team_image_url': {'key': 'defaultTeamImageUrl', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
'id': {'key': 'id', 'type': 'str'},
'last_update_time': {'key': 'lastUpdateTime', 'type': 'iso-8601'},
'name': {'key': 'name', 'type': 'str'},
'revision': {'key': 'revision', 'type': 'long'},
'state': {'key': 'state', 'type': 'object'},
'url': {'key': 'url', 'type': 'str'},
'visibility': {'key': 'visibility', 'type': 'object'}
}
def __init__(self, abbreviation=None, default_team_image_url=None, description=None, id=None, last_update_time=None, name=None, revision=None, state=None, url=None, visibility=None):
super(TeamProjectReference, self).__init__()
self.abbreviation = abbreviation
self.default_team_image_url = default_team_image_url
self.description = description
self.id = id
self.last_update_time = last_update_time
self.name = name
self.revision = revision
self.state = state
self.url = url
self.visibility = visibility
class WikiAttachment(Model):
"""
Defines properties for wiki attachment file.
:param name: Name of the wiki attachment file.
:type name: str
:param path: Path of the wiki attachment file.
:type path: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'path': {'key': 'path', 'type': 'str'}
}
def __init__(self, name=None, path=None):
super(WikiAttachment, self).__init__()
self.name = name
self.path = path
class WikiAttachmentResponse(Model):
"""
Response contract for the Wiki Attachments API
:param attachment: Defines properties for wiki attachment file.
:type attachment: :class:`WikiAttachment <azure.devops.v5_1.wiki.models.WikiAttachment>`
:param eTag: Contains the list of ETag values from the response header of the attachments API call. The first item in the list contains the version of the wiki attachment.
:type eTag: list of str
"""
_attribute_map = {
'attachment': {'key': 'attachment', 'type': 'WikiAttachment'},
'eTag': {'key': 'eTag', 'type': '[str]'}
}
def __init__(self, attachment=None, eTag=None):
super(WikiAttachmentResponse, self).__init__()
self.attachment = attachment
self.eTag = eTag
class WikiCreateBaseParameters(Model):
"""
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
:param name: Wiki name.
:type name: str
:param project_id: ID of the project in which the wiki is to be created.
:type project_id: str
:param repository_id: ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
:type repository_id: str
:param type: Type of the wiki.
:type type: object
"""
_attribute_map = {
'mapped_path': {'key': 'mappedPath', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'project_id': {'key': 'projectId', 'type': 'str'},
'repository_id': {'key': 'repositoryId', 'type': 'str'},
'type': {'key': 'type', 'type': 'object'}
}
def __init__(self, mapped_path=None, name=None, project_id=None, repository_id=None, type=None):
super(WikiCreateBaseParameters, self).__init__()
self.mapped_path = mapped_path
self.name = name
self.project_id = project_id
self.repository_id = repository_id
self.type = type
class WikiCreateParametersV2(WikiCreateBaseParameters):
"""
Wiki creation parameters.
:param mapped_path: Folder path inside repository which is shown as Wiki. Not required for ProjectWiki type.
:type mapped_path: str
:param name: Wiki name.
:type name: str
:param project_id: ID of the project in which the wiki is to be created.
:type project_id: str
:param repository_id: ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
:type repository_id: str
:param type: Type of the wiki.
:type type: object
:param version: Version of the wiki. Not required for ProjectWiki type.
:type version: :class:`GitVersionDescriptor <azure.devops.v5_1.wiki.models.GitVersionDescriptor>`
"""
_attribute_map = {
'mapped_path': {'key': 'mappedPath', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'project_id': {'key': 'projectId', 'type': 'str'},
'repository_id': {'key': 'repositoryId', 'type': 'str'},
'type': {'key': 'type', 'type': 'object'},
'version': {'key': 'version', 'type': 'GitVersionDescriptor'}
}
def __init__(self, mapped_path=None, name=None, project_id=None, repository_id=None, type=None, version=None):
super(WikiCreateParametersV2, self).__init__(mapped_path=mapped_path, name=name, project_id=project_id, repository_id=repository_id, type=type)
self.version = version
class WikiPageCreateOrUpdateParameters(Model):
"""
Contract encapsulating parameters for the page create or update operations.
:param content: Content of the wiki page.
:type content: str
"""
_attribute_map = {
'content': {'key': 'content', 'type': 'str'}
}
def __init__(self, content=None):
super(WikiPageCreateOrUpdateParameters, self).__init__()
self.content = content
class WikiPageMoveParameters(Model):
"""
Contract encapsulating parameters for the page move operation.
:param new_order: New order of the wiki page.
:type new_order: int
:param new_path: New path of the wiki page.
:type new_path: str
:param path: Current path of the wiki page.
:type path: str
"""
_attribute_map = {
'new_order': {'key': 'newOrder', 'type': 'int'},
'new_path': {'key': 'newPath', 'type': 'str'},
'path': {'key': 'path', 'type': 'str'}
}
def __init__(self, new_order=None, new_path=None, path=None):
super(WikiPageMoveParameters, self).__init__()
self.new_order = new_order
self.new_path = new_path
self.path = path
class WikiPageMoveResponse(Model):
"""
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
:param page_move: Defines properties for wiki page move.
:type page_move: :class:`WikiPageMove <azure.devops.v5_1.wiki.models.WikiPageMove>`
"""
_attribute_map = {
'eTag': {'key': 'eTag', 'type': '[str]'},
'page_move': {'key': 'pageMove', 'type': 'WikiPageMove'}
}
def __init__(self, eTag=None, page_move=None):
super(WikiPageMoveResponse, self).__init__()
self.eTag = eTag
self.page_move = page_move
class WikiPageResponse(Model):
"""
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
:param page: Defines properties for wiki page.
:type page: :class:`WikiPage <azure.devops.v5_1.wiki.models.WikiPage>`
"""
_attribute_map = {
'eTag': {'key': 'eTag', 'type': '[str]'},
'page': {'key': 'page', 'type': 'WikiPage'}
}
def __init__(self, eTag=None, page=None):
super(WikiPageResponse, self).__init__()
self.eTag = eTag
self.page = page
class WikiPageViewStats(Model):
"""
Defines properties for wiki page view stats.
:param count: Wiki page view count.
:type count: int
:param last_viewed_time: Wiki page last viewed time.
:type last_viewed_time: datetime
:param path: Wiki page path.
:type path: str
"""
_attribute_map = {
'count': {'key': 'count', 'type': 'int'},
'last_viewed_time': {'key': 'lastViewedTime', 'type': 'iso-8601'},
'path': {'key': 'path', 'type': 'str'}
}
def __init__(self, count=None, last_viewed_time=None, path=None):
super(WikiPageViewStats, self).__init__()
self.count = count
self.last_viewed_time = last_viewed_time
self.path = path
class WikiUpdateParameters(Model):
"""
Wiki update parameters.
:param name: Name for wiki.
:type name: str
:param versions: Versions of the wiki.
:type versions: list of :class:`GitVersionDescriptor <azure.devops.v5_1.wiki.models.GitVersionDescriptor>`
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'versions': {'key': 'versions', 'type': '[GitVersionDescriptor]'}
}
def __init__(self, name=None, versions=None):
super(WikiUpdateParameters, self).__init__()
self.name = name
self.versions = versions
class WikiV2(WikiCreateBaseParameters):
"""
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
:param name: Wiki name.
:type name: str
:param project_id: ID of the project in which the wiki is to be created.
:type project_id: str
:param repository_id: ID of the git repository that backs up the wiki. Not required for ProjectWiki type.
:type repository_id: str
:param type: Type of the wiki.
:type type: object
:param id: ID of the wiki.
:type id: str
:param properties: Properties of the wiki.
:type properties: dict
:param remote_url: Remote web url to the wiki.
:type remote_url: str
:param url: REST url for this wiki.
:type url: str
:param versions: Versions of the wiki.
:type versions: list of :class:`GitVersionDescriptor <azure.devops.v5_1.wiki.models.GitVersionDescriptor>`
"""
_attribute_map = {
'mapped_path': {'key': 'mappedPath', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'project_id': {'key': 'projectId', 'type': 'str'},
'repository_id': {'key': 'repositoryId', 'type': 'str'},
'type': {'key': 'type', 'type': 'object'},
'id': {'key': 'id', 'type': 'str'},
'properties': {'key': 'properties', 'type': '{str}'},
'remote_url': {'key': 'remoteUrl', 'type': 'str'},
'url': {'key': 'url', 'type': 'str'},
'versions': {'key': 'versions', 'type': '[GitVersionDescriptor]'}
}
def __init__(self, mapped_path=None, name=None, project_id=None, repository_id=None, type=None, id=None, properties=None, remote_url=None, url=None, versions=None):
super(WikiV2, self).__init__(mapped_path=mapped_path, name=name, project_id=project_id, repository_id=repository_id, type=type)
self.id = id
self.properties = properties
self.remote_url = remote_url
self.url = url
self.versions = versions
class WikiPage(WikiPageCreateOrUpdateParameters):
"""
Defines a page in a wiki.
:param content: Content of the wiki page.
:type content: str
:param git_item_path: Path of the git item corresponding to the wiki page stored in the backing Git repository.
:type git_item_path: str
:param id: When present, permanent identifier for the wiki page
:type id: int
:param is_non_conformant: True if a page is non-conforming, i.e. 1) if the name doesn't match page naming standards. 2) if the page does not have a valid entry in the appropriate order file.
:type is_non_conformant: bool
:param is_parent_page: True if this page has subpages under its path.
:type is_parent_page: bool
:param order: Order of the wiki page, relative to other pages in the same hierarchy level.
:type order: int
:param path: Path of the wiki page.
:type path: str
:param remote_url: Remote web url to the wiki page.
:type remote_url: str
:param sub_pages: List of subpages of the current page.
:type sub_pages: list of :class:`WikiPage <azure.devops.v5_1.wiki.models.WikiPage>`
:param url: REST url for this wiki page.
:type url: str
"""
_attribute_map = {
'content': {'key': 'content', 'type': 'str'},
'git_item_path': {'key': 'gitItemPath', 'type': 'str'},
'id': {'key': 'id', 'type': 'int'},
'is_non_conformant': {'key': 'isNonConformant', 'type': 'bool'},
'is_parent_page': {'key': 'isParentPage', 'type': 'bool'},
'order': {'key': 'order', 'type': 'int'},
'path': {'key': 'path', 'type': 'str'},
'remote_url': {'key': 'remoteUrl', 'type': 'str'},
'sub_pages': {'key': 'subPages', 'type': '[WikiPage]'},
'url': {'key': 'url', 'type': 'str'}
}
def __init__(self, content=None, git_item_path=None, id=None, is_non_conformant=None, is_parent_page=None, order=None, path=None, remote_url=None, sub_pages=None, url=None):
super(WikiPage, self).__init__(content=content)
self.git_item_path = git_item_path
self.id = id
self.is_non_conformant = is_non_conformant
self.is_parent_page = is_parent_page
self.order = order
self.path = path
self.remote_url = remote_url
self.sub_pages = sub_pages
self.url = url
class WikiPageMove(WikiPageMoveParameters):
"""
Request contract for Wiki Page Move.
:param new_order: New order of the wiki page.
:type new_order: int
:param new_path: New path of the wiki page.
:type new_path: str
:param path: Current path of the wiki page.
:type path: str
:param page: Resultant page of this page move operation.
:type page: :class:`WikiPage <azure.devops.v5_1.wiki.models.WikiPage>`
"""
_attribute_map = {
'new_order': {'key': 'newOrder', 'type': 'int'},
'new_path': {'key': 'newPath', 'type': 'str'},
'path': {'key': 'path', 'type': 'str'},
'page': {'key': 'page', 'type': 'WikiPage'}
}
def __init__(self, new_order=None, new_path=None, path=None, page=None):
super(WikiPageMove, self).__init__(new_order=new_order, new_path=new_path, path=path)
self.page = page
__all__ = [
'GitRepository',
'GitRepositoryRef',
'GitVersionDescriptor',
'ReferenceLinks',
'TeamProjectCollectionReference',
'TeamProjectReference',
'WikiAttachment',
'WikiAttachmentResponse',
'WikiCreateBaseParameters',
'WikiCreateParametersV2',
'WikiPageCreateOrUpdateParameters',
'WikiPageMoveParameters',
'WikiPageMoveResponse',
'WikiPageResponse',
'WikiPageViewStats',
'WikiUpdateParameters',
'WikiV2',
'WikiPage',
'WikiPageMove',
]
|