CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.37.0

Fixed

• artifacts_download: use Url::path_segments_mut for URL construction to prevent path injection via user-controlled segments.
• artifacts_download: reject manifest entries containing .. path components to prevent path traversal.
• artifacts_download: normalize blob ID map keys to uppercase for consistent matching against locally-generated IDs.
• artifacts_download: batch-resolve all file root blob URLs in a single request instead of one per file.
• artifacts_download: cap deserialization error message previews at 512 bytes.
• artifacts_download: guard Vec::with_capacity against i64-to-usize overflow on 32-bit targets.
• artifacts_download: simplify nibble_pos type in decompressor (unused boolean removed).

Added

• All generated enum types now implement std::fmt::Display.

Dependencies

• Update azure_core and azure_identity to 0.35.

Changed

• Breaking: Query and path parameters that accept a fixed set of values are now typed as enums instead of impl Into<String>. This affects 105 parameters across all API areas. Examples:

  • git::items::list / git::items::get: recursion_level now takes models::VersionControlRecursionType (also applies to tfvc and wiki)
  • build::builds::list: status_filter takes models::BuildStatus, result_filter takes models::BuildResult, reason_filter takes models::BuildReason, query_order takes models::BuildQueryOrder
  • release: status_filter takes models::ReleaseStatus, query_order takes models::ReleaseQueryOrder, deployment_status takes models::DeploymentStatus
  • git::pull_requests::list: search_criteria_status takes models::PullRequestStatus
  • wit::work_items::get_work_item: expand takes models::WorkItemExpand

  The enum types are defined in each module's models and carry the same variant names as the API documentation (e.g. VersionControlRecursionType::Full, BuildStatus::InProgress).

0.36.0

Added

• New artifacts_download higher-level module for downloading Universal Packages from Azure DevOps Artifacts.
• Add example for downloading universal packages (artifacts_download).

Changes

• Update azure_core and azure_identity to 0.34.
• Improved README: added badges, quickstart guide, authentication section, feature table, MSRV, and updated links to learn.microsoft.com.

0.35.0

Changes

• Update azure_core and azure_identity to 0.33.

0.34.0

Changes

• Update azure_core and azure_identity to 0.32.

0.33.0

Changes

• Update azure_core and azure_identity to 0.30.
• Changes to handle API changes in azure_core:
  • Replace azure_core::http::BufResponse with azure_core::http::RawResponse / AsyncRawResponse
  • Change Response::into_body().await to Response::into_model() (now synchronous)
  • Update ClientOptions::retry field to be RetryOptions (no longer Option<RetryOptions>)
  • Add required PipelineSendOptions parameter to Pipeline::send()
  • Update transport() method to use Transport type (replaces TransportOptions)
  • Fix API_VERSION reference to use string literal "api-version" instead of non-existent query_param module
• Changes to handle API changes in manually written code:
  • Update auth.rs to remove deprecated ResultExt::context() method
  • Update date_time.rs to use direct error construction instead of with_context() closure
  • Update telemetry.rs to use AsyncRawResponse and new construction API

0.32.0

Changes

• Update azure_core and azure_identity to 0.28.
• Changes to handle API changes in azure_core:
  • Replace azure_core::http::RawResponse with azure_core::http::BufResponse
  • Add extra parameter when creating new azure_core::http::Pipeline
• Changes to handle API changes in azure_identity:
  • Updated examples to replace DefaultAzureCredential with AzureCliCredential

0.31.0

Changes

• Change AgentPoolQueue field to be optional:
  • name
• Change ProjectReference field to be optional:
  • name
• Change ServiceEndpointProjectReference fields to be optional:
  • description
  • name

0.30.1

Changes

• Change ServiceEndpoint field to be optional:
  • description
• Change AgentPoolQueue field to be optional:
  • pool

0.30.0

Changes

• Update azure_core, azure_identity to 0.27
• Clippy fixes for needless_lifetime warnings.

0.29.0

Breaking changes

• Update azure_core, azure_identity to 0.26
  • Some significant updates needed to handle changes to azure_core::http::Response
    • Response::into_raw_body() renamed Response::into_body()
    • Response::into_raw_response() now returns azure_core::http::RawResponse rather than azure_core::http::Response
    • Client::send() now returns azure_core::http::RawResponse rather than azure_core::http::Response
    • Fix up examples to work with response changes.
