https://restsharp.dev/assets/js/9bf4401f.10776bef.js

1"use strict";(globalThis.webpackChunkdocs||=[]).push([[7673],{8395(e,s,r){r.r(s),r.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>t,toc:()=>h});const t=JSON.parse('{"id":"changelog","title":"What\'s new","description":"List of changes for the current major version","source":"@site/versioned_docs/version-v114/changelog.md","sourceDirName":".","slug":"/changelog","permalink":"/docs/changelog","draft":false,"unlisted":false,"editUrl":"https://github.com/RestSharp/RestSharp/tree/dev/docs/versioned_docs/version-v114/changelog.md","tags":[],"version":"v114","sidebarPosition":1,"frontMatter":{"title":"What\'s new","description":"List of changes for the current major version","sidebar_position":1},"sidebar":"tutorialSidebar","next":{"title":"Quick start","permalink":"/docs/intro"}}');var n=r(1987),i=r(7008);const a={title:"What's new",description:"List of changes for the current major version",sidebar_position:1},c="Changelog",l={},h=[{value:"v114.0",id:"v1140",level:2},{value:"Breaking changes",id:"breaking-changes",level:3},{value:"New features",id:"new-features",level:3},{value:"Behavior changes",id:"behavior-changes",level:3},{value:"Bug fixes",id:"bug-fixes",level:3}];function o(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"changelog",children:"Changelog"})}),"\n",(0,n.jsxs)(s.p,{children:["For release notes of previous versions, please check the ",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/releases",children:"Releases page"})," in RestSharp GitHub repository."]}),"\n",(0,n.jsx)(s.p,{children:"Changes between major versions are documented in the documentation for each version on this website."}),"\n",(0,n.jsx)(s.h2,{id:"v1140",children:"v114.0"}),"\n",(0,n.jsx)(s.h3,{id:"breaking-changes",children:"Breaking changes"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:[(0,n.jsx)(s.code,{children:"IAuthenticator"})," interface signature changed"]})," \u2014 ",(0,n.jsx)(s.code,{children:"Authenticate"})," now accepts an optional ",(0,n.jsx)(s.code,{children:"CancellationToken"})," parameter. All custom authenticator implementations must be recompiled. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2362",children:"#2362"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:[(0,n.jsx)(s.code,{children:"FollowRedirects"})," and ",(0,n.jsx)(s.code,{children:"MaxRedirects"})," removed from ",(0,n.jsx)(s.code,{children:"ReadOnlyRestClientOptions"})]})," \u2014 these properties are now excluded from the generated immutable wrapper. Use ",(0,n.jsx)(s.code,{children:"RedirectOptions"})," instead. Code accessing these properties on ",(0,n.jsx)(s.code,{children:"ReadOnlyRestClientOptions"})," must be updated. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2360",children:"#2360"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.strong,{children:"Extension method signatures changed"})," \u2014 ",(0,n.jsx)(s.code,{children:"AddParameter<T>"}),", ",(0,n.jsx)(s.code,{children:"AddOrUpdateParameter<T>"}),", ",(0,n.jsx)(s.code,{children:"AddHeader<T>"}),", ",(0,n.jsx)(s.code,{children:"AddOrUpdateHeader<T>"}),", ",(0,n.jsx)(s.code,{children:"AddQueryParameter<T>"}),", and ",(0,n.jsx)(s.code,{children:"AddUrlSegment<T>"})," now have an additional optional ",(0,n.jsx)(s.code,{children:"CultureInfo? culture"})," parameter. Assemblies compiled against v113 must be recompiled. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2354",children:"#2354"}),")"]}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"new-features",children:"New features"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.strong,{children:"OAuth2 token lifecycle authenticators"})," \u2014 new ",(0,n.jsx)(s.code,{children:"OAuth2ClientCredentialsAuthenticator"}),", ",(0,n.jsx)(s.code,{children:"OAuth2RefreshTokenAuthenticator"}),", and ",(0,n.jsx)(s.code,{children:"OAuth2TokenAuthenticator"})," that handle obtaining, caching, and refreshing tokens automatically. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2362",children:"#2362"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:["Custom redirect handling with ",(0,n.jsx)(s.code,{children:"RedirectOptions"})]})," \u2014 RestSharp now manages redirects internally instead of delegating to ",(0,n.jsx)(s.code,{children:"HttpClient"}),", fixing lost ",(0,n.jsx)(s.code,{children:"Set-Cookie"})," headers on redirects. New ",(0,n.jsx)(s.code,{children:"RedirectOptions"})," class provides fine-grained control over redirect behavior. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2360",children:"#2360"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:[(0,n.jsx)(s.code,{children:"MergedParameters"})," on ",(0,n.jsx)(s.code,{children:"RestResponse"})]})," \u2014 provides a combined view of request and default parameters at execution time, useful for logging and debugging. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2349",children:"#2349"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:["Restored ",(0,n.jsx)(s.code,{children:"AddCookie(name, value)"})," overload"]})," \u2014 the simple two-parameter form defers domain resolution to execution time. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2351",children:"#2351"}),")"]}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"behavior-changes",children:"Behavior changes"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:[(0,n.jsx)(s.code,{children:"MultipartFormQuoteParameters"})," now defaults to ",(0,n.jsx)(s.code,{children:"true"})]})," \u2014 multipart form parameter names are now quoted per RFC 7578. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2357",children:"#2357"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:[(0,n.jsx)(s.code,{children:"InvariantCulture"})," used for parameter formatting"]})," \u2014 all generic parameter methods now format values using ",(0,n.jsx)(s.code,{children:"CultureInfo.InvariantCulture"})," by default. Pass a ",(0,n.jsx)(s.code,{children:"CultureInfo"})," explicitly if locale-specific formatting is needed. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2354",children:"#2354"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:["Improved ",(0,n.jsx)(s.code,{children:"ErrorMessage"})," for timeouts"]})," \u2014 now shows ",(0,n.jsx)(s.code,{children:'"The request timed out."'})," instead of ",(0,n.jsx)(s.code,{children:'"A task was canceled."'}),". (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2356",children:"#2356"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:[(0,n.jsx)(s.code,{children:"ErrorMessage"})," surfaces root cause"]})," \u2014 uses ",(0,n.jsx)(s.code,{children:"GetBaseException().Message"})," to show the actual error instead of generic wrapper messages. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2352",children:"#2352"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsxs)(s.strong,{children:[(0,n.jsx)(s.code,{children:"HttpClient.DefaultRequestHeaders"})," no longer modified"]})," \u2014 ",(0,n.jsx)(s.code,{children:"Expect100Continue"})," is now set per-request. Safe to share an ",(0,n.jsx)(s.code,{children:"HttpClient"})," across multiple ",(0,n.jsx)(s.code,{children:"RestClient"})," instances. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2363",children:"#2363"}),")"]}),"\n"]}),"\n",(0,n.jsx)(s.h3,{id:"bug-fixes",children:"Bug fixes"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["Fix ",(0,n.jsx)(s.code,{children:"ConfigureAwait(false)"})," missing on several ",(0,n.jsx)(s.code,{children:"await"})," calls, preventing deadlocks in sync-over-async scenarios. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2367",children:"#2367"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:["Fix ",(0,n.jsx)(s.code,{children:"ResponseUri"})," returning original URL instead of redirect target when ",(0,n.jsx)(s.code,{children:"FollowRedirects=false"}),". (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2350",children:"#2350"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:["Fix default parameter merging bugs (multi-value dedup, request mutation, ",(0,n.jsx)(s.code,{children:"BuildUriString"})," without execute). (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2349",children:"#2349"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:["Fix OAuth1 double-encoding of RFC 3986 special characters in URL paths. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2341",children:"#2341"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:["Fix pipe character encoding when ",(0,n.jsx)(s.code,{children:"AddQueryParameter"})," is used with ",(0,n.jsx)(s.code,{children:"encode=false"}),". (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2345",children:"#2345"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:["Fix ",(0,n.jsx)(s.code,{children:"XmlDeserializer"})," when XML uses same tag name in nested elements. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2339",children:"#2339"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:["Fix credential/",(0,n.jsx)(s.code,{children:"UseDefaultCredentials"})," property order on ",(0,n.jsx)(s.code,{children:"HttpClientHandler"}),". (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2353",children:"#2353"}),")"]}),"\n",(0,n.jsxs)(s.li,{children:["Fix URL escaping on .NET Framework 4.6.2. (",(0,n.jsx)(s.a,{href:"https://github.com/restsharp/RestSharp/pull/2327",children:"#2327"}),")"]}),"\n"]})]})}function d(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},7008(e,s,r){r.d(s,{R:()=>a,x:()=>c});var t=r(1763);const n={},i=t.createContext(n);function a(e){const s=t.useContext(i);return t.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]);