• Disable wasm32 CI build due to issues with getrandom

0.28.0

Changes

• Update azure_core, azure_identity to 0.24
• Fix formatting of date-time parameters
  • Reapplying a previous fix that was lost

0.27.0

Changes

• Update azure_core, azure_identity to 0.23
  • Update minimum rust-version to 1.80.0 (required by azure_core)

0.26.1

Changes

• Add missing completionOptions field to GitPullRequestUpdateOptions.

0.26.0

This is a significant change due to updating to the first offical releases of azure_core (0.22) and azure_identity (0.22). These crates have a number of breaking changes over previous versions.

Breaking changes

• Update azure_core, azure_identity to 0.22.

• ClientBuilder::per_retry_policies() renamed to per_try_policies() to align with azure_core API naming.

• Response::into_body() renamed to Response::into_raw_body() to align with azure_core API naming.

• Renamed crate features to align with azure_core:

  • enable_reqwest => reqwest
  • enable_reqwest_rustls => reqwest_rustls

• Notes on changes to azure_core API:

  • Response::into_body() is renamed Response::into_raw_body()

• Notes on changes to azure_identity API:

  • The credential creation functions now return values wrapped in Arc<_>, so you no longer need to do this in your client code.
    • Example: DefaultAzureCredential::new() previously returned Result<DefaultAzureCredential> but now returns a Result<Arc<DefaultAzureCredential>>.

0.25.0

Breaking change

• Change git 'Change::item' field to be optional.
  • Discovered that in some returned values this field is not present. Any code accessing this field now needs to wrap it in an Option, or deal with the returned value being wrapped in an Option.

Changes

• Clippy fixes for needless_lifetime warnings.

0.24.0

Breaking change

• Update azure_core, azure_identity to 0.21.

0.23.0

Breaking change

• Change IdentityRef id to be optional
  • Discovered that in some returned values this field is not present. Any code accessing this field now needs to wrap it in an Option, or deal with the returned value being wrapped in an Option.

0.22.0

Breaking change

• Change IdentityRef unique_name to be optional
  • Discovered that in some returned values this field is not present. Any code accessing this field now needs to wrap it in an Option, or deal with the returned value being wrapped in an Option.

Changes

• Update search_code example to demonstrate use of filters.

0.21.1

Changes

• Fix datetime model fields being serialized when empty, causing invalid JSON to be sent to ADO for some requests
• Fix clippy failure with empty doc comments.
• Cleanup vsts-api-patcher structure.

0.21.0

Changes

• Update autorust code generator to latest version from azure-sdk-for-rust.

0.20.1

Changes

• Add missing distributed_task submodules:
  • events
  • logs
  • oidctoken
  • records
• Add missing artifacts SBOM-related data structures.

0.20.0

Changes

• Update azure_core, azure_identity to 0.20.
  • Change example code util::get_credential return type from Credential to Result<Credential>, as DefaultAzureCredentialBuilder::build() is now fallible.
  • Reinstate wasm build in CI pipeline.
  • Fix telemetry code wasm build.
• Update vsts-rest-api-specs to latest version
  • Additional parameters in approvals_and_checks::ApprovalQueryParameters
    • approver_status
    • top
    • user_ids
  • Additional fields in build::PipelineGeneralSettings
    • builds_enabled_for_forks
    • enable_shell_tasks_args_sanitizing_audit
    • enforce_job_auth_scope_for_forks
    • enforce_no_access_to_secrets_from_forks
    • fork_protection_enabled
    • is_comment_required_for_pull_request
    • require_comments_for_non_team_member_and_non_contributors
    • require_comments_for_non_team_members_only
  • Additional field in build::PullRequestTrigger
    • pipeline_trigger_settings
  • Additional field in git::IdentityRefWithVote
    • is_reapprove

0.19.2

Changes

• Fix clippy failures
  • Implement Response methods into_raw_response() and as_raw_response for all operations, even if they do not return a value.
  • Replace deprecated time::Instant with std::time::Instant.

0.19.1

Changes

• Add new telemetry module with a request logger
• New example:
  • telemetry_git_repo_get

0.19.0

Breaking change

• Remove Option wrappers from git::models::ItemContent fields:
  • content
  • contentType

Changes

• New example:
  • git_push

0.18.0

Breaking change

• Change TeamProjectReference to make several fields optional, to allow projects to be created. Any existing code using the following fields will need to be changed to extract the value from the Option.
  • id
  • state
  • lastUpdateTime

0.17.0

Breaking change

• Change GitCommitRef to make commit_id optional.
  • Previously String, now Option<String>
  • Any existing code using commit_id will need to be changed to extract the value from the Option.

Changes

• Change definitions of GitChange and Change to reinstate some optional fields that were previously removed in the mistaken belief that they were unused.
  • GitChange:
    • change_id
    • new_content_template
    • original_path
  • Change:
    • new_content
    • source_server_item
    • url

0.16.0

Changes

• Upgrade azure_core, azure_identity to 0.19
• Change ADO_SCOPE definition to add /.default, as TokenCredential::get_token(...) has changed to take a scope rather than a resource

0.15.2

Changes

• Fix response type for git::items::get_items_batch()

Added

• New example: git_items_get_items_batch

0.15.1

Added

• New headers module with Azure DevOps custom rate-limiting response header definitions.

0.15.0

Changes

• Upgrade azure_core, azure_identity to 0.18
  • Note: AutoRefreshingTokenCredential is no longer required (and has been removed from azure_identity), as token refreshing is now built in to each credential provider

0.14.3

Added

• New value added to git ChangeType enum: edit, rename

0.14.2

Added

• New value added to git ChangeType enum: delete, sourceRename
• New examples:
  • git_repo_download_zip
  • build_source_providers_list
• Updated example: git_items_get now includes downloading entire repo as a zip archive

0.14.1

Added

• Enable configuration of per-retry policies on all client builders:
  • new ClientBuilder method: per_retry_policies(...)
• New example: work

0.14.0

Added

• New example: wit_wiql

Changes

• Upgrade azure_core, azure_identity to 0.17

0.13.0

Added

• Add support for WASM builds

0.12.0

Changes

• Upgrade azure_core, azure_identity to 0.16

0.11.0

Changes

• Upgrade azure_core, azure_identity to 0.15

0.10.0

Changes

• Update GitPullRequestUpdateOptions to add new field autoCompleteSetBy
• Update GitCommitRef to make commitId and url fields optional

0.9.0

Changes

• Upgrade azure_core, azure_identity to 0.14
• Update vsts-rest-api-specs to latest version
  • Picks up API and docs updates
  • Adds new modules:
    • approvals_and_checks
    • favorite
    • security_roles
  • Removes module:
    • clt

0.8.0

Fixed

• Added missing IntoFuture implementations for operations that return an empty response
• Upgrade azure_core, azure_identity to 0.13

0.7.7

Added

• New tokens module
• Upgrade azure_core, azure_identity to 0.12

0.7.6

Fixed

• Specify correct token scope for ADO by default
• Fixed multiple policy API issues

0.7.5

Fixed

• Fixed definition of git PolicyConfiguration
• Fixed pipeline Run required fields
  • Changed finishedDate and result to optional, as they are not present if run is in progress
• Change pipeline Repository fields to be optional: id, type

Added

• Upgrade azure_core, azure_identity to 0.11
• New examples:
  • member_entitlement_management
  • git_policy_config_list

0.7.4

Fixed

• Fixed definition of wit IdentityReference

Added

• New example: wit_work_item_queries
• New example: test_plan

0.7.3

Breaking change

• Wrapped WorkItemTrackingResource links in an Option

Fixed

• Updated dependencies:
  • azure_core to 0.10
  • azure_identity to 0.10

Added

• Renamed wit examples:
  • wit => wit_work_item_get
  • wit_create_work_item => wit_work_item_create
• Improved wit_work_item_get to display all work item relations
• Improved wit_work_item_get to demonstrate get_work_items_batch()

0.7.2

Fixed

• Fix creating and updating work items
  • New example: wit_create_work_item

0.7.1

Fixed

• Improved RequestBuilder documentation

0.7.0

Breaking change

• Implemented std::future::IntoFuture for request builder objects.
  • Removes need to call into_future() to finalize request builders. await will implicitly call the IntoFuture::into_future() method. This simplifies request calls.
  • IntoFuture support requires Rust 1.64.0 or higher, so this is now enforced by setting rust-version in Cargo.toml.

Added

• Examples: created new utils module with common authentication code.
  • Updated example authentication code to use AutoRefreshingTokenCredential and DefaultAzureCredentialBuilder.

Fixed

• Updated dependency versions.

0.6.2

Added

• New examples:

  • git_items_list
  • git_items_get
  • build_list_sync

• New features:

  • enable_reqwest [default]
  • enable_reqwest_rustls
  • Both of the above enable the corresponding feature in azure_core

0.6.1

Added

• New examples:
  • git_repo_get_raw_rsp
  • artifacts_list
  • build_list_continuation_token
  • release_logs
  • wiki_pages_create_or_update
  • search_repositories
  • permissions_report
• Added new fields to GitPullRequestCreateOptions
  • merge_options
  • completion_options

Fixed

• Fix distributedTask variableGroupProjectReferences deserialization of null value
• Fix extensionManagement parsing of flags fields
  • Change type from an enum to a String, as field value is a comma-separated list

0.6.0

Breaking changes

• Revert all GraphSubjectBase fields to be wrapped in Option
• Upgrade azure_core to 0.5, azure_identity to 0.6
  • AzureCliCredential must now be created via azure_identity::AzureCliCredential::new()

Fixed

• Upgrade autorust code generator
  • New send() function on operations that enables access to full response details (headers, raw body data)
• Add missing distributedTask ElasticPool operations
• Patch hooks spec:
  • InputValidation fields minValue and maxValue need to be number/float
  • Subscription field probationRetries needs to be integer/int32
• New examples:
  • code_search
  • hooks_list
  • ims_query
  • extension_management_list
  • test_rust_list

0.5.3

Fixed

• Fixed up GitCommitRef change_counts field type
• Added back some required build structure Option wrappers
• Fixed formatting of date-time URL parameters
• Added ims (Identity Management) example: ims_query
• Fixed Pull Request create function git::pull_requests::create()
• Added git_pr_create example

0.5.2

Fixed

• Implement custom date-time serde module to gracefully handle 0001-01-01T00:00:00
• Fixed response types for git::commits::get_changes()
• If response deserialization fails, include response content in error

0.5.1

Breaking changes

• Removed Option wrappers on selected structs in wit and status

Added

• Example improvements:
  • New examples:
    • wit (work items)
    • status
    • client_pipeline_policy
    • policy
  • Updated examples to use ClientBuilder, eliminating default client arguments
  • Added logging via env_logger
• Added Credential::Unauthenticated to enable unauthenticated operations

0.5.0

Breaking changes

• Upgraded to latest autorust code generator from azure-sdk-for-rust
  • Removed operation modules - all operations move up one level in the module hierarchy.
  • Second-level client functions changed to have a _client suffix, e.g.
    • client.repositories().get_repository(...) => client.repositories_client().get_repository(...).
  • New options(azure_core::ClientOptions) parameter required when creating clients, which allows the HTTP pipeline to be customised with middleware.
  • Fields declared in the spec as date-time format now parsed into Rust time::OffsetDateTime types rather than String.

0.4.0

Breaking change

• Updated some struct fields to remove Option wrappers to make the values easier to use.
• Updated some links fields to have a struct with known fields, rather than a Json Value.

Added

• pipeline_preview example

0.3.1

Added

• API documentation: autogenerate builder function descriptions.

Fixed

• Upgrade Azure SDK dependencies:
  • azure_core: 0.3
  • azure_identity: 0.4

0.3.0

Breaking change

• Move Credential definition from auth module to root, to separate it from all the feature modules. auth module is now private.
  • To migrate change use azure_devops_rust_api::auth::Credential to use azure_devops_rust_api::Credential

Added

• API documentation: autogenerate function description and parameter descriptions from fields in the OpenAPI spec.

0.2.0

Breaking change

• Credentials now need to be provided via a new type auth::Credential that supports both PAT and TokenCredential types. For more details see examples and docs.rs.

Added

• Support for PAT authentication

Fixed

• Remove use of unwrap() from examples.

0.1.3 - 2022-07-29

Fixed

• Remove --no-deps flag for docs.rs documentation generation.

0.1.2 - 2022-07-29

Fixed

• Set --no-deps flag for docs.rs documentation generation.

0.1.1 - 2022-07-29

Fixed

• Enable all-features flag for docs.rs documentation generation.

0.1.0 - 2022-07-29

• Initial release.